BrowserView

历史

版本(s)	更改
None	API DEPRECATED

注意

BrowserView 类已弃用，并被新的 WebContentsView 类取代。

BrowserView 可用于将额外的 Web 内容嵌入到 BrowserWindow 中。它类似于一个子窗口，但它是相对于其所有者窗口定位的。它旨在成为 webview 标签的替代品。

类：BrowserView

历史

版本(s)	更改
None	API DEPRECATED

创建和控制视图。

注意

BrowserView 类已弃用，并被新的 WebContentsView 类取代。

进程：主进程

在发出 app 模块的 ready 事件之前，此模块将无法使用。

警告

Electron 的内置类不能被用户代码继承。更多信息，请参阅常见问题解答。

示例

// In the main process.
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://electron.js.cn')
})

`new BrowserView([options])` 实验性已弃用

历史

版本(s)	更改
None	API DEPRECATED

options Object (可选)
- webPreferences WebPreferences (可选) - Web 页面的功能设置。
  - devTools boolean (可选) - 是否启用开发者工具。如果设置为 false，则无法使用 BrowserWindow.webContents.openDevTools() 打开开发者工具。默认为 true。
  - nodeIntegration boolean (可选) - 是否启用 Node 集成。默认为 false。
  - nodeIntegrationInWorker boolean (可选) - 是否在 Web Worker 中启用 Node 集成。默认为 false。有关更多信息，请参阅多线程。
  - nodeIntegrationInSubFrames boolean (可选) - 一个实验性选项，用于在子框架（如 iframe 和子窗口）中启用 Node.js 支持。您的所有预加载脚本都将为每个 iframe 加载，您可以使用 process.isMainFrame 来确定您是否在主框架中。
  - preload string (可选) - 指定一个脚本，该脚本将在其他脚本运行页面之前加载。无论节点集成是打开还是关闭，此脚本始终可以访问 node API。该值应为脚本的绝对文件路径。当节点集成关闭时，预加载脚本可以将 Node 全局符号重新引入全局作用域。请参阅此处的示例。
  - sandbox boolean (可选) - 如果设置为 true，则会沙盒化与窗口关联的渲染器，使其与 Chromium 操作系统级别的沙盒兼容并禁用 Node.js 引擎。这与 nodeIntegration 选项不同，并且预加载脚本可用的 API 更有限。自 Electron 20 起，默认值为 true。当 nodeIntegration 设置为 true 时，沙盒将自动禁用。在此处阅读有关此选项的更多信息。
  - session Session (可选) - 设置页面使用的会话。除了直接传递 Session 对象，您还可以选择使用 partition 选项，它接受一个分区字符串。当同时提供 session 和 partition 时，将优先使用 session。默认是默认会话。
  - partition string (可选) - 根据会话的分区字符串设置页面使用的会话。如果 partition 以 persist: 开头，则页面将使用该应用中具有相同 partition 的所有页面可用的持久会话。如果不存在 persist: 前缀，则页面将使用内存中的会话。通过分配相同的 partition，多个页面可以共享同一个会话。默认是默认会话。
  - zoomFactor number (可选) - 页面的默认缩放系数，3.0 表示 300%。默认为 1.0。
  - javascript boolean (可选) - 启用 JavaScript 支持。默认为 true。
  - webSecurity boolean (可选) - 当设置为 false 时，它将禁用同源策略（通常用于人们测试网站），并将 allowRunningInsecureContent 设置为 true（如果用户尚未设置此选项）。默认为 true。
  - allowRunningInsecureContent boolean (可选) - 允许 https 页面运行来自 http URL 的 JavaScript、CSS 或插件。默认为 false。
  - images boolean (可选) - 启用图像支持。默认为 true。
  - imageAnimationPolicy string (可选) - 指定如何运行图像动画（例如 GIF）。可以是 animate、animateOnce 或 noAnimation。默认为 animate。
  - textAreasAreResizable boolean (可选) - 使 TextArea 元素可调整大小。默认为 true。
  - webgl boolean (可选) - 启用 WebGL 支持。默认为 true。
  - plugins boolean (可选) - 是否启用插件。默认为 false。
  - experimentalFeatures boolean (可选) - 启用 Chromium 的实验性功能。默认为 false。
  - scrollBounce boolean (可选) macOS - 在 macOS 上启用滚动反弹（弹性）效果。默认为 false。
  - enableBlinkFeatures string (可选) - 以 , 分隔的功能字符串列表，例如 CSSVariables,KeyboardEventKey 以启用。支持的功能字符串的完整列表可在 RuntimeEnabledFeatures.json5 文件中找到。
  - disableBlinkFeatures string (可选) - 以 , 分隔的功能字符串列表，例如 CSSVariables,KeyboardEventKey 以禁用。支持的功能字符串的完整列表可在 RuntimeEnabledFeatures.json5 文件中找到。
  - defaultFontFamily Object (可选) - 设置 font-family 的默认字体。
    - standard string (可选) - 默认为 Times New Roman。
    - serif string (可选) - 默认为 Times New Roman。
    - sansSerif string (可选) - 默认为 Arial。
    - monospace string (可选) - 默认为 Courier New。
    - cursive string (可选) - 默认为 Script。
    - fantasy string (可选) - 默认为 Impact。
    - math string (可选) - 默认为 Latin Modern Math。
  - defaultFontSize Integer (可选) - 默认为 16。
  - defaultMonospaceFontSize Integer (可选) - 默认为 13。
  - minimumFontSize Integer (可选) - 默认为 0。
  - defaultEncoding string (可选) - 默认为 ISO-8859-1。
  - backgroundThrottling boolean (可选) - 当页面进入后台时是否限制动画和计时器。这也会影响页面可见性 API。当单个 browserWindow 中显示的至少一个 webContents 禁用了 backgroundThrottling 时，将为整个窗口绘制和交换帧，以及由它显示的 webContents。默认为 true。
  - offscreen Object | boolean (可选) - 是否为浏览器窗口启用离屏渲染。默认为 false。有关更多详细信息，请参阅离屏渲染教程。
    - useSharedTexture boolean (可选) 实验性 - 是否使用 GPU 共享纹理进行加速绘制事件。默认为 false。有关更多详细信息，请参阅离屏渲染教程。
    - sharedTexturePixelFormat string (可选) 实验性 - 请求的共享纹理的输出格式。默认为 argb。该名称源自 Chromium media::VideoPixelFormat 枚举后缀，并且仅支持其中一部分。实际输出像素格式和纹理的颜色空间应参考 paint 事件中的 OffscreenSharedTexture 对象。
      - argb - 请求的输出纹理格式为 8 位 unorm RGBA，具有 SRGB SDR 颜色空间。
      - rgbaf16 - 请求的输出纹理格式为 16 位浮点 RGBA，具有 scRGB HDR 颜色空间。
  - contextIsolation boolean (可选) - 是否在单独的 JavaScript 上下文中运行 Electron API 和指定的 preload 脚本。默认为 true。preload 脚本运行的上下文将只能访问其自己的专用 document 和 window 全局变量，以及它自己的 JavaScript 内置对象集合（Array、Object、JSON 等），这些对象对加载的内容都是不可见的。Electron API 只在 preload 脚本中可用，而不在加载的页面中可用。加载可能不受信任的远程内容时应使用此选项，以确保加载的内容无法篡改 preload 脚本和任何正在使用的 Electron API。此选项使用 Chrome Content Scripts 所使用的相同技术。您可以通过在控制台选项卡顶部的组合框中选择“Electron Isolated Context”条目，在开发者工具中访问此上下文。
  - webviewTag boolean (可选) - 是否启用 <webview> 标签。默认为 false。注意：为 <webview> 配置的预加载脚本在执行时将启用节点集成，因此您应确保远程/不受信任的内容无法创建带有潜在恶意预加载脚本的 <webview> 标签。您可以使用 <webContents> 上的 will-attach-webview 事件来剥离预加载脚本，并验证或修改 <webview> 的初始设置。
  - additionalArguments string[] (可选) - 将附加到此应用程序的渲染器进程的 process.argv 的字符串列表。用于将少量数据传递给渲染器进程 preload 脚本。
  - safeDialogs boolean (可选) - 是否启用浏览器风格的连续对话框保护。默认为 false。
  - safeDialogsMessage string (可选) - 触发连续对话框保护时显示的邮件。如果未定义，将使用默认邮件，请注意，当前默认邮件为英语且未本地化。
  - disableDialogs boolean (可选) - 是否完全禁用对话框。会覆盖 safeDialogs。默认为 false。
  - navigateOnDragDrop boolean (可选) - 将文件或链接拖放到页面上是否会导致导航。默认为 false。
  - autoplayPolicy string (可选) - 应用于窗口中内容的自动播放策略，可以是 no-user-gesture-required、user-gesture-required、document-user-activation-required。默认为 no-user-gesture-required。
  - disableHtmlFullscreenWindowResize boolean (可选) - 在进入 HTML 全屏时是否阻止窗口调整大小。默认为 false。
  - accessibleTitle string (可选) - 仅为辅助功能工具（如屏幕阅读器）提供的备用标题字符串。此字符串对用户不可见。
  - spellcheck boolean (可选) - 是否启用内置拼写检查器。默认为 true。
  - enableWebSQL boolean (可选) - 是否启用 WebSQL API。默认为 true。
  - v8CacheOptions string (可选) - 强制执行 blink 使用的 v8 代码缓存策略。可接受的值包括
    - none - 禁用代码缓存
    - code - 基于启发式代码缓存
    - bypassHeatCheck - 绕过代码缓存启发式但具有惰性编译
    - bypassHeatCheckAndEagerCompile - 与上面相同，除了编译是急切的。默认策略是 code。
  - enablePreferredSizeMode boolean (可选) - 是否启用首选尺寸模式。首选尺寸是容纳文档布局所需的最小尺寸，无需滚动。启用此选项将导致当首选尺寸发生变化时，在 WebContents 上发出 preferred-size-changed 事件。默认值为 false。
  - transparent boolean (可选) - 是否为子页面启用背景透明度。默认为 true。注意：子页面的文本和背景颜色源自其根元素的颜色方案。启用透明度时，文本颜色仍会相应更改，但背景将保持透明。
  - enableDeprecatedPaste boolean (可选) 已弃用 - 是否启用 paste execCommand。默认为 false。

实例属性

使用 new BrowserView 创建的对象具有以下属性

`view.webContents` 实验性已弃用

历史

版本(s)	更改
None	API DEPRECATED

此视图拥有的 WebContents 对象。

实例方法

使用 new BrowserView 创建的对象具有以下实例方法

`view.setAutoResize(options)` 实验性已弃用

历史

版本(s)	更改
None	API DEPRECATED
None	所有平台通用的标准化自动调整大小行为

options Object
- width boolean (可选) - 如果为 true，则视图的宽度将与窗口一起增长和缩小。默认为 false。
- height boolean (可选) - 如果为 true，则视图的高度将与窗口一起增长和缩小。默认为 false。
- horizontal boolean (可选) - 如果为 true，则视图的 x 位置和宽度将与窗口成比例地增长和缩小。默认为 false。
- vertical boolean (可选) - 如果为 true，则视图的 y 位置和高度将与窗口成比例地增长和缩小。默认为 false。

`view.setBounds(bounds)` 实验性已弃用

历史

版本(s)	更改
None	API DEPRECATED

bounds Rectangle

相对于窗口调整视图大小并将其移动到指定的边界。

`view.getBounds()` 实验性已弃用

历史

版本(s)	更改
None	API DEPRECATED

返回 Rectangle

此 BrowserView 实例的 bounds（边界）作为 Object。

`view.setBackgroundColor(color)` 实验性已弃用

历史

版本(s)	更改
None	API DEPRECATED

color string - 颜色格式为 Hex、RGB、ARGB、HSL、HSLA 或命名的 CSS 颜色。对于 Hex 类型，alpha 通道是可选的。

有效 color 值示例

Hex
- #fff (RGB)
- #ffff (ARGB)
- #ffffff (RRGGBB)
- #ffffffff (AARRGGBB)
RGB
- rgb\(([\d]+),\s*([\d]+),\s*([\d]+)\)
  - 例如 rgb(255, 255, 255)
RGBA
- rgba\(([\d]+),\s*([\d]+),\s*([\d]+),\s*([\d.]+)\)
  - 例如 rgba(255, 255, 255, 1.0)
HSL
- hsl\((-?[\d.]+),\s*([\d.]+)%,\s*([\d.]+)%\)
  - 例如 hsl(200, 20%, 50%)
HSLA
- hsla\((-?[\d.]+),\s*([\d.]+)%,\s*([\d.]+)%,\s*([\d.]+)\)
  - 例如 hsla(200, 20%, 50%, 0.5)
颜色名称
- 选项列在SkParseColor.cpp中
- 与 CSS Color Module Level 3 关键字类似，但区分大小写。
  - 例如：blueviolet 或 red

注意

带 alpha 的 Hex 格式采用 AARRGGBB 或 ARGB，不采用 RRGGBBAA 或 RGB。

类：BrowserView​

示例​

new BrowserView([options]) 实验性 已弃用​

实例属性​

view.webContents 实验性 已弃用​

实例方法​

view.setAutoResize(options) 实验性 已弃用​

view.setBounds(bounds) 实验性 已弃用​

view.getBounds() 实验性 已弃用​

view.setBackgroundColor(color) 实验性 已弃用​