webFrame

自定义当前网页的渲染。

进程：渲染进程

Electron 模块的 webFrame 导出是一个 WebFrame 类的实例，表示当前帧。子帧可以通过某些属性和方法检索 (例如 webFrame.firstChild)。

将当前页面放大到 200% 的示例。

const { webFrame } = require('electron')

webFrame.setZoomFactor(2)

方法

WebFrame 类有以下实例方法

webFrame.setZoomFactor(factor)

• factor Double - 缩放系数；默认为 1.0。

将缩放系数更改为指定系数。缩放系数是缩放百分比除以 100，因此 300% = 3.0。

系数必须大于 0.0。

webFrame.getZoomFactor()

返回 number - 当前缩放系数。

webFrame.setZoomLevel(level)

• level number - 缩放级别。

将缩放级别更改为指定级别。原始大小为 0，每次向上或向下递增都表示分别将缩放大小比原始大小放大或缩小 20%，默认限制为原始大小的 300% 和 50%。

注意：Chromium 级别的缩放策略是同源的，这意味着特定域的缩放级别会传播到所有具有相同域的窗口实例中。区分窗口 URL 会使每个窗口的缩放独立工作。

webFrame.getZoomLevel()

返回 number - 当前缩放级别。

webFrame.setVisualZoomLevelLimits(minimumLevel, maximumLevel)

• minimumLevel number
• maximumLevel number

设置最小和最大双指缩放级别。

注意：Electron 默认禁用视觉缩放。要重新启用它，请调用

webFrame.setVisualZoomLevelLimits(1, 3)

注意：视觉缩放仅适用于双指缩放行为。Cmd+/-/0 缩放快捷键由应用程序菜单中的“zoomIn”、“zoomOut”和“resetZoom”MenuItem 角色控制。要禁用快捷键，请手动定义菜单并从定义中省略缩放角色。

webFrame.setSpellCheckProvider(language, provider)

• language string
• provider Object
  • spellCheck Function
    • words string[]
    • callback Function
      • misspeltWords string[]

为输入字段和文本区域中的拼写检查设置提供程序。

如果你想使用此方法，则必须在构造窗口时禁用内置拼写检查器。

const mainWindow = new BrowserWindow({
  webPreferences: {
    spellcheck: false
  }
})

provider 必须是一个具有 spellCheck 方法的对象，该方法接受一个单词数组用于拼写检查。spellCheck 函数异步运行，完成后调用 callback 函数并传入一个包含拼写错误单词的数组。

使用 node-spellchecker 作为提供程序的示例

const { webFrame } = require('electron')
const spellChecker = require('spellchecker')
webFrame.setSpellCheckProvider('en-US', {
  spellCheck (words, callback) {
    setTimeout(() => {
      const misspelled = words.filter(x => spellchecker.isMisspelled(x))
      callback(misspelled)
    }, 0)
  }
})

webFrame.insertCSS(css[, options])

• css string
• options Object (可选)
  • cssOrigin string (可选) - 可以是 'user' 或 'author'。设置插入样式表的级联来源。默认为 'author'。

返回 string - 插入 CSS 的键，之后可以使用该键通过 webFrame.removeInsertedCSS(key) 移除 CSS。

将 CSS 注入当前网页并返回插入样式表的唯一键。

webFrame.removeInsertedCSS(key)

• key string

从当前网页中移除插入的 CSS。样式表通过其键标识，该键由 webFrame.insertCSS(css) 返回。

webFrame.insertText(text)

• text string

将 text 插入到获得焦点的元素中。

webFrame.executeJavaScript(code[, userGesture, callback])

• code string
• userGesture boolean (可选) - 默认为 false。
• callback Function (可选) - 脚本执行后调用。除非帧暂停 (例如显示模态 alert)，否则执行将是同步的，并且在方法返回之前调用回调。为了与此方法的旧版本兼容，错误参数是第二个。
  • result Any
  • error Error

返回 Promise<any> - 一个 Promise，它解析为执行代码的结果，如果执行抛出错误或导致拒绝的 Promise，则会被拒绝。

在页面中评估 code。

在浏览器窗口中，某些 HTML API (例如 requestFullScreen) 只能通过用户的姿势触发。将 userGesture 设置为 true 将移除此限制。

webFrame.executeJavaScriptInIsolatedWorld(worldId, scripts[, userGesture, callback])

• worldId Integer - 运行 JavaScript 的世界 ID，0 是默认主世界 (内容在此运行)，999 是 Electron 的 contextIsolation 特性使用的世界。接受范围在 1..536870911 的值。
• scripts WebSource[]
• userGesture boolean (可选) - 默认为 false。
• callback Function (可选) - 脚本执行后调用。除非帧暂停 (例如显示模态 alert)，否则执行将是同步的，并且在方法返回之前调用回调。为了与此方法的旧版本兼容，错误参数是第二个。
  • result Any
  • error Error

返回 Promise<any> - 一个 Promise，解析为执行代码的结果，如果执行无法开始则被拒绝。

功能类似于 executeJavaScript，但在隔离的上下文中评估 scripts。

请注意，当脚本执行失败时，返回的 Promise 不会拒绝，result 将是 undefined。这是因为 Chromium 不会将隔离世界的错误分派到外部世界。

webFrame.setIsolatedWorldInfo(worldId, info)

• worldId Integer - 运行 JavaScript 的世界 ID，0 是默认世界，999 是 Electron 的 contextIsolation 特性使用的世界。Chrome 扩展程序保留的 ID 范围是 [1 << 20, 1 << 29)。您可以在此处提供任何整数。
• info Object
  • securityOrigin string (可选) - 隔离世界的安全来源。
  • csp string (可选) - 隔离世界的内容安全策略。
  • name string (可选) - 隔离世界的名称。在开发者工具中很有用。

设置隔离世界的安全来源、内容安全策略和名称。注意：如果指定了 csp，则 securityOrigin 也必须指定。

webFrame.getResourceUsage()

返回 Object

• images MemoryUsageDetails
• scripts MemoryUsageDetails
• cssStyleSheets MemoryUsageDetails
• xslStyleSheets MemoryUsageDetails
• fonts MemoryUsageDetails
• other MemoryUsageDetails

返回一个对象，描述 Blink 内部内存缓存的使用信息。

const { webFrame } = require('electron')
console.log(webFrame.getResourceUsage())

这将生成

{
  images: {
    count: 22,
    size: 2549,
    liveSize: 2542
  },
  cssStyleSheets: { /* same with "images" */ },
  xslStyleSheets: { /* same with "images" */ },
  fonts: { /* same with "images" */ },
  other: { /* same with "images" */ }
}

webFrame.clearCache()

尝试释放不再使用的内存 (例如之前导航中的图像)。

请注意，盲目调用此方法可能会使 Electron 变慢，因为它必须重新填充这些清空的缓存，仅当您的应用中发生了使您认为页面实际使用了较少内存的事件时 (例如，您从一个非常占用内存的页面导航到一个几乎为空的页面，并打算停留在那里) 才应调用它。

webFrame.getFrameForSelector(selector)

• selector string - 帧元素的 CSS 选择器。

返回 WebFrame - webFrame 文档中由 selector 选择的帧元素，如果 selector 未选择帧或帧不在当前渲染进程中，则返回 null。

webFrame.findFrameByName(name)

• name string

返回 WebFrame - webFrame 的子帧，其具有提供的 name，如果不存在这样的帧或帧不在当前渲染进程中，则返回 null。

webFrame.findFrameByRoutingId(routingId)

• routingId Integer - 一个 Integer，表示当前渲染进程中唯一的帧 ID。路由 ID 可以从 WebFrame 实例 (webFrame.routingId) 获取，并且也由特定于帧的 WebContents 导航事件 (例如 did-frame-navigate) 传递

返回 WebFrame - 具有提供的 routingId，如果未找到则返回 null。

webFrame.isWordMisspelled(word)

• word string - 要进行拼写检查的单词。

返回 boolean - 如果根据内置拼写检查器该单词拼写错误则返回 true，否则返回 false。如果没有加载字典，始终返回 false。

webFrame.getWordSuggestions(word)

• word string - 拼写错误的单词。

返回 string[] - 给定单词的建议单词列表。如果单词拼写正确，结果将为空。

属性

webFrame.top 只读

一个 WebFrame | null，表示 webFrame 所属帧层次结构中的顶层帧，如果顶层帧不在当前渲染进程中，则该属性为 null。

webFrame.opener 只读

一个 WebFrame | null，表示打开 webFrame 的帧，如果没有打开者或打开者不在当前渲染进程中，则该属性为 null。

webFrame.parent 只读

一个 WebFrame | null，表示 webFrame 的父帧，如果 webFrame 是顶层帧或父帧不在当前渲染进程中，则该属性为 null。

webFrame.firstChild 只读

一个 WebFrame | null，表示 webFrame 的第一个子帧，如果 webFrame 没有子帧或第一个子帧不在当前渲染进程中，则该属性为 null。

webFrame.nextSibling 只读

一个 WebFrame | null，表示下一个兄弟帧，如果 webFrame 是其父帧中的最后一个帧或下一个兄弟帧不在当前渲染进程中，则该属性为 null。

webFrame.routingId 只读

一个 Integer，表示当前渲染进程中唯一的帧 ID。引用同一底层帧的不同 WebFrame 实例将具有相同的 routingId。