跳到主要内容

BrowserWindowConstructorOptions 对象扩展了 BaseWindowConstructorOptions

  • webPreferences WebPreferences (可选) - 网页功能设置。
    • devTools boolean (可选) - 是否启用 DevTools。如果设置为 false，则不能使用 BrowserWindow.webContents.openDevTools() 打开 DevTools。默认值为 true。
    • nodeIntegration boolean (可选) - 是否启用 Node 集成。默认值为 false。
    • nodeIntegrationInWorker boolean (可选) - 是否在 Web Workers 中启用 Node 集成。默认值为 false。有关更多信息，请参阅 多线程。
    • nodeIntegrationInSubFrames boolean (可选) - 实验性选项，用于在子框架（例如 iframe 和子窗口）中启用 Node.js 支持。所有预加载脚本都将为每个 iframe 加载，可以使用 process.isMainFrame 确定是否处于主框架中。
    • preload string (可选) - 指定在页面中运行其他脚本之前加载的脚本。无论 Node 集成是否开启，此脚本都将始终可以访问 Node API。该值应为脚本的绝对文件路径。当 Node 集成关闭时，预加载脚本可以将 Node 全局符号重新引入全局范围。请参阅示例 此处。
    • sandbox boolean (可选) - 如果设置，这将对与窗口关联的渲染器进行沙箱处理，使其与 Chromium 操作系统级沙箱兼容并禁用 Node.js 引擎。这与 nodeIntegration 选项不同，预加载脚本可用的 API 更加有限。在此处详细了解该选项 此处。
    • 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 (可选) - 设置字体系列的默认字体。
      • 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 boolean (可选) - 是否为浏览器窗口启用离屏渲染。默认值为 false。有关更多详细信息，请参阅 离屏渲染教程。
    • contextIsolation boolean (可选) - 是否在单独的 JavaScript 上下文中运行 Electron API 和指定的 preload 脚本。默认值为 true。preload 脚本运行的上下文将只能访问其自己的专用 document 和 window 全局对象，以及其自己的 JavaScript 内置函数集（Array、Object、JSON 等），这些函数都对加载的内容不可见。Electron API 将仅在 preload 脚本中可用，而不在加载的页面中可用。当加载可能不受信任的远程内容时，应使用此选项以确保加载的内容无法篡改 preload 脚本和正在使用的任何 Electron API。此选项使用与 Chrome 内容脚本 相同的技术。可以通过在控制台选项卡顶部选择“Electron Isolated Context”条目在开发者工具中访问此上下文。
    • webviewTag 布尔值 (可选) - 是否启用 <webview> 标签。默认值为 false。注意： 为 <webview> 配置的 preload 脚本在执行时将启用节点集成，因此您应该确保远程/不受信任的内容无法创建带有可能存在恶意 preload 脚本的 <webview> 标签。您可以使用 webContents 上的 will-attach-webview 事件来移除 preload 脚本并验证或更改 <webview> 的初始设置。
    • additionalArguments 字符串数组 (可选) - 将追加到此应用程序渲染器进程中的 process.argv 的字符串列表。对于将少量数据传递到渲染器进程的 preload 脚本很有用。
    • safeDialogs 布尔值 (可选) - 是否启用浏览器样式的连续对话框保护。默认值为 false。
    • safeDialogsMessage 字符串 (可选) - 触发连续对话框保护时显示的消息。如果未定义，将使用默认消息，请注意，当前默认消息为英文，未本地化。
    • disableDialogs 布尔值 (可选) - 是否完全禁用对话框。覆盖 safeDialogs。默认值为 false。
    • navigateOnDragDrop 布尔值 (可选) - 是否将文件或链接拖放到页面上会导致导航。默认值为 false。
    • autoplayPolicy 字符串 (可选) - 应用于窗口中内容的自动播放策略，可以是 no-user-gesture-required、user-gesture-required、document-user-activation-required。默认值为 no-user-gesture-required。
    • disableHtmlFullscreenWindowResize 布尔值 (可选) - 是否阻止窗口在进入 HTML 全屏时调整大小。默认值为 false。
    • accessibleTitle 字符串 (可选) - 仅提供给辅助工具（如屏幕阅读器）的替代标题字符串。此字符串对用户不可见。
    • spellcheck 布尔值 (可选) - 是否启用内置拼写检查器。默认值为 true。
    • enableWebSQL 布尔值 (可选) - 是否启用 WebSQL API。默认值为 true。
    • v8CacheOptions 字符串 (可选) - 强制使用 blink 使用的 v8 代码缓存策略。接受的值为
      • none - 禁用代码缓存
      • code - 基于启发式的代码缓存
      • bypassHeatCheck - 绕过代码缓存启发式，但使用延迟编译
      • bypassHeatCheckAndEagerCompile - 与上面相同，只是编译是积极的。默认策略是 code。
    • enablePreferredSizeMode 布尔值 (可选) - 是否启用首选大小模式。首选大小是包含文档布局所需的最小大小，无需滚动。启用此选项会导致 WebContents 在首选大小发生变化时发出 preferred-size-changed 事件。默认值为 false。
    • transparent 布尔值 (可选) - 是否为访客页面启用背景透明度。默认值为 true。注意： 访客页面的文本和背景颜色来自其根元素的 颜色方案。启用透明度后，文本颜色将相应更改，但背景将保持透明。
  • paintWhenInitiallyHidden 布尔值 (可选) - 渲染器是否在 show 为 false 且刚创建时处于活动状态。为了使 document.visibilityState 在首次加载时使用 show: false 正常工作，您应该将其设置为 false。将其设置为 false 将导致 ready-to-show 事件不触发。默认值为 true。