Zum Hauptteil springen

BrowserView

History
Version(s)Changes
None
API DEPRECATED

Note The BrowserView class is deprecated, and replaced by the new WebContentsView class.

Eine Browseransicht kann verwendet werden, um zusätzliche Webinhalte in ein BrowserWindow einzubetten. Es ist wie ein untergeordnetes Fenster, mit der Ausnahme, dass es relativ zu dem übergeordneten Fenster positioniert ist. Es ist als Alternative zum Webview Tag gedacht.

Klasse: BrowserView​

History
Version(s)Changes
None
API DEPRECATED

Erstelle und kontrolliere Ansichten.

Note The BrowserView class is deprecated, and replaced by the new WebContentsView class.

Prozess: Haupt

This module cannot be used until the ready event of the app module is emitted.

Beispiel​

// Im Hauptprozess.
const { app, BrowserView, BrowserWindow } = require('electron')

app.whenReady().then(() => {
  const win = new BrowserWindow({ width: 800, height: 600 })

  const view = new BrowserView()
  win.setBrowserView(view)
  view.setBounds({ x: 0, y: 0, width: 300, height: 300 })
  view.webContents.loadURL('https://electronjs.org')
})

new BrowserView([options]) Experimental Deprecated​

History
Version(s)Changes
None
API DEPRECATED
  • options Object (optional)
    • webPreferences WebPreferences (optional) - Einstellungen der Webseiten-Funktionen.
      • devTools boolean (optional) - Gibt an ob die Entwicklerwerkzeuge aktiviert sind. Falls dies auf false gesetzt ist, kann BrowserWindow.webContents.openDevTools() nicht verwendet werden um die Entwicklerwerkzeuge zu öffnen. Standard ist true.
      • nodeIntegration boolean (optional) - Whether node integration is enabled. Standard ist false.
      • nodeIntegrationsInWorker boolean (optional) - Gibt an ob die Node Integration in Web Workern aktiviert ist. Standard ist false. Mehr dazu kann in Multithreading gefunden werden.
      • nodeIntegrationInSubFrames boolean (optional) - Experimental option for enabling Node.js support in sub-frames such as iframes and child windows. All your preloads will load for every iframe, you can use process.isMainFrame to determine if you are in the main frame or not.
      • preload string (optional) - Gibt ein Skript an das vor allen anderen Skripten geladen wird bevor andere Skripte der Seite ausgeführt werden. Dieses Skript hat immer Zugriff auf die Node APIs, unabhängig davon ob die Node Integration aktiviert ist oder nicht. Der Wert sollte der absolute Pfad zum Skript sein. Wenn die Node Integration ausgeschaltet ist, kann das Preload Skript globale Node Symbole in den Globalen Scope zurückbringen. Siehe dieses Beispiel.
      • sandbox boolean (optional) - Wenn gesetzt, wird der Renderer des Fensters in einer Sandbox ausgeführt, wodurch es kompatibel mit der Chromium Sandbox wird und die Node.js Integration deaktiviert wird. Dies ist nicht das gleiche wie nodeIntegration, da die APIs die dem Preload Skript zur Verfügung stehen stärker limitiert sind. Lesen sie hier mehr über diese Option.
      • session Session (optional) - Sets the session used by the page. Instead of passing the Session object directly, you can also choose to use the partition option instead, which accepts a partition string. When both session and partition are provided, session will be preferred. Default is the default session.
      • partition string (optional) - Sets the session used by the page according to the session's partition string. If partition starts with persist:, the page will use a persistent session available to all pages in the app with the same partition. If there is no persist: prefix, the page will use an in-memory session. By assigning the same partition, multiple pages can share the same session. Default is the default session.
      • zoomFactor number (optional) - The default zoom factor of the page, 3.0 represents 300%. Standard ist 1.0.
      • javascript boolean (optional) - Enables JavaScript support. Standard ist true.
      • webSecurity boolean (optional) - When false, it will disable the same-origin policy (usually using testing websites by people), and set allowRunningInsecureContent to true if this options has not been set by user. Standard ist true.
      • allowRunningInsecureContent boolean (optional) - Allow an https page to run JavaScript, CSS or plugins from http URLs. Standard ist false.
      • images boolean (optional) - Enables image support. Standard ist true.
      • imageAnimationPolicy string (optional) - Specifies how to run image animations (E.g. GIFs). Kann animate, animateOnce oder noAnimation sein. Standard ist animate.
      • textAreasAreResizable boolean (optional) - Make TextArea elements resizable. Standard ist true.
      • webgl boolean (optional) - Enables WebGL support. Standard ist true.
      • plugins boolean (optional) - Whether plugins should be enabled. Standard ist false.
      • experimentalFeatures boolean (optional) - Enables Chromium's experimental features. Standard ist false.
      • scrollBounce boolean (optional) macOS - Enables scroll bounce (rubber banding) effect on macOS. Standard ist false.
      • enableBlinkFeatures string (optional) - A list of feature strings separated by ,, like CSSVariables,KeyboardEventKey to enable. Die vollständige Liste der unterstützten Funktions-strings finden Sie in der RuntimeEnabledFeatures.json5 Datei.
      • disableBlinkFeatures string (optional) - A list of feature strings separated by ,, like CSSVariables,KeyboardEventKey to disable. Die vollständige Liste der unterstützten Funktions-strings finden Sie in der RuntimeEnabledFeatures.json5 Datei.
      • defaultFontFamily Object (optional) - Sets the default font for the font-family.
        • standard string (optional) - Defaults to Times New Roman.
        • serif string (optional) - Defaults to Times New Roman.
        • sansSerif string (optional) - Defaults to Arial.
        • monospace string (optional) - Defaults to Courier New.
        • cursive string (optional) - Defaults to Script.
        • fantasy string (optional) - Defaults to Impact.
        • math String (optional) - Standardmäßig auf Latin Modern Math.
      • defaultFontSize Integer (optional) - Standart ist 16.
      • defaultMonospaceFontSize Integer (optional) - Standart ist 13.
      • minimumFontSize Integer (optional) - Standart ist 0.
      • defaultEncoding string (optional) - Defaults to ISO-8859-1.
      • backgroundThrottling boolean (optional) - Whether to throttle animations and timers when the page becomes background. Dies wirkt sich auch auf die Page Visibility API aus. Wenn mindestens ein webContents in einem einzelnen browserWindow das backgroundThrottling deaktiviert hat angezeigt wird, dann werden Rahmen für das gesamte Fenster und andere webContents, die von diesem dargestellt werden, gezeichnet und ausgetauscht. Standardwert ist true.
      • offscreen Object | boolean (optional) - Whether to enable offscreen rendering for the browser window. Standardwert ist false. See the offscreen rendering tutorial for more details.
        • useSharedTexture boolean (optional) Experimental - Whether to use GPU shared texture for accelerated paint event. Standardwert ist false. See the offscreen rendering tutorial for more details.
      • contextIsolation boolean (optional) - Whether to run Electron APIs and the specified preload script in a separate JavaScript context. Defaults to true. The context that the preload script runs in will only have access to its own dedicated document and window globals, as well as its own set of JavaScript builtins (Array, Object, JSON, etc.), which are all invisible to the loaded content. The Electron API will only be available in the preload script and not the loaded page. This option should be used when loading potentially untrusted remote content to ensure the loaded content cannot tamper with the preload script and any Electron APIs being used. Diese Option verwendet die gleiche Technik, wie sie von Chrome Content Scripts verwendet wird. You can access this context in the dev tools by selecting the 'Electron Isolated Context' entry in the combo box at the top of the Console tab.
      • webviewTag boolean (optional) - Whether to enable the <webview> tag. Standardwert ist false. Note: The preload script configured for the <webview> will have node integration enabled when it is executed so you should ensure remote/untrusted content is not able to create a <webview> tag with a possibly malicious preload script. You can use the will-attach-webview event on webContents to strip away the preload script and to validate or alter the <webview>'s initial settings.
      • additionalArguments string[] (optional) - A list of strings that will be appended to process.argv in the renderer process of this app. Useful for passing small bits of data down to renderer process preload scripts.
      • safeDialogs boolean (optional) - Whether to enable browser style consecutive dialog protection. Standard ist false.
      • safeDialogsMessage string (optional) - The message to display when consecutive dialog protection is triggered. If not defined the default message would be used, note that currently the default message is in English and not localized.
      • disableDialogs boolean (optional) - Whether to disable dialogs completely. Overrides safeDialogs. Standard ist false.
      • navigateOnDragDrop boolean (optional) - Whether dragging and dropping a file or link onto the page causes a navigation. Standard ist false.
      • autoplayPolicy string (optional) - Autoplay policy to apply to content in the window, can be no-user-gesture-required, user-gesture-required, document-user-activation-required. Defaults to no-user-gesture-required.
      • disableHtmlFullscreenWindowResize boolean (optional) - Whether to prevent the window from resizing when entering HTML Fullscreen. Default is false.
      • accessibleTitle string (optional) - An alternative title string provided only to accessibility tools such as screen readers. This string is not directly visible to users.
      • spellcheck boolean (optional) - Whether to enable the builtin spellchecker. Standard ist true.
      • enableWebSQL boolean (optional) - Whether to enable the WebSQL api. Standard ist true.
      • v8CacheOptions string (optional) - Enforces the v8 code caching policy used by blink. Accepted values are
        • none - Disables code caching
        • code - Heuristic based code caching
        • bypassHeatCheck - Bypass code caching heuristics but with lazy compilation
        • bypassHeatCheckAndEagerCompile - Same as above except compilation is eager. Default policy is code.
      • enablePreferredSizeMode boolean (optional) - Whether to enable preferred size mode. The preferred size is the minimum size needed to contain the layout of the document—without requiring scrolling. Enabling this will cause the preferred-size-changed event to be emitted on the WebContents when the preferred size changes. Standard ist false.
      • transparent boolean (optional) - Gibt an, ob die Hintergrundtransparenz für die Gastseite aktiviert werden soll. Standard ist true. Hinweis: Die Text- und Hintergrundfarben der Gastseite werden aus dem Farbschema des Stammelements abgeleitet. Wenn die Transparenz aktiviert ist, ändert sich zwar die Textfarbe entsprechend, der Hintergrund bleibt jedoch transparent.

Instanz Eigenschaften​

Objekte, die mit new BrowserView erstellt wurden, haben folgende Eigenschaften:

view.webContents Experimental Deprecated​

History
Version(s)Changes
None
API DEPRECATED

A WebContents object owned by this view.

Beispiel Methoden​

Objekte, die mit new BrowserView erstellt wurden, haben folgende Instanzmethoden:

view.setAutoResize(options) Experimental Deprecated​

History
  • options Objekt
    • width boolean (optional) - Wenn true, wächst und schrumpft die Breite der Ansicht zusammen mit dem übergeordneten Fenster. Automatisch false.
    • height boolean (optional) - Wenn true, wächst und schrumpft die Höhe der Ansicht zusammen mit dem übergeordneten Fenster. Automatisch false.
    • horizontal boolean (optional) - Wenn true, ändert sich sowohl die X-Position als auch die Breite der Ansicht zusammen mit dem übergeordneten Fenster. Automatisch false.
    • vertical boolean (optional) - Wenn true, ändert sich sowohl die Y-Position als auch die Höhe der Ansicht zusammen mit dem übergeordneten Fenster. Automatisch false.

view.setBounds(bounds) Experimental Deprecated​

History
Version(s)Changes
None
API DEPRECATED
  • bounds Rectangle Die Grenzen der Ansicht als Rechteck

Passt die Ansicht an die Dimensionen und die Ausrichtung des Rechteckes relativ zum übergeordneten Fenster an.

view.getBounds() Experimental Deprecated​

History
Version(s)Changes
None
API DEPRECATED

Returns Rectangle

Die bounds dieser BrowserView-Instanz als Object.

view.setBackgroundColor(color) Experimental Deprecated​

History
Version(s)Changes
None
API DEPRECATED
  • color string - Farbe in Hex, RGB, ARGB, HSL, HSLA oder benannten CSS-Farbformat. Der Alphakanal ist optional für den Hex-Typ.

Beispiele für gültige color Werte:

  • Hex
    • #fff (RGB)
    • #ffff (ARGB)
    • #ffffff (RRGGBB)
    • #ffffffff (AARRGGBB)
  • RGB
    • rgb\(([\d]+),\s*([\d]+),\s*([\d]+)\)
      • e.g. rgb(255, 255, 255)
  • RGBA
    • rgba\(([\d]+),\s*([\d]+),\s*([\d]+),\s*([\d.]+)\)
      • e.g. rgba(255, 255, 255, 1.0)
  • HSL
    • hsl\((-?[\d.]+),\s*([\d.]+)%,\s*([\d.]+)%\)
      • e.g. hsl(200, 20%, 50%)
  • HSLA
    • hsla\((-?[\d.]+),\s*([\d.]+)%,\s*([\d.]+)%,\s*([\d.]+)\)
      • e.g. hsla(200, 20%, 50%, 0.5)
  • Farbname
    • Optionen sind in SkParseColor.cpp aufgelistet
    • Ähnlich wie CSS-Farbmodul Level 3 Keywords, aber Groß- und Kleinschreibung.
      • z.B. blueviolet oder red

Note: Hex format with alpha takes AARRGGBB or ARGB, not RRGGBBAA or RGB.