跳到主要内容

BaseWindow

创建和控制窗口。

进程:主进程

注意 BaseWindow 提供了一种灵活的方式,可以在单个窗口中组合多个 Web 视图。 对于只有一个全尺寸 Web 视图的窗口, BrowserWindow 类可能是一个更简单的选择。

只有当 app 模块的 ready 事件被触发后,才能使用此模块。

// In the main process.
const { BaseWindow, WebContentsView } = require('electron')

const win = new BaseWindow({ width: 800, height: 600 })

const leftView = new WebContentsView()
leftView.webContents.loadURL('https://electron.js.cn')
win.contentView.addChildView(leftView)

const rightView = new WebContentsView()
rightView.webContents.loadURL('https://github.com/electron/electron')
win.contentView.addChildView(rightView)

leftView.setBounds({ x: 0, y: 0, width: 400, height: 600 })
rightView.setBounds({ x: 400, y: 0, width: 400, height: 600 })

父窗口和子窗口

通过使用 parent 选项,您可以创建子窗口

const { BaseWindow } = require('electron')

const parent = new BaseWindow()
const child = new BaseWindow({ parent })

child 窗口将始终显示在 parent 窗口之上。

模态窗口是一个禁用父窗口的子窗口。要创建模态窗口,必须同时设置 parentmodal 选项

const { BaseWindow } = require('electron')

const parent = new BaseWindow()
const child = new BaseWindow({ parent, modal: true })

平台注意事项

  • 在 macOS 上,模态窗口将显示为附加到父窗口的面板。
  • 在 macOS 上,当父窗口移动时,子窗口将保持相对于父窗口的相对位置,而在 Windows 和 Linux 上,子窗口不会移动。
  • 在 Linux 上,模态窗口的类型将更改为 dialog
  • 在 Linux 上,许多桌面环境不支持隐藏模态窗口。

资源管理

当你将 WebContentsView 添加到 BaseWindow 并且 BaseWindow 关闭时, WebContentsViewwebContents 不会自动销毁。

您有责任在不再需要 webContents 时将其关闭,例如,当 BaseWindow 关闭时

const { BaseWindow, WebContentsView } = require('electron')

const win = new BaseWindow({ width: 800, height: 600 })

const view = new WebContentsView()
win.contentView.addChildView(view)

win.on('closed', () => {
view.webContents.close()
})

BrowserWindow 不同,如果您不显式关闭 webContents,您将遇到内存泄漏。

类:BaseWindow

创建和控制窗口。

进程:主进程

BaseWindow 是一个 EventEmitter

它使用 options 设置的本机属性创建一个新的 BaseWindow

new BaseWindow([options])

  • options BaseWindowConstructorOptions (可选)
    • width Integer (可选) - 窗口的宽度(以像素为单位)。默认值为 800
    • height Integer (可选) - 窗口的高度(以像素为单位)。默认值为 600
    • x Integer (可选) - (如果使用了 y,则为必需) 窗口左侧相对于屏幕的偏移量。 默认值为将窗口居中。
    • y Integer (可选) - (如果使用了 x,则为必需) 窗口顶部相对于屏幕的偏移量。 默认值为将窗口居中。
    • useContentSize boolean (可选) - widthheight 将用作网页的大小,这意味着实际窗口的大小将包括窗口框架的大小,并且会略大。默认值为 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 上使用 Pre-Lion 全屏模式。默认值为 false
    • skipTaskbar boolean (可选) macOS Windows - 是否在任务栏中显示窗口。默认值为 false
    • hiddenInMissionControl boolean (可选) macOS - 当用户切换到 Mission Control 时,窗口是否应该隐藏。
    • kiosk boolean (可选) - 窗口是否处于 kiosk 模式。默认值为 false
    • title string (可选) - 默认窗口标题。默认值为 "Electron"。如果在 loadURL() 加载的 HTML 文件中定义了 HTML 标签 <title> ,则将忽略此属性。
    • icon (NativeImage | string) (可选) - 窗口图标。在 Windows 上,建议使用 ICO 图标以获得最佳视觉效果,您也可以将其保留为未定义,以便使用可执行文件的图标。
    • show boolean (可选) - 是否在创建时显示窗口。默认值为 true
    • frame boolean (可选) - 指定 false 以创建一个 无边框窗口。默认值为 true
    • parent BaseWindow (可选) - 指定父窗口。默认值为 null
    • modal boolean (可选) - 这是否是模态窗口。这仅在窗口是子窗口时有效。默认值为 false
    • acceptFirstMouse boolean (可选) macOS - 单击非活动窗口是否也会点击到网页内容。在 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 boolean (可选) - 使窗口 透明。默认值为 false。在 Windows 上,除非窗口是无边框的,否则不起作用。
    • type string (可选) - 窗口的类型,默认值为普通窗口。请参阅以下有关此内容的更多信息。
    • visualEffectState string (可选) macOS - 指定材质外观应如何在 macOS 上反映窗口活动状态。必须与 vibrancy 属性一起使用。可能的值有
      • followWindow - 当窗口处于活动状态时,背景应自动显示为活动状态,而当窗口不活动时,则显示为不活动状态。这是默认值。
      • active - 背景应始终显示为活动状态。
      • inactive - 背景应始终显示为不活动状态。
    • titleBarStyle string (可选) - 窗口标题栏的样式。默认值为 default。可能的值有
      • default - 生成 macOS 或 Windows 的标准标题栏。
      • hidden - 导致标题栏隐藏,内容窗口全屏显示。在 macOS 上,窗口顶部左侧仍然有标准的窗口控件(“交通灯”)。在 Windows 和 Linux 上,当与 titleBarOverlay: true 结合使用时,它将激活窗口控件覆盖层(有关更多信息,请参阅 titleBarOverlay),否则将不显示任何窗口控件。
      • hiddenInset macOS - 导致标题栏隐藏,并采用另一种外观,其中交通灯按钮稍微从窗口边缘向内缩进。
      • customButtonsOnHover macOS - 导致标题栏隐藏,内容窗口全屏显示,当鼠标悬停在窗口左上角时,交通灯按钮将显示。注意:此选项目前处于实验阶段。
    • titleBarOverlay 对象 | 布尔值 (可选) - 在 macOS 上使用无边框窗口并结合 win.setWindowButtonVisibility(true) 或使用 titleBarStyle 以便标准窗口控件(macOS 上的“交通灯”)可见时,此属性启用窗口控件覆盖层JavaScript APICSS 环境变量。指定 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-basedtitlebarselectionmenupopoversidebarheadersheetwindowhudfullscreen-uitooltipcontentunder-windowunder-page
    • backgroundMaterial 字符串(可选) Windows - 设置窗口的系统绘制的背景材质,包括非客户端区域后面。可以是 autononemicaacrylictabbed。有关更多信息,请参阅 win.setBackgroundMaterial
    • zoomToPageWidth 布尔值(可选) macOS - 控制在 macOS 上单击工具栏上的绿色停止灯按钮或单击“窗口”>“缩放”菜单项时的行为。如果为 true,则窗口在缩放时将增长到网页的首选宽度,如果为 false,则将缩放到屏幕的宽度。这也会影响直接调用 maximize() 时的行为。默认值为 false
    • tabbingIdentifier 字符串(可选) macOS - 标签组名称,允许将窗口作为本机标签打开。具有相同标签标识符的窗口将分组在一起。这还会向窗口的标签栏添加一个本机的新标签按钮,并允许您的 app 和窗口接收 new-window-for-tab 事件。

    使用 minWidth/maxWidth/minHeight/maxHeight 设置最小或最大窗口大小时,它仅限制用户。它不会阻止您将不符合大小约束的大小传递给 setBounds/setSizeBrowserWindow 的构造函数。

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

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

实例事件

使用 new BaseWindow 创建的对象会发出以下事件

注意:某些事件仅在特定的操作系统上可用,并已标记为如此。

事件: 'close'

返回

  • event 事件

当窗口即将关闭时发出。它在 DOM 的 beforeunloadunload 事件之前发出。调用 event.preventDefault() 将取消关闭。

通常,您会希望使用 beforeunload 处理程序来决定是否应关闭窗口,该处理程序也会在重新加载窗口时调用。在 Electron 中,返回任何非 undefined 的值都将取消关闭。例如

window.onbeforeunload = (e) => {
console.log('I do not want to be closed')

// Unlike usual browsers that a message box will be prompted to users, returning
// a non-void value will silently cancel the close.
// It is recommended to use the dialog API to let the user confirm closing the
// application.
e.returnValue = false
}

注意window.onbeforeunload = handlerwindow.addEventListener('beforeunload', handler) 的行为之间存在细微的差异。建议始终显式设置 event.returnValue,而不是仅返回值,因为前者在 Electron 中工作更一致。

事件: 'closed'

当窗口关闭时发出。收到此事件后,应删除对窗口的引用,并避免再使用它。

事件: 'session-end' Windows

当窗口会话因强制关机或机器重启或会话注销而即将结束时发出。

事件: 'blur'

返回

  • event 事件

当窗口失去焦点时发出。

事件: 'focus'

返回

  • event 事件

当窗口获得焦点时发出。

事件: 'show'

当窗口显示时发出。

事件: 'hide'

当窗口隐藏时发出。

事件: 'maximize'

当窗口最大化时发出。

事件: 'unmaximize'

当窗口从最大化状态退出时发出。

事件: 'minimize'

当窗口最小化时发出。

事件: 'restore'

当窗口从最小化状态恢复时发出。

事件: 'will-resize' macOS Windows

返回

  • event 事件
  • newBounds Rectangle - 窗口正在调整到的大小。
  • details 对象
    • edge (字符串) - 用于调整大小的窗口边缘。可以是 bottomleftrighttop-lefttop-rightbottom-leftbottom-right

在窗口调整大小之前发出。调用 event.preventDefault() 将阻止调整窗口大小。

请注意,这仅在手动调整窗口大小时发出。使用 setBounds/setSize 调整窗口大小不会发出此事件。

edge 选项的可能值和行为取决于平台。可能的值是

  • 在 Windows 上,可能的值为 bottomtopleftrighttop-lefttop-rightbottom-leftbottom-right
  • 在 macOS 上,可能的值为 bottomright
    • bottom 用于表示垂直调整大小。
    • right 用于表示水平调整大小。

事件: 'resize'

在窗口调整大小后发出。

事件: 'resized' macOS Windows

当窗口完成调整大小时发出一次。

这通常在手动调整窗口大小时发出。在 macOS 上,使用 setBounds/setSize 调整窗口大小并将 animate 参数设置为 true 也会在调整大小完成后发出此事件。

事件: 'will-move' macOS Windows

返回

  • event 事件
  • newBounds Rectangle - 窗口正在移动到的位置。

在窗口移动之前发出。在 Windows 上,调用 event.preventDefault() 将阻止移动窗口。

请注意,此事件仅在手动移动窗口时触发。使用 setPosition/setBounds/center 移动窗口不会触发此事件。

事件:'move'

当窗口被移动到新的位置时触发。

事件:'moved' macOS Windows

当窗口被移动到新的位置时,仅触发一次。

注意:在 macOS 上,此事件是 move 的别名。

事件:'enter-full-screen'

当窗口进入全屏状态时触发。

事件:'leave-full-screen'

当窗口离开全屏状态时触发。

事件:'always-on-top-changed'

返回

  • event 事件
  • isAlwaysOnTop 布尔值

当窗口设置为始终显示在其他窗口之上或取消此设置时触发。

事件:'app-command' Windows Linux

返回

  • event 事件
  • command 字符串

应用程序命令 被调用时触发。这些命令通常与键盘媒体键或浏览器命令相关,也包括 Windows 上一些鼠标内置的“后退”按钮。

命令转换为小写,下划线替换为连字符,并删除 APPCOMMAND_ 前缀。例如,APPCOMMAND_BROWSER_BACKWARD 会作为 browser-backward 触发。

const { BaseWindow } = require('electron')
const win = new BaseWindow()
win.on('app-command', (e, cmd) => {
// Navigate the window back when the user hits their mouse back button
if (cmd === 'browser-backward') {
// Find the appropriate WebContents to navigate.
}
})

以下应用程序命令在 Linux 上明确支持

  • browser-backward
  • browser-forward

事件:'swipe' macOS

返回

  • event 事件
  • direction 字符串

在三指滑动时触发。可能的方向为 uprightdownleft

此事件的基础方法用于处理旧的 macOS 风格的触控板滑动,其中屏幕上的内容不会随着滑动而移动。大多数 macOS 触控板不再配置为允许这种滑动,因此为了使其正常触发,必须将 系统偏好设置 > 触控板 > 更多手势 中的“在页面之间滑动”偏好设置为“使用两根或三根手指滑动”。

事件:'rotate-gesture' macOS

返回

  • event 事件
  • rotation 浮点数

在触控板旋转手势时触发。持续触发直到旋转手势结束。每次触发的 rotation 值是自上次触发以来旋转的角度(以度为单位)。旋转手势的最后一次触发事件的值始终为 0。逆时针旋转的值为正,而顺时针旋转的值为负。

事件:'sheet-begin' macOS

当窗口打开一个工作表时触发。

事件:'sheet-end' macOS

当窗口关闭一个工作表时触发。

事件:'new-window-for-tab' macOS

当点击原生新建标签页按钮时触发。

事件:'system-context-menu' Windows

返回

  • event 事件
  • point Point - 触发上下文菜单的屏幕坐标

当在窗口上触发系统上下文菜单时触发,这通常仅在用户右键单击窗口的非客户端区域时触发。这包括窗口的标题栏或在无边框窗口中声明为 -webkit-app-region: drag 的任何区域。

调用 event.preventDefault() 将阻止菜单显示。

静态方法

BaseWindow 类具有以下静态方法

BaseWindow.getAllWindows()

返回 BaseWindow[] - 所有已打开的浏览器窗口的数组。

BaseWindow.getFocusedWindow()

返回 BaseWindow | null - 此应用程序中获得焦点的窗口,否则返回 null

BaseWindow.fromId(id)

  • id 整数

返回 BaseWindow | null - 具有给定 id 的窗口。

实例属性

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

const { BaseWindow } = require('electron')
// In this example `win` is our instance
const win = new BaseWindow({ width: 800, height: 600 })

win.id 只读

一个 整数 属性,表示窗口的唯一 ID。每个 ID 在整个 Electron 应用程序的所有 BaseWindow 实例中都是唯一的。

win.contentView

窗口内容视图的 View 属性。

win.tabbingIdentifier macOS 只读

一个 字符串(可选)属性,等于传递给 BrowserWindow 构造函数的 tabbingIdentifier,如果未设置,则为 undefined

win.autoHideMenuBar

一个 布尔 属性,确定窗口菜单栏是否应自动隐藏。设置后,菜单栏仅在用户按下单个 Alt 键时显示。

如果菜单栏已经可见,将此属性设置为 true 不会立即隐藏它。

win.simpleFullScreen

一个 布尔 属性,确定窗口是否处于简单(pre-Lion)全屏模式。

win.fullScreen

一个 布尔 属性,确定窗口是否处于全屏模式。

win.focusable Windows macOS

一个 布尔 属性,确定窗口是否可获得焦点。

win.visibleOnAllWorkspaces macOS Linux

一个 布尔 属性,确定窗口是否在所有工作区中可见。

注意: 在 Windows 上始终返回 false。

win.shadow

一个 布尔 属性,确定窗口是否具有阴影。

win.menuBarVisible Windows Linux

一个 布尔 属性,确定菜单栏是否应可见。

注意: 如果菜单栏设置为自动隐藏,用户仍然可以通过按下单个 Alt 键来调出菜单栏。

win.kiosk

一个 布尔 属性,确定窗口是否处于 kiosk 模式。

win.documentEdited macOS

一个 布尔 属性,指定窗口的文档是否已被编辑。

当设置为 true 时,标题栏中的图标将变为灰色。

win.representedFilename macOS

一个 字符串 属性,确定窗口所代表的文件的路径名,并且该文件的图标将显示在窗口的标题栏中。

win.title

一个 字符串 属性,确定原生窗口的标题。

注意: 网页的标题可能与原生窗口的标题不同。

win.minimizable macOS Windows

一个 布尔 属性,确定用户是否可以手动最小化窗口。

在 Linux 上,setter 是一个空操作,尽管 getter 返回 true

win.maximizable macOS Windows

一个 布尔 属性,确定用户是否可以手动最大化窗口。

在 Linux 上,setter 是一个空操作,尽管 getter 返回 true

win.fullScreenable

一个 布尔 属性,确定最大化/缩放窗口按钮是切换全屏模式还是最大化窗口。

win.resizable

一个 布尔 属性,确定用户是否可以手动调整窗口大小。

win.closable macOS Windows

一个 布尔 属性,确定用户是否可以手动关闭窗口。

在 Linux 上,setter 是一个空操作,尽管 getter 返回 true

win.movable macOS Windows

一个 布尔 属性,确定用户是否可以移动窗口。

在 Linux 上,setter 是一个空操作,尽管 getter 返回 true

win.excludedFromShownWindowsMenu macOS

一个 布尔 属性,确定窗口是否从应用程序的“窗口”菜单中排除。默认为 false

const { Menu, BaseWindow } = require('electron')
const win = new BaseWindow({ height: 600, width: 600 })

const template = [
{
role: 'windowmenu'
}
]

win.excludedFromShownWindowsMenu = true

const menu = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(menu)

win.accessibleTitle

一个 string 类型的属性,定义了仅提供给屏幕阅读器等辅助工具的备用标题。此字符串不会直接对用户可见。

实例方法

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

注意: 某些方法仅在特定操作系统上可用,并会进行相应标记。

win.setContentView(view)

设置窗口的内容视图。

win.getContentView()

返回 View - 窗口的内容视图。

win.destroy()

强制关闭窗口,不会为网页发出 unloadbeforeunload 事件,也不会为该窗口发出 close 事件,但保证会发出 closed 事件。

win.close()

尝试关闭窗口。这与用户手动单击窗口的关闭按钮效果相同。但是,网页可能会取消关闭。请参阅 close 事件

win.focus()

将焦点设置到窗口。

win.blur()

从窗口移除焦点。

win.isFocused()

返回 boolean - 窗口是否具有焦点。

win.isDestroyed()

返回 boolean - 窗口是否已销毁。

win.show()

显示窗口并使其获得焦点。

win.showInactive()

显示窗口,但不使其获得焦点。

win.hide()

隐藏窗口。

win.isVisible()

返回 boolean - 窗口是否在应用程序的前台对用户可见。

win.isModal()

返回 boolean - 当前窗口是否为模态窗口。

win.maximize()

最大化窗口。如果窗口尚未显示,也会显示(但不获得焦点)窗口。

win.unmaximize()

取消最大化窗口。

win.isMaximized()

返回 boolean - 窗口是否已最大化。

win.minimize()

最小化窗口。在某些平台上,最小化的窗口将显示在 Dock 中。

win.restore()

将窗口从最小化状态恢复到之前的状态。

win.isMinimized()

返回 boolean - 窗口是否已最小化。

win.setFullScreen(flag)

  • flag boolean

设置窗口是否应处于全屏模式。

注意: 在 macOS 上,全屏转换是异步进行的。如果后续操作依赖于全屏状态,请使用 'enter-full-screen''leave-full-screen' 事件。

win.isFullScreen()

返回 boolean - 窗口是否处于全屏模式。

win.setSimpleFullScreen(flag) macOS

  • flag boolean

进入或退出简单全屏模式。

简单全屏模式模拟了 Lion (10.7) 之前 macOS 版本中的原生全屏行为。

win.isSimpleFullScreen() macOS

返回 boolean - 窗口是否处于简单(Lion 之前)全屏模式。

win.isNormal()

返回 boolean - 窗口是否处于正常状态(未最大化、未最小化、未处于全屏模式)。

win.setAspectRatio(aspectRatio[, extraSize])

  • aspectRatio Float - 要为内容视图的某些部分保持的纵横比。
  • extraSize Size (可选)macOS - 在保持纵横比时不包含的额外大小。

这将使窗口保持纵横比。额外的尺寸允许开发人员在像素中指定空间,该空间不包括在纵横比计算中。此 API 已经考虑了窗口大小和其内容大小之间的差异。

考虑一个带有高清视频播放器和相关控件的普通窗口。也许在左边缘有 15 像素的控件,在右边缘有 25 像素的控件,在播放器下方有 50 像素的控件。为了在播放器本身中保持 16:9 的纵横比(高清标准纵横比 @1920x1080),我们将使用 16/9 和 { width: 40, height: 50 } 的参数调用此函数。第二个参数不关心额外宽度和高度在内容视图中的位置,只关心它们的存在。将您在整个内容视图中具有的所有额外宽度和高度区域相加。

当使用 win.setSize 等 API 以编程方式调整窗口大小时,不会遵守纵横比。

要重置纵横比,请将 0 作为 aspectRatio 值传递:win.setAspectRatio(0)

win.setBackgroundColor(backgroundColor)

  • backgroundColor string - 颜色,格式为十六进制、RGB、RGBA、HSL、HSLA 或命名的 CSS 颜色。对于十六进制类型,alpha 通道是可选的。

有效的 backgroundColor 值示例

  • 十六进制
    • #fff(简写 RGB)
    • #ffff(简写 ARGB)
    • #ffffff (RGB)
    • #ffffffff (ARGB)
  • 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 关键字,但区分大小写。
      • 例如 bluevioletred

设置窗口的背景颜色。请参阅 设置 backgroundColor

win.previewFile(path[, displayName]) macOS

  • path string - 使用 QuickLook 预览的文件的绝对路径。这一点很重要,因为 Quick Look 使用路径上的文件名和文件扩展名来确定要打开的文件的内容类型。
  • displayName string(可选) - 要在 Quick Look 模态视图上显示的文件名。这纯粹是视觉效果,不会影响文件的内容类型。默认为 path

使用 Quick Look 预览给定路径的文件。

win.closeFilePreview() macOS

关闭当前打开的 Quick Look 面板。

win.setBounds(bounds[, animate])

  • bounds Partial<Rectangle>
  • animate boolean(可选)macOS

调整窗口大小并将窗口移动到提供的边界。任何未提供的属性都将默认为其当前值。

const { BaseWindow } = require('electron')
const win = new BaseWindow()

// set all bounds properties
win.setBounds({ x: 440, y: 225, width: 800, height: 600 })

// set a single bounds property
win.setBounds({ width: 100 })

// { x: 440, y: 225, width: 100, height: 600 }
console.log(win.getBounds())

注意: 在 macOS 上,y 坐标值不能小于 Tray 高度。托盘高度随时间而变化,并且取决于操作系统,但介于 20-40 像素之间。传递低于托盘高度的值将导致窗口与托盘齐平。

win.getBounds()

返回 Rectangle - 窗口的 bounds 作为 Object

注意: 在 macOS 上,返回的 y 坐标值将至少是 Tray 高度。例如,使用 38 的托盘高度调用 win.setBounds({ x: 25, y: 20, width: 800, height: 600 }) 意味着 win.getBounds() 将返回 { x: 25, y: 38, width: 800, height: 600 }

win.getBackgroundColor()

返回 string - 以十六进制 (#RRGGBB) 格式获取窗口的背景颜色。

请参阅 设置 backgroundColor

注意: alpha 值不会与红色、绿色和蓝色值一起返回。

win.setContentBounds(bounds[, animate])

  • bounds Rectangle
  • animate boolean(可选)macOS

调整窗口客户端区域(例如网页)的大小并将其移动到提供的边界。

win.getContentBounds()

返回 Rectangle - 窗口客户端区域的 bounds,格式为 Object

win.getNormalBounds()

返回 Rectangle - 包含窗口正常状态下的边界

注意:无论窗口的当前状态如何:最大化、最小化或全屏,此函数始终返回窗口在正常状态下的位置和大小。在正常状态下,getBounds 和 getNormalBounds 返回相同的 Rectangle

win.setEnabled(enable)

  • enable boolean

禁用或启用窗口。

win.isEnabled()

返回 boolean - 窗口是否已启用。

win.setSize(width, height[, animate])

  • width Integer
  • height Integer
  • animate boolean(可选)macOS

将窗口调整为 widthheight。如果 widthheight 低于任何设置的最小大小约束,则窗口将捕捉到其最小大小。

win.getSize()

返回 Integer[] - 包含窗口的宽度和高度。

win.setContentSize(width, height[, animate])

  • width Integer
  • height Integer
  • animate boolean(可选)macOS

将窗口的客户端区域(例如网页)调整为 widthheight

win.getContentSize()

返回 Integer[] - 包含窗口客户端区域的宽度和高度。

win.setMinimumSize(width, height)

  • width Integer
  • height Integer

将窗口的最小尺寸设置为 widthheight

win.getMinimumSize()

返回 Integer[] - 包含窗口的最小宽度和高度。

win.setMaximumSize(width, height)

  • width Integer
  • height Integer

将窗口的最大尺寸设置为 widthheight

win.getMaximumSize()

返回 Integer[] - 包含窗口的最大宽度和高度。

win.setResizable(resizable)

  • resizable boolean

设置用户是否可以手动调整窗口大小。

win.isResizable()

返回 boolean - 用户是否可以手动调整窗口大小。

win.setMovable(movable) macOS Windows

  • movable boolean

设置用户是否可以移动窗口。在 Linux 上不起作用。

win.isMovable() macOS Windows

返回 boolean - 用户是否可以移动窗口。

在 Linux 上始终返回 true

win.setMinimizable(minimizable) macOS Windows

  • minimizable boolean

设置用户是否可以手动最小化窗口。在 Linux 上不起作用。

win.isMinimizable() macOS Windows

返回 boolean - 用户是否可以手动最小化窗口。

在 Linux 上始终返回 true

win.setMaximizable(maximizable) macOS Windows

  • maximizable boolean

设置用户是否可以手动最大化窗口。在 Linux 上不起作用。

win.isMaximizable() macOS Windows

返回 boolean - 用户是否可以手动最大化窗口。

在 Linux 上始终返回 true

win.setFullScreenable(fullscreenable)

  • fullscreenable boolean

设置最大化/缩放窗口按钮是切换全屏模式还是最大化窗口。

win.isFullScreenable()

返回 boolean - 最大化/缩放窗口按钮是切换全屏模式还是最大化窗口。

win.setClosable(closable) macOS Windows

  • closable boolean

设置用户是否可以手动关闭窗口。在 Linux 上不起作用。

win.isClosable() macOS Windows

返回 boolean - 用户是否可以手动关闭窗口。

在 Linux 上始终返回 true

win.setHiddenInMissionControl(hidden) macOS

  • hidden boolean

设置当用户切换到任务控制时窗口是否隐藏。

win.isHiddenInMissionControl() macOS

返回 boolean - 当用户切换到任务控制时窗口是否隐藏。

win.setAlwaysOnTop(flag[, level][, relativeLevel])

  • flag boolean
  • level string(可选)macOS Windows - 值包括 normalfloatingtorn-off-menumodal-panelmain-menustatuspop-up-menuscreen-saverdock(已弃用)。当 flag 为 true 时,默认值为 floating。当 flag 为 false 时,level 将重置为 normal。请注意,从 floatingstatus(包含)为止,窗口位于 macOS 上的 Dock 下方和 Windows 上的任务栏下方。从 pop-up-menu 到更高的位置,它显示在 macOS 上的 Dock 上方和 Windows 上的任务栏上方。有关更多详细信息,请参阅 macOS 文档
  • relativeLevel Integer(可选)macOS - 将此窗口相对于给定 level 设置的层数。默认值为 0。请注意,Apple 不建议将级别设置得高于 screen-saver 上方 1 层。

设置窗口是否应始终显示在其他窗口之上。设置此项后,窗口仍然是一个普通窗口,而不是一个无法聚焦的工具箱窗口。

win.isAlwaysOnTop()

返回 boolean - 窗口是否始终位于其他窗口之上。

win.moveAbove(mediaSourceId)

  • mediaSourceId string - 窗口 ID,格式为 DesktopCapturerSource 的 ID。例如“window:1869:0”。

在 z 顺序中将窗口移动到源窗口之上。如果 mediaSourceId 不是窗口类型,或者如果窗口不存在,则此方法会抛出错误。

win.moveTop()

将窗口移动到顶部(z 顺序),无论焦点如何

win.center()

将窗口移动到屏幕中心。

win.setPosition(x, y[, animate])

  • x 整数
  • y 整数
  • animate boolean(可选)macOS

将窗口移动到 xy 的位置。

win.getPosition()

返回 Integer[] - 包含窗口的当前位置。

win.setTitle(title)

  • title 字符串

将原生窗口的标题更改为 title

win.getTitle()

返回 string - 原生窗口的标题。

注意: 网页的标题可能与原生窗口的标题不同。

win.setSheetOffset(offsetY[, offsetX]) macOS

  • offsetY 浮点数
  • offsetX 浮点数(可选)

更改 macOS 上工作表的附加点。默认情况下,工作表附加在窗口框架的正下方,但您可能希望将它们显示在 HTML 渲染的工具栏下方。例如

const { BaseWindow } = require('electron')
const win = new BaseWindow()

const toolbarRect = document.getElementById('toolbar').getBoundingClientRect()
win.setSheetOffset(toolbarRect.height)

win.flashFrame(flag)

历史
  • flag boolean

开始或停止闪烁窗口以吸引用户的注意。

win.setSkipTaskbar(skip) macOS Windows

  • skip 布尔值

使窗口不在任务栏中显示。

win.setKiosk(flag)

  • flag boolean

进入或离开 kiosk 模式。

win.isKiosk()

返回 boolean - 窗口是否处于 kiosk 模式。

win.isTabletMode() Windows

返回 boolean - 窗口是否处于 Windows 10 平板模式。

由于 Windows 10 用户可以像使用平板电脑一样使用他们的 PC,在此模式下,应用程序可以选择优化其平板电脑的 UI,例如放大标题栏和隐藏标题栏按钮。

此 API 返回窗口是否处于平板模式,并且可以使用 resize 事件来监听平板模式的更改。

win.getMediaSourceId()

返回 string - 窗口 ID 的格式为 DesktopCapturerSource 的 ID。例如 “window:1324:0”。

更准确地说,格式为 window:id:other_id,其中 id 在 Windows 上是 HWND,在 macOS 上是 CGWindowID (uint64_t),在 Linux 上是 Window (unsigned long)。 other_id 用于标识 Web 内容(选项卡),因此在同一个顶级窗口中。

win.getNativeWindowHandle()

返回 Buffer - 窗口的平台特定句柄。

句柄的原生类型在 Windows 上是 HWND,在 macOS 上是 NSView*,在 Linux 上是 Window (unsigned long)。

win.hookWindowMessage(message, callback) Windows

  • message 整数
  • callback 函数
    • wParam Buffer - 提供给 WndProc 的 wParam
    • lParam Buffer - 提供给 WndProc 的 lParam

挂钩 Windows 消息。当 WndProc 中接收到消息时,将调用 callback

win.isWindowMessageHooked(message) Windows

  • message 整数

返回 boolean - 根据消息是否被挂钩返回 truefalse

win.unhookWindowMessage(message) Windows

  • message 整数

取消挂钩窗口消息。

win.unhookAllWindowMessages() Windows

取消挂钩所有窗口消息。

win.setRepresentedFilename(filename) macOS

  • filename 字符串

设置窗口所代表的文件的路径名,并且该文件的图标将显示在窗口的标题栏中。

win.getRepresentedFilename() macOS

返回 string - 窗口所代表的文件的路径名。

win.setDocumentEdited(edited) macOS

  • edited 布尔值

指定是否已编辑窗口的文档,并且当设置为 true 时,标题栏中的图标将变为灰色。

win.isDocumentEdited() macOS

返回 boolean - 窗口的文档是否已被编辑。

win.setMenu(menu) Linux Windows

  • menu 菜单 | null

menu 设置为窗口的菜单栏。

win.removeMenu() Linux Windows

移除窗口的菜单栏。

win.setProgressBar(progress[, options])

  • progress 双精度浮点数
  • options 对象(可选)
    • mode 字符串 Windows - 进度条的模式。可以是 nonenormalindeterminateerrorpaused

在进度条中设置进度值。有效范围为 [0, 1.0]。

当进度 < 0 时移除进度条;当进度 > 1 时更改为不确定模式。

在 Linux 平台上,仅支持 Unity 桌面环境,您需要在 package.json 中的 desktopName 字段中指定 *.desktop 文件名。默认情况下,它将假定为 {app.name}.desktop

在 Windows 上,可以传递一个模式。接受的值为 nonenormalindeterminateerrorpaused。如果您在未设置模式的情况下调用 setProgressBar(但在有效范围内具有值),则将假定为 normal

win.setOverlayIcon(overlay, description) Windows

  • overlay NativeImage | null - 要显示在任务栏图标右下角的图标。如果此参数为 null,则清除覆盖。
  • description 字符串 - 将提供给辅助功能屏幕阅读器的描述

在当前任务栏图标上设置一个 16 x 16 像素的覆盖,通常用于传达某种应用程序状态或被动地通知用户。

win.invalidateShadow() macOS

使窗口阴影失效,以便根据当前窗口形状重新计算阴影。

透明的 BaseWindow 有时会在 macOS 上留下视觉伪影。此方法可用于在例如执行动画时清除这些伪影。

win.setHasShadow(hasShadow)

  • hasShadow 布尔值

设置窗口是否应具有阴影。

win.hasShadow()

返回 boolean - 窗口是否具有阴影。

win.setOpacity(opacity) Windows macOS

  • opacity 数字 - 介于 0.0(完全透明)和 1.0(完全不透明)之间

设置窗口的不透明度。在 Linux 上,不起作用。超出范围的数字值将被钳制到 [0, 1] 范围内。

win.getOpacity()

返回 number - 介于 0.0(完全透明)和 1.0(完全不透明)之间。在 Linux 上,始终返回 1。

win.setShape(rects) Windows Linux 实验性

  • rects Rectangle[] - 在窗口上设置形状。传递空列表会将窗口恢复为矩形。

设置窗口形状确定系统允许在窗口内进行绘制和用户交互的区域。在给定区域之外,将不会绘制任何像素,也不会注册任何鼠标事件。区域外的鼠标事件不会被该窗口接收,而是会传递到窗口后面的内容。

win.setThumbarButtons(buttons) Windows

返回 boolean - 是否成功添加了按钮

将带有指定按钮集的缩略图工具栏添加到任务栏按钮布局中窗口的缩略图图像。返回一个 boolean 对象,指示是否已成功添加缩略图。

由于空间有限,缩略图工具栏中的按钮数量不应超过 7 个。设置缩略图工具栏后,由于平台的限制,该工具栏无法删除。但是,您可以调用一个空数组的 API 来清除这些按钮。

buttons 是一个 Button 对象的数组

  • Button 对象
    • icon NativeImage - 显示在缩略图工具栏中的图标。
    • click 函数
    • tooltip string (可选) - 按钮的工具提示文本。
    • flags string[] (可选) - 控制按钮的特定状态和行为。默认情况下为 ['enabled']

flags 是一个可以包含以下 string 的数组

  • enabled - 按钮处于活动状态,可供用户使用。
  • disabled - 按钮被禁用。它存在,但具有视觉状态指示它不会响应用户操作。
  • dismissonclick - 单击按钮时,缩略图窗口会立即关闭。
  • nobackground - 不绘制按钮边框,仅使用图像。
  • hidden - 按钮不向用户显示。
  • noninteractive - 按钮已启用但不可交互;不绘制按下按钮的状态。此值适用于按钮用于通知的情况。

win.setThumbnailClip(region) Windows

设置窗口区域以显示为在任务栏中悬停在窗口上时显示的缩略图。您可以通过指定空区域来将缩略图重置为整个窗口: { x: 0, y: 0, width: 0, height: 0 }

win.setThumbnailToolTip(toolTip) Windows

  • toolTip string

设置在任务栏中悬停在窗口缩略图上时显示的工具提示。

win.setAppDetails(options) Windows

  • options 对象
    • appId string (可选) - 窗口的 应用程序用户模型 ID。必须设置此项,否则其他选项将无效。
    • appIconPath string (可选) - 窗口的 重新启动图标
    • appIconIndex Integer (可选) - appIconPath 中图标的索引。当未设置 appIconPath 时,将被忽略。默认为 0
    • relaunchCommand string (可选) - 窗口的 重新启动命令
    • relaunchDisplayName string (可选) - 窗口的 重新启动显示名称

设置窗口任务栏按钮的属性。

注意: relaunchCommandrelaunchDisplayName 必须始终一起设置。如果未设置其中一个属性,则都不会被使用。

win.setIcon(icon) Windows Linux

更改窗口图标。

win.setWindowButtonVisibility(visible) macOS

  • visible boolean

设置窗口的交通灯按钮是否应可见。

win.setAutoHideMenuBar(hide) Windows Linux

  • hide boolean

设置窗口菜单栏是否应自动隐藏。设置后,菜单栏仅在用户按下单个 Alt 键时才会显示。

如果菜单栏已经可见,则调用 setAutoHideMenuBar(true) 不会立即隐藏它。

win.isMenuBarAutoHide() Windows Linux

返回 boolean - 菜单栏是否自动隐藏。

win.setMenuBarVisibility(visible) Windows Linux

  • visible boolean

设置菜单栏是否应可见。如果菜单栏是自动隐藏的,用户仍然可以通过按下单个 Alt 键来调出菜单栏。

win.isMenuBarVisible() Windows Linux

返回 boolean - 菜单栏是否可见。

win.setVisibleOnAllWorkspaces(visible[, options]) macOS Linux

  • visible boolean
  • options 对象(可选)
    • visibleOnFullScreen boolean (可选) macOS - 设置窗口是否应在全屏窗口上方可见。
    • skipTransformProcessType boolean (可选) macOS - 默认情况下,调用 setVisibleOnAllWorkspaces 将在 UIElementApplication 和 ForegroundApplication 之间转换进程类型,以确保正确的行为。但是,每次调用它时,这将短暂地隐藏窗口和 Dock。如果您的窗口已经是 UIElementApplication 类型,则可以通过将 true 传递给 skipTransformProcessType 来绕过此转换。

设置窗口是否应在所有工作区上可见。

注意: 此 API 在 Windows 上不起作用。

win.isVisibleOnAllWorkspaces() macOS Linux

返回 boolean - 窗口是否在所有工作区上可见。

注意: 此 API 在 Windows 上始终返回 false。

win.setIgnoreMouseEvents(ignore[, options])

  • ignore boolean
  • options 对象(可选)
    • forward boolean (可选) macOS Windows - 如果为 true,则将鼠标移动消息转发到 Chromium,从而启用鼠标相关事件,例如 mouseleave。仅当 ignore 为 true 时使用。如果 ignore 为 false,则无论此值如何,转发始终被禁用。

使窗口忽略所有鼠标事件。

在此窗口中发生的所有鼠标事件都将传递到此窗口下方的窗口,但如果此窗口具有焦点,它仍然会接收键盘事件。

win.setContentProtection(enable) macOS Windows

  • enable boolean

阻止窗口内容被其他应用捕获。

在 macOS 上,它将 NSWindow 的 sharingType 设置为 NSWindowSharingNone。在 Windows 上,它使用 WDA_EXCLUDEFROMCAPTURE 调用 SetWindowDisplayAffinity。对于 Windows 10 版本 2004 及更高版本,窗口将完全从捕获中删除,较旧的 Windows 版本表现为应用了 WDA_MONITOR,捕获一个黑色窗口。

win.setFocusable(focusable) macOS Windows

  • focusable boolean

更改窗口是否可以获得焦点。

在 macOS 上,它不会从窗口中删除焦点。

win.isFocusable() macOS Windows

返回 boolean - 窗口是否可以获得焦点。

win.setParentWindow(parent)

  • parent BaseWindow | null

parent 设置为当前窗口的父窗口,传递 null 将把当前窗口变成顶级窗口。

win.getParentWindow()

返回 BaseWindow | null - 父窗口,如果没有父窗口则返回 null

win.getChildWindows()

返回 BaseWindow[] - 所有子窗口。

win.setAutoHideCursor(autoHide) macOS

  • autoHide boolean

控制在输入时是否隐藏光标。

win.selectPreviousTab() macOS

当启用本机标签并且窗口中有其他标签时,选择上一个标签。

win.selectNextTab() macOS

当启用本机标签并且窗口中有其他标签时,选择下一个标签。

win.showAllTabs() macOS

当启用本机标签时,显示或隐藏标签概览。

win.mergeAllWindows() macOS

当启用本机标签并且有多个打开的窗口时,将所有窗口合并为一个具有多个标签的窗口。

win.moveTabToNewWindow() macOS

如果启用了本机标签并且当前窗口中有多个标签,则将当前标签移动到新窗口。

win.toggleTabBar() macOS

如果启用了本机标签并且当前窗口中只有一个标签,则切换标签栏的可见性。

win.addTabbedWindow(baseWindow) macOS

  • baseWindow BaseWindow

在此窗口上添加一个窗口作为标签,在窗口实例的标签之后。

win.setVibrancy(type) macOS

  • type string | null - 可以是 titlebar, selection, menu, popover, sidebar, header, sheet, window, hud, fullscreen-ui, tooltip, content, under-windowunder-page。有关详细信息,请参阅 macOS 文档

为窗口添加一个生动效果。传递 null 或空字符串将删除窗口上的生动效果。

win.setBackgroundMaterial(material) Windows

  • material string
    • auto - 让桌面窗口管理器 (DWM) 自动决定此窗口的系统绘制背景材质。这是默认值。
    • none - 不绘制任何系统背景。
    • mica - 绘制对应于长期存在窗口的背景材质效果。
    • acrylic - 绘制对应于瞬态窗口的背景材质效果。
    • tabbed - 绘制对应于带有选项卡式标题栏的窗口的背景材质效果。

此方法设置浏览器窗口的系统绘制背景材质,包括非客户端区域的后面。

有关详细信息,请参阅 Windows 文档

注意: 此方法仅在 Windows 11 22H2 及更高版本上受支持。

win.setWindowButtonPosition(position) macOS

为无边框窗口中的交通灯按钮设置自定义位置。传递 null 将把位置重置为默认值。

win.getWindowButtonPosition() macOS

返回 Point | null - 无边框窗口中交通灯按钮的自定义位置,当没有自定义位置时,将返回 null

win.setTouchBar(touchBar) macOS

  • touchBar TouchBar | null

设置当前窗口的 touchBar 布局。指定 nullundefined 将清除触控栏。此方法仅在机器具有触控栏时才有效。

注意: TouchBar API 目前是实验性的,可能会在未来的 Electron 版本中更改或删除。

win.setTitleBarOverlay(options) Windows Linux

  • options 对象
    • color String (可选) - 启用时,窗口控件叠加层的 CSS 颜色。
    • symbolColor String (可选) - 启用时,窗口控件叠加层上符号的 CSS 颜色。
    • height Integer (可选) - 标题栏和窗口控件叠加层的高度,以像素为单位。

在已启用窗口控件叠加层的窗口上,此方法会更新标题栏叠加层的样式。

在 Linux 上,如果没有显式设置,则会自动计算 symbolColor 以使其与 color 具有最小可访问对比度。