跳转至

BaseWindowConstructorOptions 对象

  • width 整数(可选) - 窗口的宽度(像素)。默认值为 800。
  • height 整数(可选) - 窗口的高度(像素)。默认值为 600。
  • x 整数(可选) - (必填,如果使用了 y)窗口相对于屏幕的左侧偏移量。 默认值为将窗口居中。
  • y 整数(可选) - (必填,如果使用了 x)窗口相对于屏幕的顶部偏移量。 默认值为将窗口居中。
  • useContentSize 布尔值(可选) - width 和 height 将用作网页的大小,这意味着实际窗口大小将包含窗口边框的大小,并略大一些。默认值为 false。
  • center 布尔值(可选) - 在屏幕中央显示窗口。默认值为 false。
  • minWidth 整数(可选) - 窗口的最小宽度。默认值为 0。
  • minHeight 整数(可选) - 窗口的最小高度。默认值为 0。
  • maxWidth 整数(可选) - 窗口的最大宽度。默认值为无限制。
  • maxHeight 整数(可选) - 窗口的最大高度。默认值为无限制。
  • resizable 布尔值(可选) - 窗口是否可调整大小。默认值为 true。
  • movable 布尔值(可选) macOS Windows - 窗口是否可移动。在 Linux 上未实现。默认值为 true。
  • minimizable 布尔值(可选) macOS Windows - 窗口是否可最小化。在 Linux 上未实现。默认值为 true。
  • maximizable 布尔值(可选) macOS Windows - 窗口是否可最大化。在 Linux 上未实现。默认值为 true。
  • closable 布尔值(可选) macOS Windows - 窗口是否可关闭。在 Linux 上未实现。默认值为 true。
  • focusable 布尔值(可选) - 窗口是否可以聚焦。默认值为 true。在 Windows 上,设置 focusable: false 也意味着设置 skipTaskbar: true。在 Linux 上,设置 focusable: false 会使窗口 停止与 wm 交互,因此窗口将在所有工作区中始终置顶。
  • alwaysOnTop 布尔值(可选) - 窗口是否应始终位于其他窗口之上。 默认值为 false。不支持 Wayland(Linux)。
  • fullscreen 布尔值(可选) - 窗口是否应以全屏显示。当 显式设置为 false 时,macOS 上的全屏按钮将被隐藏或禁用。 默认值为 false。
  • fullscreenable 布尔值(可选) - 窗口是否可以进入全屏模式。在 macOS 上,还控制最大化/缩放按钮是切换全屏模式还是最大化窗口。默认值为 true。
  • simpleFullscreen 布尔值(可选) macOS - 在 macOS 上使用 Lion 之前的全屏模式。 默认值为 false。
  • skipTaskbar 布尔值(可选) macOS Windows - 是否在任务栏中显示窗口。 默认值为 false。
  • hiddenInMissionControl 布尔值(可选) macOS - 当用户切换到 Mission Control 时,是否应隐藏窗口。
  • kiosk 布尔值(可选) - 窗口是否处于 kiosk 模式。默认值为 false。
  • name 字符串(可选) - 窗口的唯一标识符,Electron 内部用于启用状态持久化等功能。每个窗口必须具有不同的名称。只有在相应窗口被销毁后,该名称才能被重新使用。如果名称已被使用,则会抛出错误。这不是显示在标题栏上供用户查看的可见标题。
  • windowStatePersistence (WindowStatePersistence | 布尔值)(可选) - 配置或启用窗口状态(位置、大小、最大化状态等)在应用重启之间的持久化。如果未提供窗口 name,则无效。当没有可用显示器时会自动禁用。实验性
  • title 字符串(可选) - 默认窗口标题。默认值为 "Electron"。如果 loadURL() 加载的 HTML 文件中定义了 HTML 标签 <title>,则此属性将被忽略。
  • icon (NativeImage | 字符串)(可选) - 窗口图标。在 Windows 上,建议使用 ICO 图标以获得最佳视觉效果;也可以将其保留为未定义,这样将使用可执行文件的图标。
  • show 布尔值(可选) - 创建时是否应显示窗口。默认值为 true。
  • frame 布尔值(可选) - 指定 false 以创建 无边框窗口。默认值为 true。
  • parent BaseWindow(可选) - 指定父窗口。默认值为 null。
  • modal 布尔值(可选) - 这是否为模态窗口。仅当窗口是子窗口时有效。默认值为 false。
  • acceptFirstMouse 布尔值(可选) macOS - 点击非活动窗口时是否也会点击穿透到网页内容。在 macOS 上默认值为 false。此选项在其他平台上不可配置。
  • disableAutoHideCursor 布尔值(可选) - 输入时是否隐藏光标。 默认值为 false。
  • autoHideMenuBar 布尔值(可选) Linux Windows - 自动隐藏菜单栏,除非按下 Alt 键。默认值为 false。
  • enableLargerThanScreen 布尔值(可选) macOS - 允许将窗口调整到比屏幕更大。仅与 macOS 相关,因为其他操作系统默认允许大于屏幕的窗口。默认值为 false。
  • backgroundColor 字符串(可选) - 窗口的背景颜色,格式为 Hex、RGB、RGBA、HSL、HSLA 或命名 CSS 颜色格式。如果 transparent 设置为 true,则支持 #AARRGGBB 格式的 Alpha 值。默认值为 #FFF(白色)。更多信息请参见 win.setBackgroundColor。
  • hasShadow 布尔值(可选) - 窗口是否应有阴影。默认值为 true。
  • opacity 数字(可选) macOS Windows - 设置窗口的初始不透明度,取值介于 0.0(完全透明)和 1.0(完全不透明)之间。 仅在 Windows 和 macOS 上实现。
  • darkTheme 布尔值(可选) - 强制窗口使用深色主题,仅在某些 GTK+3 桌面环境中有效。默认值为 false。
  • transparent 布尔值(可选) - 使窗口透明。 默认值为 false。在 Windows 上,除非窗口是无边框的,否则无效。 当你向 BaseWindow 添加 View 时,需要对该视图调用 view.setBackgroundColor 并设置透明背景颜色,以使其背景也透明。
  • type 字符串(可选) - 窗口类型,默认为普通窗口。有关此属性的更多信息,请参见下文。
  • visualEffectState 字符串(可选) macOS - 指定在 macOS 上材质外观应如何反映窗口活动状态。必须与 vibrancy 属性一起使用。可能的值有:
  • followWindow - 当窗口处于活动状态时,背景应自动显示为活动状态;当窗口不活动时,显示为非活动状态。这是默认值。
  • active - 背景应始终显示为活动状态。
  • inactive - 背景应始终显示为非活动状态。
  • titleBarStyle 字符串(可选) - 窗口标题栏的样式。 默认值为 default。可能的值有:
  • default - 在 macOS 或 Windows 上分别生成标准标题栏。
  • hidden - 生成隐藏标题栏和全尺寸内容窗口。在 macOS 上,窗口左上角仍保留标准窗口控件(“红绿灯”按钮)。在 Windows 和 Linux 上,与 titleBarOverlay: true 结合使用时,将启用 Window Controls Overlay(更多信息请参见 titleBarOverlay),否则不会显示任何窗口控件。
  • hiddenInset macOS - 生成隐藏标题栏,并采用另一种外观,红绿灯按钮略微更靠近窗口边缘内侧。
  • customButtonsOnHover macOS - 生成隐藏标题栏和全尺寸内容窗口,当鼠标悬停在窗口左上角时,红绿灯按钮会显示。 注意: 此选项目前为实验性。
  • titleBarOverlay 对象 | 布尔值(可选) - 在 macOS 上使用无边框窗口并结合 win.setWindowButtonVisibility(true),或使用使标准窗口控件(macOS 上的“红绿灯”按钮)可见的 titleBarStyle 时,此属性可启用 Window Controls Overlay JavaScript API 和 CSS 环境变量。指定 true 将生成具有默认系统颜色的覆盖层。默认值为 false。
  • color 字符串(可选) Windows Linux - 启用 Window Controls Overlay 时的 CSS 颜色。默认值为系统颜色。
  • symbolColor 字符串(可选) Windows Linux - 启用 Window Controls Overlay 时符号的 CSS 颜色。默认值为系统颜色。
  • height 整数(可选) - 标题栏和 Window Controls Overlay 的高度(像素)。默认值为系统高度。
  • accentColor 布尔值 | 字符串(可选) Windows - 窗口的强调色。默认情况下,遵循系统设置中的用户偏好。设置为 false 可显式禁用,或设置 Hex、RGB、RGBA、HSL、HSLA 或命名 CSS 颜色格式的颜色。Alpha 值将被忽略。
  • trafficLightPosition Point(可选) macOS - 为无边框窗口中的红绿灯按钮设置自定义位置。
  • roundedCorners 布尔值(可选) - 无边框窗口是否应有圆角。默认值为 true。在早于 Windows 11 Build 22000 的 Windows 版本上,此属性无效,无边框窗口将没有圆角。在 Linux 上,只有当桌面环境支持客户端装饰时,才会绘制圆角。
  • thickFrame 布尔值(可选) Windows - 在 Windows 上为无边框窗口使用 WS_THICKFRAME 样式,这会添加标准窗口边框。将其设置为 false 将移除窗口阴影和窗口动画,并禁用通过拖动窗口边缘调整窗口大小。默认值为 true。
  • vibrancy 字符串(可选) macOS - 为窗口添加一种 vibrancy 效果,仅在 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 类型创建类似程序坞的窗口行为。
  • toolbar 类型创建具有工具栏外观的窗口。
  • splash 类型具有特定行为。即使窗口 body 的 CSS 样式包含 -webkit-app-region: drag,它也不可拖动。此类型通常用于启动画面。
  • notification 类型创建行为类似系统通知的窗口。
  • 在 macOS 上,可能的类型为 desktop、textured、panel。
  • textured 类型添加金属渐变外观。此选项已弃用。
  • desktop 类型将窗口放置在桌面背景窗口层级 (kCGDesktopWindowLevel - 1)。请注意,桌面窗口不会接收 焦点、键盘或鼠标事件,但你仍可使用 globalShortcut 偶尔接收输入。
  • panel 类型通过在运行时添加通常保留给 NSPanel 的 NSWindowStyleMaskNonactivatingPanel 样式掩码,使窗口能够浮动在全屏应用之上。 此外,窗口将出现在所有空间(桌面)上。
  • 在 Windows 上,可能的类型为 toolbar。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 el/electron