BrowserWindow
创建和控制浏览器窗口。
进程: 主进程
此模块在 app 模块的 ready 事件发出后才能使用。
// In the main process.
const { BrowserWindow } = require('electron')
const win = new BrowserWindow({ width: 800, height: 600 })
// Load a remote URL
win.loadURL('https://github.com')
// Or load a local HTML file
win.loadFile('index.html')
窗口自定义
BrowserWindow 类公开了多种方法来修改应用程序窗口的外观和行为。有关更多详细信息，请参阅窗口自定义教程。
优雅地显示窗口
当直接在窗口中加载页面时，用户可能会看到页面逐步加载，这对于原生应用程序来说不是一个好的体验。为了使窗口显示时没有视觉闪烁，针对不同的情况有两种解决方案。
使用 ready-to-show 事件
在加载页面时，如果窗口尚未显示，则当渲染器进程首次渲染页面时，将发出 ready-to-show 事件。在此事件之后显示窗口将不会有视觉闪烁
const { BrowserWindow } = require('electron')
const win = new BrowserWindow({ show: false })
win.once('ready-to-show', () => {
win.show()
})
此事件通常在 did-finish-load 事件之后发出，但对于具有许多远程资源的页面，它可能在 did-finish-load 事件之前发出。
请注意，使用此事件意味着即使 show 为 false，渲染器也将被视为“可见”并进行绘制。如果您使用 paintWhenInitiallyHidden: false，则此事件永远不会触发
设置 backgroundColor 属性
对于复杂的应用程序，ready-to-show 事件可能会发出得太晚，使应用程序感觉缓慢。在这种情况下，建议立即显示窗口，并使用接近应用程序背景的 backgroundColor
const { BrowserWindow } = require('electron')
const win = new BrowserWindow({ backgroundColor: '#2e2c29' })
win.loadURL('https://github.com')
请注意，即使对于使用 ready-to-show 事件的应用程序，仍然建议设置 backgroundColor 以使应用程序感觉更原生。
一些有效的 backgroundColor 值示例包括
const win = new BrowserWindow()
win.setBackgroundColor('hsl(230, 100%, 50%)')
win.setBackgroundColor('rgb(255, 145, 145)')
win.setBackgroundColor('#ff00a3')
win.setBackgroundColor('blueviolet')
有关这些颜色类型的更多信息，请参阅win.setBackgroundColor中的有效选项。
父窗口和子窗口
通过使用 parent 选项，您可以创建子窗口
const { BrowserWindow } = require('electron')
const top = new BrowserWindow()
const child = new BrowserWindow({ parent: top })
child.show()
top.show()
child 窗口将始终显示在 top 窗口的顶部。
模态窗口
模态窗口是禁用父窗口的子窗口。要创建模态窗口，您必须同时设置 parent 和 modal 选项
const { BrowserWindow } = require('electron')
const top = new BrowserWindow()
const child = new BrowserWindow({ parent: top, modal: true, show: false })
child.loadURL('https://github.com')
child.once('ready-to-show', () => {
child.show()
})
页面可见性
Page Visibility API 的工作方式如下
- 在所有平台上，可见性状态跟踪窗口是否隐藏/最小化。
- 此外，在 macOS 上，可见性状态还会跟踪窗口遮挡状态。如果窗口被另一个窗口遮挡（即完全覆盖），则可见性状态将为
hidden。在其他平台上，仅当窗口最小化或使用win.hide()显式隐藏时，可见性状态才为hidden。 - 如果使用
show: false创建BrowserWindow，则尽管窗口实际上已隐藏，但初始可见性状态仍为visible。 - 如果禁用
backgroundThrottling，即使窗口最小化、遮挡或隐藏，可见性状态仍将保持visible。
建议您在可见性状态为 hidden 时暂停昂贵的操作，以最大限度地减少功耗。
平台注意事项
- 在 macOS 上，模态窗口将显示为附加到父窗口的 sheet。
- 在 macOS 上，当父窗口移动时，子窗口将保持相对于父窗口的相对位置，而在 Windows 和 Linux 上，子窗口不会移动。
- 在 Linux 上，模态窗口的类型将更改为
dialog。 - 在 Linux 上，许多桌面环境不支持隐藏模态窗口。
类: BrowserWindow 继承自 BaseWindow
创建和控制浏览器窗口。
进程: 主进程
BrowserWindow 是一个 EventEmitter。
它使用 options 设置的本机属性创建一个新的 BrowserWindow。
new BrowserWindow([options])
实例事件
使用 new BrowserWindow 创建的对象会发出以下事件
注意： 某些事件仅在特定的操作系统上可用，并已标记。
事件: 'page-title-updated'
返回值
eventEventtitlestringexplicitSetboolean
当文档更改其标题时发出，调用 event.preventDefault() 将阻止本机窗口的标题更改。当标题从文件 URL 合成时，explicitSet 为 false。
事件: 'close'
返回值
eventEvent
当窗口即将关闭时发出。它在 DOM 的 beforeunload 和 unload 事件之前发出。调用 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 = handler 和 window.addEventListener('beforeunload', handler) 的行为之间存在细微差别。建议始终显式设置 event.returnValue，而不是仅返回值，因为前者在 Electron 中工作更一致。
事件: 'closed'
当窗口关闭时发出。收到此事件后，您应删除对窗口的引用，并避免再使用它。
事件: 'query-session-end' Windows
返回值
eventWindowSessionEndEvent
当会话即将结束时发出，原因是关机、机器重启或用户注销。调用 event.preventDefault() 可以延迟系统关机，尽管通常最好尊重用户结束会话的选择。但是，如果结束会话会使用户面临丢失数据的风险，您可以选择使用它。
事件: 'session-end' Windows
返回值
eventWindowSessionEndEvent
当会话即将结束时发出，原因是关机、机器重启或用户注销。一旦此事件触发，就无法阻止会话结束。
事件: 'unresponsive'
当网页变得无响应时发出。
事件: 'responsive'
当无响应的网页再次变得响应时发出。
事件: 'blur'
当窗口失去焦点时发出。
事件: 'focus'
当窗口获得焦点时发出。
事件: 'show'
当窗口显示时发出。
事件: 'hide'
当窗口隐藏时发出。
事件: 'ready-to-show'
当网页已渲染（在未显示时）并且窗口可以显示而没有视觉闪烁时发出。
请注意，使用此事件意味着即使 show 为 false，渲染器也将被视为“可见”并进行绘制。如果您使用 paintWhenInitiallyHidden: false，则此事件永远不会触发
事件: 'maximize'
当窗口最大化时发出。
事件: 'unmaximize'
当窗口从最大化状态退出时发出。
事件: 'minimize'
当窗口最小化时发出。
事件: 'restore'
当窗口从最小化状态恢复时发出。
事件: 'will-resize' macOS Windows
返回值
eventEventnewBoundsRectangle - 窗口正在调整到的大小。detailsObjectedge(string) - 正在拖动以调整大小的窗口边缘。可以是bottom、left、right、top-left、top-right、bottom-left或bottom-right。
在窗口调整大小之前发出。调用 event.preventDefault() 将阻止窗口调整大小。
请注意，这仅在手动调整窗口大小时发出。使用 setBounds/setSize 调整窗口大小不会发出此事件。
edge 选项的可能值和行为取决于平台。可能的值为
- 在 Windows 上，可能的值为
bottom、top、left、right、top-left、top-right、bottom-left、bottom-right。 - 在 macOS 上，可能的值为
bottom和right。- 值
bottom用于表示垂直调整大小。 - 值
right用于表示水平调整大小。
- 值
事件: 'resize'
在窗口调整大小后发出。
事件: 'resized' macOS Windows
在窗口完成调整大小后发出一次。
这通常在手动调整窗口大小时发出。在 macOS 上，使用 setBounds/setSize 调整窗口大小并将 animate 参数设置为 true 也将在调整大小完成后发出此事件。
事件: 'will-move' macOS Windows
返回值
eventEventnewBoundsRectangle - 窗口正在移动到的位置。
在窗口移动之前发出。在 Windows 上，调用 event.preventDefault() 将阻止窗口移动。
请注意，这仅在手动移动窗口时发出。使用 setPosition/setBounds/center 移动窗口不会发出此事件。
事件: 'move'
当窗口正在移动到新位置时发出。
事件: 'moved' macOS Windows
当窗口移动到新位置后发出一次。
注意：在 macOS 上，此事件是 move 的别名。
事件: 'enter-full-screen'
当窗口进入全屏状态时发出。
事件: 'leave-full-screen'
当窗口离开全屏状态时发出。
事件: 'enter-html-full-screen'
当窗口进入由 HTML API 触发的全屏状态时发出。
事件: 'leave-html-full-screen'
当窗口离开由 HTML API 触发的全屏状态时发出。
事件: 'always-on-top-changed'
返回值
eventEventisAlwaysOnTopboolean
当窗口设置为或取消设置为始终显示在其他窗口之上时发出。
事件: 'app-command' Windows Linux
返回值
eventEventcommandstring
当 App Command 被调用时发出。这些通常与键盘媒体键或浏览器命令以及 Windows 上某些鼠标中内置的“后退”按钮有关。
命令是小写的，下划线替换为连字符，并且 APPCOMMAND_ 前缀被剥离。例如，APPCOMMAND_BROWSER_BACKWARD 作为 browser-backward 发出。
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
win.on('app-command', (e, cmd) => {
// Navigate the window back when the user hits their mouse back button
if (cmd === 'browser-backward' && win.webContents.canGoBack()) {
win.webContents.goBack()
}
})
以下应用程序命令在 Linux 上显式支持
browser-backwardbrowser-forward
事件: 'swipe' macOS
返回值
eventEventdirection字符串
在三指滑动时触发。可能的方向有 up、right、down、left。
此事件的底层方法旨在处理旧版 macOS 样式的触控板滑动，在这种滑动方式中，屏幕上的内容不会随滑动而移动。大多数 macOS 触控板不再配置为允许此类滑动，因此为了使其正常发出，必须将“在页面之间滑动”偏好设置在 系统偏好设置 > 触控板 > 更多手势 中设置为“用两指或三指滑动”。
事件: 'rotate-gesture' macOS
返回值
eventEventrotation浮点数
在触控板旋转手势时触发。持续触发直到旋转手势结束。每次触发时的 rotation 值是自上次触发以来旋转的角度，以度为单位。旋转手势的最后一次触发事件的值始终为 0。逆时针旋转值为正值，而顺时针旋转值为负值。
事件: 'sheet-begin' macOS
当窗口打开一个 sheet 时触发。
事件: 'sheet-end' macOS
当窗口关闭一个 sheet 时触发。
事件: 'new-window-for-tab' macOS
当原生新建标签页按钮被点击时触发。
事件: 'system-context-menu' Windows
返回值
eventEventpointPoint - 触发上下文菜单的屏幕坐标
当系统上下文菜单在窗口上被触发时发出，这通常仅在用户右键单击窗口的非客户端区域时触发。这是窗口标题栏或您在无边框窗口中声明为 -webkit-app-region: drag 的任何区域。
调用 event.preventDefault() 将阻止菜单显示。
静态方法
BrowserWindow 类具有以下静态方法
BrowserWindow.getAllWindows()
返回 BrowserWindow[] - 所有已打开的浏览器窗口的数组。
BrowserWindow.getFocusedWindow()
返回 BrowserWindow | null - 此应用程序中获得焦点的窗口，否则返回 null。
BrowserWindow.fromWebContents(webContents)
webContentsWebContents
返回 BrowserWindow | null - 拥有给定 webContents 的窗口，如果内容不属于任何窗口，则返回 null。
BrowserWindow.fromBrowserView(browserView) 已弃用
browserViewBrowserView
注意
BrowserView类已被弃用，并由新的WebContentsView类取代。
返回 BrowserWindow | null - 拥有给定 browserView 的窗口。如果给定的视图未附加到任何窗口，则返回 null。
BrowserWindow.fromId(id)
id整数
返回 BrowserWindow | null - 具有给定 id 的窗口。
实例属性
使用 new BrowserWindow 创建的对象具有以下属性
const { BrowserWindow } = require('electron')
// In this example `win` is our instance
const win = new BrowserWindow({ width: 800, height: 600 })
win.loadURL('https://github.com')
win.webContents 只读
此窗口拥有的 WebContents 对象。所有网页相关的事件和操作都将通过它完成。
有关其方法和事件，请参阅 webContents 文档。
win.id 只读
一个 Integer 属性，表示窗口的唯一 ID。每个 ID 在整个 Electron 应用程序的所有 BrowserWindow 实例中都是唯一的。
win.tabbingIdentifier macOS 只读
一个 string (可选) 属性，等于传递给 BrowserWindow 构造函数的 tabbingIdentifier，如果未设置，则为 undefined。
win.autoHideMenuBar
一个 boolean 属性，确定窗口菜单栏是否应自动隐藏自身。一旦设置，菜单栏将仅在用户按下单独的 Alt 键时显示。
如果菜单栏已可见，则将此属性设置为 true 不会立即隐藏它。
win.simpleFullScreen
一个 boolean 属性，确定窗口是否处于简单（Lion 之前）全屏模式。
win.fullScreen
一个 boolean 属性，确定窗口是否处于全屏模式。
win.focusable Windows macOS
一个 boolean 属性，确定窗口是否可聚焦。
win.visibleOnAllWorkspaces macOS Linux
一个 boolean 属性，确定窗口是否在所有工作区上可见。
注意： 在 Windows 上始终返回 false。
win.shadow
一个 boolean 属性，确定窗口是否具有阴影。
win.menuBarVisible Windows Linux
一个 boolean 属性，确定菜单栏是否应可见。
注意： 如果菜单栏是自动隐藏的，用户仍然可以通过按单独的 Alt 键来调出菜单栏。
win.kiosk
一个 boolean 属性，确定窗口是否处于 kiosk 模式。
win.documentEdited macOS
一个 boolean 属性，指定窗口的文档是否已被编辑。
当设置为 true 时，标题栏中的图标将变为灰色。
win.representedFilename macOS
一个 string 属性，确定窗口代表的文件的路径名，并且该文件的图标将显示在窗口的标题栏中。
win.title
一个 string 属性，确定原生窗口的标题。
注意： 网页的标题可能与原生窗口的标题不同。
win.minimizable macOS Windows
一个 boolean 属性，确定窗口是否可以由用户手动最小化。
在 Linux 上，setter 是空操作，尽管 getter 返回 true。
win.maximizable macOS Windows
一个 boolean 属性，确定窗口是否可以由用户手动最大化。
在 Linux 上，setter 是空操作，尽管 getter 返回 true。
win.fullScreenable
一个 boolean 属性，确定最大化/缩放窗口按钮是切换全屏模式还是最大化窗口。
win.resizable
一个 boolean 属性，确定窗口是否可以由用户手动调整大小。
win.closable macOS Windows
一个 boolean 属性，确定窗口是否可以由用户手动关闭。
在 Linux 上，setter 是空操作，尽管 getter 返回 true。
win.movable macOS Windows
一个 boolean 属性，确定窗口是否可以由用户移动。
在 Linux 上，setter 是空操作，尽管 getter 返回 true。
win.excludedFromShownWindowsMenu macOS
一个 boolean 属性，确定窗口是否从应用程序的“窗口”菜单中排除。默认为 false。
const win = new BrowserWindow({ height: 600, width: 600 })
const template = [
{
role: 'windowmenu'
}
]
win.excludedFromShownWindowsMenu = true
const menu = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(menu)
win.accessibleTitle
一个 string 属性，定义仅提供给屏幕阅读器等辅助功能工具的替代标题。此字符串对用户不可直接见。
实例方法
使用 new BrowserWindow 创建的对象具有以下实例方法
注意： 某些方法仅在特定的操作系统上可用，并已标记出来。
win.destroy()
强制关闭窗口，网页的 unload 和 beforeunload 事件不会被触发，并且此窗口的 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布尔值
设置窗口是否应处于全屏模式。
注意： 在 macOS 上，全屏转换是异步发生的。如果后续操作依赖于全屏状态，请使用 'enter-full-screen' 或 'leave-full-screen' 事件。
win.isFullScreen()
返回 boolean - 窗口是否处于全屏模式。
注意： 在 macOS 上，全屏转换是异步发生的。当查询 BrowserWindow 的全屏状态时，您应确保已触发 'enter-full-screen' 或 'leave-full-screen' 事件。
win.setSimpleFullScreen(flag) macOS
flag布尔值
进入或退出简单全屏模式。
简单全屏模式模拟 macOS 10.7 (Lion) 之前版本中发现的原生全屏行为。
win.isSimpleFullScreen() macOS
返回 boolean - 窗口是否处于简单（Lion 之前）全屏模式。
win.isNormal()
返回 boolean - 窗口是否处于正常状态（未最大化、未最小化、未处于全屏模式）。
win.setAspectRatio(aspectRatio[, extraSize])
aspectRatio浮点数 - 要为内容视图的某些部分保持的纵横比。extraSizeSize (可选) 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字符串 - 十六进制、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 关键字，但区分大小写。
- 例如
blueviolet或red
- 例如
设置窗口的背景颜色。请参阅 设置 backgroundColor。
win.previewFile(path[, displayName]) macOS
path字符串 - 要使用 QuickLook 预览的文件的绝对路径。这很重要，因为 Quick Look 使用路径上的文件名和文件扩展名来确定要打开的文件的内容类型。displayName字符串 (可选) - 要在 Quick Look 模态视图上显示的文件名。这纯粹是视觉上的，不会影响文件的内容类型。默认为path。
使用 Quick Look 预览给定路径上的文件。
win.closeFilePreview() macOS
关闭当前打开的 Quick Look 面板。
win.setBounds(bounds[, animate])
boundsPartial<Rectangle>animate布尔值 (可选) macOS
调整窗口大小并将其移动到提供的 bounds。任何未提供的属性将默认为其当前值。
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
// 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-40px 之间。传递低于托盘高度的值将导致窗口与托盘齐平。
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])
boundsRectangleanimate布尔值 (可选) macOS
调整窗口的客户端区域（例如，网页）的大小并将其移动到提供的 bounds。
win.getContentBounds()
返回 Rectangle - 窗口客户端区域的 bounds 作为 Object。
win.getNormalBounds()
返回 Rectangle - 包含正常状态的窗口 bounds
注意： 无论窗口的当前状态如何：最大化、最小化或全屏，此函数始终返回窗口在正常状态下的位置和大小。在正常状态下，getBounds 和 getNormalBounds 返回相同的 Rectangle。
win.setEnabled(enable)
enable布尔值
禁用或启用窗口。
win.isEnabled()
返回 boolean - 窗口是否已启用。
win.setSize(width, height[, animate])
width整数height整数animate布尔值 (可选) macOS
将窗口大小调整为 width 和 height。如果 width 或 height 低于任何设置的最小尺寸约束，窗口将捕捉到其最小尺寸。
win.getSize()
返回 Integer[] - 包含窗口的宽度和高度。
win.setContentSize(width, height[, animate])
width整数height整数animate布尔值 (可选) macOS
将窗口的客户端区域（例如，网页）的大小调整为 width 和 height。
win.getContentSize()
返回 Integer[] - 包含窗口客户端区域的宽度和高度。
win.setMinimumSize(width, height)
width整数height整数
将窗口的最小尺寸设置为 width 和 height。
win.getMinimumSize()
返回 Integer[] - 包含窗口的最小宽度和高度。
win.setMaximumSize(width, height)
width整数height整数
将窗口的最大尺寸设置为 width 和 height。
win.getMaximumSize()
返回 Integer[] - 包含窗口的最大宽度和高度。
win.setResizable(resizable)
resizable布尔值
设置窗口是否可以由用户手动调整大小。
win.isResizable()
返回 boolean - 窗口是否可以由用户手动调整大小。
win.setMovable(movable) macOS Windows
movable布尔值
设置窗口是否可以由用户移动。在 Linux 上不执行任何操作。
win.isMovable() macOS Windows
返回 boolean - 窗口是否可以由用户移动。
在 Linux 上始终返回 true。
win.setMinimizable(minimizable) macOS Windows
minimizable布尔值
设置窗口是否可以由用户手动最小化。在 Linux 上不执行任何操作。
win.isMinimizable() macOS Windows
返回 boolean - 窗口是否可以由用户手动最小化。
在 Linux 上始终返回 true。
win.setMaximizable(maximizable) macOS Windows
maximizable布尔值
设置窗口是否可以由用户手动最大化。在 Linux 上不执行任何操作。
win.isMaximizable() macOS Windows
返回 boolean - 窗口是否可以由用户手动最大化。
在 Linux 上始终返回 true。
win.setFullScreenable(fullscreenable)
fullscreenable布尔值
设置最大化/缩放窗口按钮是切换全屏模式还是最大化窗口。
win.isFullScreenable()
返回 boolean - 最大化/缩放窗口按钮是切换全屏模式还是最大化窗口。
win.setClosable(closable) macOS Windows
closable布尔值
设置窗口是否可以由用户手动关闭。在 Linux 上不执行任何操作。
win.isClosable() macOS Windows
返回 boolean - 窗口是否可以由用户手动关闭。
在 Linux 上始终返回 true。
win.setHiddenInMissionControl(hidden) macOS
hidden布尔值
设置当用户切换到 Mission Control 时窗口是否将被隐藏。
win.isHiddenInMissionControl() macOS
返回 boolean - 当用户切换到 Mission Control 时窗口是否将被隐藏。
win.setAlwaysOnTop(flag[, level][, relativeLevel])
flag布尔值level字符串 (可选) macOS Windows - 值包括normal、floating、torn-off-menu、modal-panel、main-menu、status、pop-up-menu、screen-saver和dockflag为 true 时，默认值为floating。当 flag 为 false 时，level将重置为normal。请注意，从floating到包括status，窗口位于 macOS 上的 Dock 下方和 Windows 上的任务栏下方。从pop-up-menu到更高的级别，它显示在 macOS 上的 Dock 上方和 Windows 上的任务栏上方。有关更多详细信息，请参阅 macOS 文档。relativeLevelInteger (可选) macOS - 相对于给定的level，窗口应设置的层级数。 默认为0。 请注意，Apple 不建议将层级设置高于screen-saver之上 1 层。
设置窗口是否应始终显示在其他窗口之上。 设置此项后，窗口仍然是普通窗口，而不是无法聚焦的工具箱窗口。
win.isAlwaysOnTop()
返回 boolean - 窗口是否始终在其他窗口之上。
win.moveAbove(mediaSourceId)
mediaSourceIdstring - 窗口 ID，格式为 DesktopCapturerSource 的 ID。 例如 "window:1869:0"。
将窗口在 Z 轴顺序上移动到源窗口之上。 如果 mediaSourceId 不是窗口类型，或者窗口不存在，则此方法会抛出错误。
win.moveTop()
将窗口移动到顶部（Z 轴顺序），无论焦点如何
win.center()
将窗口移动到屏幕中心。
win.setPosition(x, y[, animate])
xIntegeryIntegeranimate布尔值 (可选) macOS
将窗口移动到 x 和 y 位置。
win.getPosition()
返回 Integer[] - 包含窗口的当前位置。
win.setTitle(title)
titlestring
将原生窗口的标题更改为 title。
win.getTitle()
返回 string - 原生窗口的标题。
注意： 网页的标题可能与原生窗口的标题不同。
win.setSheetOffset(offsetY[, offsetX]) macOS
offsetYFloatoffsetXFloat (可选)
更改 macOS 上工作表的附加点。 默认情况下，工作表附加在窗口框架的正下方，但您可能希望将它们显示在 HTML 渲染的工具栏下方。 例如
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
const toolbarRect = document.getElementById('toolbar').getBoundingClientRect()
win.setSheetOffset(toolbarRect.height)
win.flashFrame(flag)
flag布尔值
开始或停止闪烁窗口以吸引用户注意。
win.setSkipTaskbar(skip) macOS Windows
skipboolean
使窗口不在任务栏中显示。
win.setKiosk(flag)
flag布尔值
进入或退出 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
messageIntegercallbackFunctionwParamBuffer - 提供给 WndProc 的wParamlParamBuffer - 提供给 WndProc 的lParam
钩取 Windows 消息。 当 WndProc 中收到消息时，将调用 callback。
win.isWindowMessageHooked(message) Windows
messageInteger
返回 boolean - true 或 false，取决于消息是否被钩取。
win.unhookWindowMessage(message) Windows
messageInteger
取消钩取窗口消息。
win.unhookAllWindowMessages() Windows
取消钩取所有窗口消息。
win.setRepresentedFilename(filename) macOS
filenamestring
设置窗口代表的文件的路径名，并且文件图标将显示在窗口的标题栏中。
win.getRepresentedFilename() macOS
返回 string - 窗口代表的文件的路径名。
win.setDocumentEdited(edited) macOS
editedboolean
指定窗口的文档是否已被编辑，当设置为 true 时，标题栏中的图标将变为灰色。
win.isDocumentEdited() macOS
返回 boolean - 窗口的文档是否已被编辑。
win.focusOnWebView()
win.blurWebView()
win.capturePage([rect, opts])
rectRectangle (可选) - 要捕获的边界optsObject (可选)stayHiddenboolean (可选) - 保持页面隐藏而不是可见。 默认为false。stayAwakeboolean (可选) - 保持系统唤醒而不是允许其休眠。 默认为false。
返回 Promise<NativeImage> - 使用 NativeImage 解析
捕获 rect 内页面的快照。 省略 rect 将捕获整个可见页面。 如果页面不可见，则 rect 可能为空。 当页面的浏览器窗口隐藏且捕获器计数非零时，该页面被认为是可见的。 如果您希望页面保持隐藏状态，则应确保将 stayHidden 设置为 true。
win.loadURL(url[, options])
urlstring
返回 Promise<void> - 当页面完成加载时，promise 将解析（请参阅 did-finish-load），如果页面加载失败，则拒绝（请参阅 did-fail-load）。
与 webContents.loadURL(url[, options]) 相同。
url 可以是远程地址（例如 http://）或使用 file:// 协议的本地 HTML 文件的路径。
为确保文件 URL 格式正确，建议使用 Node.js 的 url.format 方法
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
const url = require('url').format({
protocol: 'file',
slashes: true,
pathname: require('node:path').join(__dirname, 'index.html')
})
win.loadURL(url)
您可以使用 POST 请求和 URL 编码的数据加载 URL，方法如下
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
win.loadURL('http://localhost:8000/post', {
postData: [{
type: 'rawData',
bytes: Buffer.from('hello=world')
}],
extraHeaders: 'Content-Type: application/x-www-form-urlencoded'
})
win.loadFile(filePath[, options])
filePathstring
返回 Promise<void> - 当页面完成加载时，promise 将解析（请参阅 did-finish-load），如果页面加载失败，则拒绝（请参阅 did-fail-load）。
与 webContents.loadFile 相同，filePath 应该是相对于应用程序根目录的 HTML 文件路径。 有关更多信息，请参阅 webContents 文档。
win.reload()
与 webContents.reload 相同。
win.setMenu(menu) Linux Windows
menuMenu | null
将 menu 设置为窗口的菜单栏。
win.removeMenu() Linux Windows
移除窗口的菜单栏。
win.setProgressBar(progress[, options])
progressDouble
设置进度条中的进度值。 有效范围是 [0, 1.0]。
当 progress < 0 时移除进度条； 当 progress > 1 时更改为不确定模式。
在 Linux 平台上，仅支持 Unity 桌面环境，您需要在 package.json 的 desktopName 字段中指定 *.desktop 文件名。 默认情况下，它将假定为 {app.name}.desktop。
在 Windows 上，可以传递一个模式。 接受的值为 none、normal、indeterminate、error 和 paused。 如果您在未设置模式（但值在有效范围内）的情况下调用 setProgressBar，则将假定为 normal。
win.setOverlayIcon(overlay, description) Windows
overlayNativeImage | null - 要显示在任务栏图标右下角的图标。 如果此参数为null，则会清除覆盖层descriptionstring - 将提供给辅助功能屏幕阅读器的描述
在当前任务栏图标上设置一个 16 x 16 像素的覆盖图标，通常用于传达某种应用程序状态或被动地通知用户。
win.invalidateShadow() macOS
使窗口阴影无效，以便根据当前的窗口形状重新计算。
透明的 BrowserWindows 有时会在 macOS 上留下视觉伪影。 例如，在执行动画时，可以使用此方法清除这些伪影。
win.setHasShadow(hasShadow)
hasShadowboolean
设置窗口是否应具有阴影。
win.hasShadow()
返回 boolean - 窗口是否具有阴影。
win.setOpacity(opacity) Windows macOS
opacitynumber - 介于 0.0（完全透明）和 1.0（完全不透明）之间
设置窗口的不透明度。 在 Linux 上，不起作用。 超出范围的数字值将被限制在 [0, 1] 范围内。
win.getOpacity()
返回 number - 介于 0.0（完全透明）和 1.0（完全不透明）之间。 在 Linux 上，始终返回 1。
win.setShape(rects) Windows Linux Experimental
rectsRectangle[] - 在窗口上设置形状。 传递空列表会将窗口恢复为矩形。
设置窗口形状确定了系统允许在窗口内进行绘制和用户交互的区域。 在给定区域之外，不会绘制任何像素，也不会注册任何鼠标事件。 区域外部的鼠标事件不会被该窗口接收，而是会传递到窗口后面的任何内容。
win.setThumbarButtons(buttons) Windows
buttonsThumbarButton[]
返回 boolean - 按钮是否成功添加
在任务栏按钮布局中，向窗口的缩略图图像添加带有指定按钮集的缩略图工具栏。 返回一个 boolean 对象，指示是否已成功添加缩略图。
由于空间有限，缩略图工具栏中的按钮数量不应超过 7 个。 设置缩略图工具栏后，由于平台的限制，无法移除该工具栏。 但是，您可以调用带有空数组的 API 来清除按钮。
buttons 是 Button 对象的数组
Button对象iconNativeImage - 缩略图工具栏中显示的图标。clickFunctiontooltipstring (可选) - 按钮工具提示的文本。flagsstring[] (可选) - 控制按钮的特定状态和行为。 默认情况下，它是['enabled']。
flags 是一个数组，可以包含以下 string
enabled- 按钮处于活动状态，用户可以使用。disabled- 按钮被禁用。 它存在，但具有指示它不会响应用户操作的视觉状态。dismissonclick- 单击按钮后，缩略图窗口立即关闭。nobackground- 不绘制按钮边框，仅使用图像。hidden- 按钮不向用户显示。noninteractive- 按钮已启用但不交互； 不绘制按下按钮状态。 此值适用于按钮用于通知的情况。
win.setThumbnailClip(region) Windows
regionRectangle - 窗口区域
设置窗口的区域，以显示为在任务栏中将鼠标悬停在窗口上时显示的缩略图图像。 您可以通过指定空区域来将缩略图重置为整个窗口： { x: 0, y: 0, width: 0, height: 0 }。
win.setThumbnailToolTip(toolTip) Windows
toolTipstring
设置当鼠标悬停在任务栏中的窗口缩略图上时显示的工具提示。
win.setAppDetails(options) Windows
设置窗口的任务栏按钮的属性。
注意： relaunchCommand 和 relaunchDisplayName 必须始终一起设置。 如果未设置其中一个属性，则两者都不会使用。
win.showDefinitionForSelection() macOS
与 webContents.showDefinitionForSelection() 相同。
win.setIcon(icon) Windows Linux
iconNativeImage | string
更改窗口图标。
win.setWindowButtonVisibility(visible) macOS
visibleboolean
设置窗口的交通灯按钮是否应可见。
win.setAutoHideMenuBar(hide) Windows Linux
hideboolean
设置窗口菜单栏是否应自动隐藏。 设置后，菜单栏仅在用户按下 Alt 键时显示。
如果菜单栏已可见，则调用 setAutoHideMenuBar(true) 不会立即隐藏它。
win.isMenuBarAutoHide() Windows Linux
返回 boolean - 菜单栏是否自动隐藏。
win.setMenuBarVisibility(visible) Windows Linux
visibleboolean
设置菜单栏是否应可见。 如果菜单栏是自动隐藏的，则用户仍然可以通过按 Alt 键来调出菜单栏。
win.isMenuBarVisible() Windows Linux
返回 boolean - 菜单栏是否可见。
win.setVisibleOnAllWorkspaces(visible[, options]) macOS Linux
visibleboolean
设置窗口是否应在所有工作区中可见。
注意： 此 API 在 Windows 上不起作用。
win.isVisibleOnAllWorkspaces() macOS Linux
返回 boolean - 窗口是否在所有工作区中可见。
注意： 此 API 在 Windows 上始终返回 false。
win.setIgnoreMouseEvents(ignore[, options])
ignoreboolean
使窗口忽略所有鼠标事件。
在此窗口中发生的所有鼠标事件都将传递到此窗口下方的窗口，但如果此窗口具有焦点，它仍将接收键盘事件。
win.setContentProtection(enable) macOS Windows
enable布尔值
阻止窗口内容被其他应用程序捕获。
在 macOS 上，它将 NSWindow 的 sharingType 设置为 NSWindowSharingNone。 在 Windows 上，它使用 WDA_EXCLUDEFROMCAPTURE 调用 SetWindowDisplayAffinity。 对于 Windows 10 版本 2004 及更高版本，窗口将从捕获中完全移除，旧版本的 Windows 的行为类似于应用了 WDA_MONITOR，捕获的是黑色窗口。
win.setFocusable(focusable) macOS Windows
focusableboolean
更改窗口是否可以被聚焦。
在 macOS 上，它不会从窗口中移除焦点。
win.isFocusable() macOS Windows
返回 boolean - 窗口是否可以被聚焦。
win.setParentWindow(parent)
parentBrowserWindow | null
将 parent 设置为当前窗口的父窗口，传递 null 将使当前窗口变为顶层窗口。
win.getParentWindow()
返回 BrowserWindow | null - 父窗口；如果没有父窗口，则返回 null。
win.getChildWindows()
返回 BrowserWindow[] - 所有子窗口。
win.setAutoHideCursor(autoHide) macOS
autoHideboolean
控制在键入时是否隐藏光标。
win.selectPreviousTab() macOS
当启用原生标签页并且窗口中有其他标签页时，选择上一个标签页。
win.selectNextTab() macOS
当启用原生标签页并且窗口中有其他标签页时，选择下一个标签页。
win.showAllTabs() macOS
当启用原生标签页时，显示或隐藏标签页概览。
win.mergeAllWindows() macOS
当启用原生标签页且存在多个打开的窗口时，将所有窗口合并为一个包含多个标签页的窗口。
win.moveTabToNewWindow() macOS
如果启用了原生标签页且当前窗口中存在多个标签页，则将当前标签页移动到新窗口。
win.toggleTabBar() macOS
如果启用了原生标签页且当前窗口中只有一个标签页，则切换标签栏的可见性。
win.addTabbedWindow(browserWindow) macOS
browserWindowBrowserWindow
在此窗口上，将一个窗口添加为标签页，位于窗口实例的标签页之后。
win.setVibrancy(type[, options]) macOS
typestring | null - 可以是titlebar、selection、menu、popover、sidebar、header、sheet、window、hud、fullscreen-ui、tooltip、content、under-window或under-page。 详见 macOS 文档了解更多细节。
为浏览器窗口添加活力效果。 传递 null 或空字符串将移除窗口上的活力效果。 animationDuration 参数仅对活力效果的淡入或淡出进行动画处理。 不支持在不同类型的活力效果之间进行动画处理。
win.setBackgroundMaterial(material) Windows
materialstringauto- 让桌面窗口管理器 (DWM) 自动决定此窗口的系统绘制的背景材料。 这是默认设置。none- 不绘制任何系统背景。mica- 绘制与持久窗口对应的背景材料效果。acrylic- 绘制与瞬态窗口对应的背景材料效果。tabbed- 绘制与带有标签页式标题栏的窗口对应的背景材料效果。
此方法设置浏览器窗口的系统绘制的背景材料，包括非客户端区域的后面。
详见 Windows 文档了解更多细节。
注意： 此方法仅在 Windows 11 22H2 及更高版本上受支持。
win.setWindowButtonPosition(position) macOS
positionPoint | null
为无边框窗口中的红绿灯按钮设置自定义位置。 传递 null 将位置重置为默认值。
win.getWindowButtonPosition() macOS
返回 Point | null - 无边框窗口中红绿灯按钮的自定义位置，当没有自定义位置时将返回 null。
win.setTouchBar(touchBar) macOS
touchBarTouchBar | null
为当前窗口设置 touchBar 布局。 指定 null 或 undefined 会清除 touch bar。 此方法仅在机器具有 touch bar 时才有效。
注意： TouchBar API 目前处于实验阶段，可能会在未来的 Electron 版本中更改或删除。
win.setBrowserView(browserView) Experimental Deprecated
browserViewBrowserView | null - 将browserView附加到win。 如果附加了其他BrowserView，它们将从此窗口中移除。
注意
BrowserView类已被弃用，并由新的WebContentsView类取代。
win.getBrowserView() Experimental Deprecated
返回 BrowserView | null - 附加到 win 的 BrowserView。 如果未附加，则返回 null。 如果附加了多个 BrowserView，则抛出错误。
注意
BrowserView类已被弃用，并由新的WebContentsView类取代。
win.addBrowserView(browserView) Experimental Deprecated
browserViewBrowserView
用于 setBrowserView 的替代 API，支持使用多个浏览器视图。
注意
BrowserView类已被弃用，并由新的WebContentsView类取代。
win.removeBrowserView(browserView) Experimental Deprecated
browserViewBrowserView
注意
BrowserView类已被弃用，并由新的WebContentsView类取代。
win.setTopBrowserView(browserView) Experimental Deprecated
browserViewBrowserView
将 browserView 提升到附加到 win 的其他 BrowserView 之上。 如果 browserView 未附加到 win，则抛出错误。
注意
BrowserView类已被弃用，并由新的WebContentsView类取代。
win.getBrowserViews() Experimental Deprecated
返回 BrowserView[] - 一个按 z-index 排序的所有 BrowserView 的数组，这些 BrowserView 已使用 addBrowserView 或 setBrowserView 附加。 最顶层的 BrowserView 是数组的最后一个元素。
注意
BrowserView类已被弃用，并由新的WebContentsView类取代。
win.setTitleBarOverlay(options) Windows Linux
在已启用窗口控件叠加层的窗口上，此方法更新标题栏叠加层的样式。
在 Linux 上，如果未显式设置 `symbolColor`，则会自动计算 `symbolColor`，使其与 `color` 具有最小的可访问对比度。