跳到主要内容

BaseWindowConstructorOptions 对象

  • width Integer (可选) - 窗口的宽度，单位为像素。默认为 800。
  • height Integer (可选) - 窗口的高度，单位为像素。默认为 600。
  • x Integer (可选) - (如果使用了 y，则为必填) 窗口左侧距屏幕的偏移量。默认为将窗口居中。
  • y Integer (可选) - (如果使用了 x，则为必填) 窗口顶部距屏幕的偏移量。默认为将窗口居中。
  • useContentSize boolean (可选) - width 和 height 将用作网页的大小，这意味着实际窗口的大小将包括窗口框架的大小，并且会稍微大一些。默认为 false。
  • center boolean (可选) - 将窗口显示在屏幕的中心。默认为 false。
  • minWidth Integer (可选) - 窗口的最小宽度。默认为 0。
  • minHeight Integer (可选) - 窗口的最小高度。默认为 0。
  • maxWidth Integer (可选) - 窗口的最大宽度。默认为无限制。
  • maxHeight Integer (可选) - 窗口的最大高度。默认为无限制。
  • resizable boolean (可选) - 窗口是否可调整大小。默认为 true。
  • movable boolean (可选) macOS Windows - 窗口是否可移动。这在 Linux 上未实现。默认为 true。
  • minimizable boolean (可选) macOS Windows - 窗口是否可最小化。这在 Linux 上未实现。默认为 true。
  • maximizable boolean (可选) macOS Windows - 窗口是否可最大化。这在 Linux 上未实现。默认为 true。
  • closable boolean (可选) macOS Windows - 窗口是否可关闭。这在 Linux 上未实现。默认为 true。
  • focusable boolean (可选) - 窗口是否可以获得焦点。默认为 true。在 Windows 上，设置 focusable: false 也意味着设置 skipTaskbar: true。在 Linux 上，设置 focusable: false 会使窗口停止与窗口管理器交互，因此窗口将始终保持在所有工作区的顶部。
  • alwaysOnTop boolean (可选) - 窗口是否应始终保持在其他窗口的顶部。默认为 false。
  • fullscreen boolean (可选) - 窗口是否应以全屏模式显示。当显式设置为 false 时，macOS 上的全屏按钮将被隐藏或禁用。默认为 false。
  • fullscreenable boolean (可选) - 窗口是否可以进入全屏模式。在 macOS 上，也指最大化/缩放按钮是否应切换全屏模式或最大化窗口。默认为 true。
  • simpleFullscreen boolean (可选) macOS - 在 macOS 上使用 Lion 之前的全屏模式。默认为 false。
  • skipTaskbar boolean (可选) macOS Windows - 是否在任务栏中显示窗口。默认为 false。
  • hiddenInMissionControl boolean (可选) macOS - 当用户切换到任务控制时，窗口是否应隐藏。
  • kiosk boolean (可选) - 窗口是否处于 kiosk 模式。默认为 false。
  • title string (可选) - 默认窗口标题。默认为 "Electron"。如果 HTML 文件中由 loadURL() 加载的 HTML 标签 <title> 已定义，则此属性将被忽略。
  • icon (NativeImage | string) (可选) - 窗口图标。在 Windows 上，建议使用 ICO 图标以获得最佳视觉效果，您也可以将其保留为未定义，以便使用可执行文件的图标。
  • show boolean (可选) - 是否在创建时显示窗口。默认为 true。
  • frame boolean (可选) - 指定 false 来创建无边框窗口。默认为 true。
  • parent BaseWindow (可选) - 指定父窗口。默认为 null。
  • modal boolean (可选) - 这是否为模态窗口。这仅在窗口为子窗口时才起作用。默认为 false。
  • acceptFirstMouse boolean (可选) macOS - 点击非活动窗口是否也会点击到 Web 内容。在 macOS 上，默认为 false。此选项在其他平台上不可配置。
  • disableAutoHideCursor boolean (可选) - 是否在键入时隐藏光标。默认为 false。
  • autoHideMenuBar boolean (可选) - 除非按下 Alt 键，否则自动隐藏菜单栏。默认为 false。
  • enableLargerThanScreen boolean (可选) macOS - 允许窗口调整大小大于屏幕。仅与 macOS 相关，因为其他操作系统默认允许大于屏幕的窗口。默认为 false。
  • backgroundColor string (可选) - 窗口的背景颜色，采用十六进制、RGB、RGBA、HSL、HSLA 或命名的 CSS 颜色格式。如果 transparent 设置为 true，则支持 #AARRGGBB 格式的 Alpha 通道。默认为 #FFF（白色）。有关更多信息，请参见 win.setBackgroundColor。
  • hasShadow boolean (可选) - 窗口是否应具有阴影。默认为 true。
  • opacity number (可选) macOS Windows - 设置窗口的初始不透明度，介于 0.0（完全透明）和 1.0（完全不透明）之间。这仅在 Windows 和 macOS 上实现。
  • darkTheme boolean (可选) - 强制窗口使用深色主题，仅在某些 GTK+3 桌面环境中有效。默认为 false。
  • transparent 布尔值 (可选) - 使窗口透明。默认值为 false。在 Windows 上，除非窗口是无边框的，否则此属性不起作用。
  • type 字符串 (可选) - 窗口的类型，默认值为普通窗口。详见下文。
  • visualEffectState 字符串 (可选) macOS - 指定在 macOS 上，材质外观应如何反映窗口活动状态。必须与 vibrancy 属性一起使用。可能的值为：
    • followWindow - 当窗口处于活动状态时，背景应自动显示为活动状态，当窗口处于非活动状态时，则显示为非活动状态。这是默认值。
    • active - 背景应始终显示为活动状态。
    • inactive - 背景应始终显示为非活动状态。
  • titleBarStyle 字符串 (可选) - 窗口标题栏的样式。默认值为 default。可能的值为：
    • default - 分别产生 macOS 或 Windows 的标准标题栏。
    • hidden - 产生隐藏的标题栏和全尺寸内容窗口。在 macOS 上，窗口的左上角仍然有标准的窗口控件（“交通灯”）。在 Windows 和 Linux 上，当与 titleBarOverlay: true 结合使用时，它将激活窗口控件覆盖 (请参阅 titleBarOverlay 以获取更多信息)，否则不会显示任何窗口控件。
    • hiddenInset macOS - 产生一个隐藏的标题栏，其外观略有不同，交通灯按钮从窗口边缘稍微向内缩进。
    • customButtonsOnHover macOS - 产生一个隐藏的标题栏和一个全尺寸的内容窗口，当鼠标悬停在窗口左上角时，将显示交通灯按钮。注意：此选项目前为实验性功能。
  • titleBarOverlay 对象 | 布尔值 (可选) - 在 macOS 上使用无边框窗口并结合 win.setWindowButtonVisibility(true) 或使用 titleBarStyle 以使标准窗口控件（macOS 上的“交通灯”）可见时，此属性启用窗口控件覆盖 JavaScript API 和 CSS 环境变量。指定 true 将产生带有默认系统颜色的覆盖。默认值为 false。
    • color 字符串 (可选) Windows Linux - 启用时，窗口控件覆盖的 CSS 颜色。默认值为系统颜色。
    • symbolColor 字符串 (可选) Windows - 启用时，窗口控件覆盖上符号的 CSS 颜色。默认值为系统颜色。
    • height 整数 (可选) - 标题栏和窗口控件覆盖的高度，以像素为单位。默认值为系统高度。
  • trafficLightPosition Point (可选) macOS - 在无边框窗口中设置交通灯按钮的自定义位置。
  • roundedCorners 布尔值 (可选) macOS - 在 macOS 上，无边框窗口是否应具有圆角。默认值为 true。将此属性设置为 false 将阻止窗口进入全屏模式。
  • thickFrame 布尔值 (可选) - 在 Windows 上，对无边框窗口使用 WS_THICKFRAME 样式，这会添加标准窗口框架。将其设置为 false 将删除窗口阴影和窗口动画。默认值为 true。
  • vibrancy 字符串 (可选) macOS - 仅在 macOS 上，为窗口添加一种活力效果。可以是 appearance-based, titlebar, selection, menu, popover, sidebar, header, sheet, window, hud, fullscreen-ui, tooltip, content, under-window, 或 under-page。
  • backgroundMaterial 字符串 (可选) Windows - 设置窗口的系统绘制的背景材质，包括非客户区后面的材质。可以是 auto, none, mica, acrylic 或 tabbed。有关更多信息，请参阅win.setBackgroundMaterial。
  • zoomToPageWidth 布尔值 (可选) macOS - 控制在 macOS 上，当在工具栏上按住 Option 键单击绿色停止灯按钮或单击 “窗口” > “缩放” 菜单项时的行为。如果为 true，则窗口将在缩放时增大到网页的首选宽度，如果为 false，则会缩放到屏幕的宽度。这也会影响直接调用 maximize() 时的行为。默认值为 false。
  • tabbingIdentifier 字符串 (可选) macOS - 选项卡组名称，允许将窗口作为本机选项卡打开。具有相同选项卡标识符的窗口将组合在一起。这也会在窗口的选项卡栏中添加一个本机的新选项卡按钮，并允许您的 app 和窗口接收 new-window-for-tab 事件。

当使用 minWidth/maxWidth/minHeight/maxHeight 设置最小或最大窗口大小时，它仅限制用户。它不会阻止您将不遵循大小约束的大小传递给 setBounds/setSize 或 BrowserWindow 的构造函数。

type 选项的可能值和行为取决于平台。可能的值为：

  • 在 Linux 上，可能的类型为 desktop、dock、toolbar、splash、notification。
    • desktop 类型将窗口放置在桌面背景窗口级别 (kCGDesktopWindowLevel - 1)。但是，请注意，桌面窗口不会接收焦点、键盘或鼠标事件。您仍然可以使用 globalShortcut 来偶尔接收输入。
    • dock 类型创建类似 Dock 的窗口行为。
    • toolbar 类型创建具有工具栏外观的窗口。
    • splash 类型的行为方式很特别。即使窗口主体的 CSS 样式包含 -webkit-app-region: drag，它也是不可拖动的。此类型通常用于启动画面。
    • notification 类型创建一个行为类似于系统通知的窗口。
  • 在 macOS 上，可能的类型为 desktop、textured、panel。
    • textured 类型添加金属渐变外观。此选项已弃用。
    • desktop 类型将窗口放置在桌面背景窗口级别 (kCGDesktopWindowLevel - 1)。请注意，桌面窗口不会接收焦点、键盘或鼠标事件，但您可以使用 globalShortcut 来偶尔接收输入。
    • panel 类型通过在运行时添加 NSWindowStyleMaskNonactivatingPanel 样式掩码（通常保留给 NSPanel）来使窗口浮动在全屏应用程序之上。此外，该窗口将出现在所有空间（桌面）上。
  • 在 Windows 上，可能的类型为 toolbar。