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()
子窗口将始终显示在父窗口的上方。
模态窗口
模态窗口是禁用父窗口的子窗口。 要创建模态窗口，您必须同时设置 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()
})
页面可见性
页面可见性 API 的工作原理如下：
- 在所有平台上，可见性状态跟踪窗口是否隐藏/最小化。
- 此外，在 macOS 上，可见性状态还跟踪窗口的遮挡状态。 如果窗口被另一个窗口遮挡 (即完全覆盖)，则可见性状态将为
hidden。 在其他平台上，仅当窗口最小化或通过win.hide()明确隐藏时，可见性状态才会为hidden。 - 如果使用
show: false创建BrowserWindow，即使窗口实际处于隐藏状态，初始可见性状态也将为visible。 - 如果禁用
backgroundThrottling，即使窗口被最小化、遮挡或隐藏，可见性状态也将保持visible。
建议您在可见性状态为 hidden 时暂停耗费资源的操作，以最大程度地降低功耗。
平台注意事项
- 在 macOS 上，模态窗口将作为附在父窗口上的表单显示。
- 在 macOS 上，当父窗口移动时，子窗口将保持与父窗口的相对位置，而在 Windows 和 Linux 上，子窗口将不会移动。
- 在 Linux 上，模态窗口的类型将更改为
dialog。 - 在 Linux 上，许多桌面环境不支持隐藏模态窗口。
类：BrowserWindow 继承自 BaseWindow
创建和控制浏览器窗口。
进程：主进程
BrowserWindow 是一个 EventEmitter。
它创建一个新的 BrowserWindow，并根据 options 设置原生属性。
Electron 的内置类不能在用户代码中进行子类化。 有关更多信息，请参阅 常见问题。
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
返回
eventEventdirectionstring
在三指轻扫时触发。 可能的方向是 up、right、down、left。
此事件的基础方法旨在处理旧版 macOS 风格的触控板轻扫，即屏幕上的内容不随轻扫而移动。 大多数 macOS 触控板现在不再配置为允许这种轻扫，因此为了使其正常触发，必须将 System Preferences > Trackpad > More Gestures 中的“在页面之间轻扫”偏好设置设置为“用两指或三指轻扫”。
事件：'rotate-gesture' macOS
返回
eventEventrotationFloat
在触控板旋转手势时触发。 持续触发直到旋转手势结束。 每次触发时的 rotation 值是自上次触发以来旋转的角度 (以度为单位)。 旋转手势的最后一次触发事件的值始终为 0。 逆时针旋转值为正，顺时针旋转值为负。
事件：'sheet-begin' macOS
当窗口打开一个表单时触发。
事件：'sheet-end' macOS
当窗口关闭一个表单时触发。
事件：'new-window-for-tab' macOS
当点击原生新标签页按钮时触发。
事件：'system-context-menu' Windows Linux
返回
eventEventpointPoint - 触发上下文菜单的屏幕坐标。
当在窗口上触发系统上下文菜单时触发，这通常仅在用户右键单击窗口的非客户区时触发。 这指的是窗口标题栏或在无边框窗口中您声明为 -webkit-app-region: drag 的任何区域。
调用 event.preventDefault() 将阻止菜单显示。
要将 point 转换为 DIP，请使用 screen.screenToDipPoint(point)。
静态方法
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)
idInteger
返回 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 Linux Windows
一个 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 属性，它决定窗口是否处于信息亭模式。
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 属性，它定义了一个仅提供给屏幕阅读器等辅助工具的替代标题。 此字符串用户不可直接见。
win.snapped Windows 只读
一个 boolean 属性，它指示窗口是否通过 对齐窗口 进行排列。
实例方法
使用 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)
flagboolean
设置窗口是否应处于全屏模式。
在 macOS 上，全屏转换是异步进行的。 如果后续操作依赖于全屏状态，请使用 'enter-full-screen' 或 'leave-full-screen' 事件。
win.isFullScreen()
返回 boolean - 窗口是否处于全屏模式。
在 macOS 上，全屏转换是异步进行的。 在查询 BrowserWindow 的全屏状态时，您应该确保 'enter-full-screen' 或 'leave-full-screen' 事件已经触发。
win.setSimpleFullScreen(flag) macOS
flagboolean
进入或退出简单全屏模式。
简单全屏模式模拟了 macOS Lion (10.7) 之前版本中原生的全屏行为。
win.isSimpleFullScreen() macOS
返回 boolean - 窗口是否处于简单 (Lion 之前) 全屏模式。
win.isNormal()
返回 boolean - 窗口是否处于正常状态 (未最大化、未最小化、未处于全屏模式)。
win.setAspectRatio(aspectRatio[, extraSize])
aspectRatioFloat - 内容视图部分要保持的宽高比。extraSizeSize (可选) macOS - 在保持宽高比时不包括的额外大小。
这将使窗口保持宽高比。 额外大小允许开发者拥有不包含在宽高比计算中的空间 (以像素为单位)。 此 API 已经考虑了窗口大小和其内容大小之间的差异。
考虑一个带有高清视频播放器和相关控件的普通窗口。 也许在左边缘有 15 像素的控件，右边缘有 25 像素的控件，播放器下方有 50 像素的控件。 为了在播放器本身内保持 16:9 的宽高比 (高清标准宽高比 @1920x1080)，我们将使用 16/9 和 { width: 40, height: 50 } 作为参数调用此函数。 第二个参数不关心内容视图中的额外宽度和高度在哪里——只关心它们是否存在。 将内容视图中的所有额外宽度和高度区域相加。
当使用 win.setSize 等 API 以编程方式调整窗口大小时，宽高比将不被遵守。
要重置宽高比，请将 aspectRatio 值设置为 0：win.setAspectRatio(0)。
win.setBackgroundColor(backgroundColor)
backgroundColorstring - 十六进制、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
调整窗口大小并将其移动到提供的边界。任何未提供的属性将默认为其当前值。
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 坐标值不能小于 任务栏托盘 高度。任务栏托盘高度随时间变化并取决于操作系统，但通常在 20-40px 之间。传递小于任务栏托盘高度的值将导致窗口与任务栏托盘齐平。
win.getBounds()
返回 Rectangle - 窗口的 bounds (边界) 作为 Object。
在 macOS 上，返回的 y 坐标值将至少是 任务栏托盘 高度。例如，当任务栏托盘高度为 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
调整窗口的客户端区域（例如网页）大小并将其移动到提供的边界。
win.getContentBounds()
返回 Rectangle - 窗口客户端区域的 bounds (边界) 作为 Object。
win.getNormalBounds()
返回 Rectangle - 包含正常状态下窗口的边界。
无论窗口当前处于何种状态（最大化、最小化或全屏），此函数始终返回窗口在正常状态下的位置和大小。在正常状态下，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布尔值
设置当用户切换到“任务控制”时，窗口是否会被隐藏。
win.isHiddenInMissionControl() macOS
返回 boolean - 当用户切换到“任务控制”时，窗口是否会被隐藏。
win.setAlwaysOnTop(flag[, level][, relativeLevel])
flagbooleanlevel字符串 (可选) 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 文档。relativeLevel整数 (可选) macOS - 相对于给定level，将此窗口设置高出多少层。默认值为0。请注意，Apple 不鼓励将级别设置得比screen-saver高 1 以上。
设置窗口是否应始终显示在其他窗口的顶部。设置此项后，窗口仍是普通窗口，而不是无法获得焦点的工具箱窗口。
win.isAlwaysOnTop()
返回 boolean - 窗口是否始终位于其他窗口的顶部。
win.moveAbove(mediaSourceId)
mediaSourceId字符串 - 窗口 ID，格式为 DesktopCapturerSource 的 ID。例如 "window:1869:0"。
将窗口在 Z 轴顺序上移动到源窗口上方。如果 mediaSourceId 不是窗口类型，或者窗口不存在，则此方法会抛出错误。
win.moveTop()
将窗口移动到最顶部 (Z 轴顺序)，无论是否获得焦点。
win.center()
将窗口移动到屏幕中心。
win.setPosition(x, y[, animate])
x整数y整数animate布尔值 (可选) macOS
将窗口移动到 x 和 y。
win.getPosition()
返回 Integer[] - 包含窗口的当前位置。
win.setTitle(title)
titlestring
将原生窗口的标题更改为 title。
win.getTitle()
返回 string - 原生窗口的标题。
网页的标题可以与原生窗口的标题不同。
win.setSheetOffset(offsetY[, offsetX]) macOS
offsetY浮点数offsetX浮点数 (可选)
更改 macOS 上工作表的附加点。默认情况下，工作表附加在窗口框架正下方，但您可能希望将它们显示在 HTML 渲染的工具栏下方。例如
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
const toolbarRect = document.getElementById('toolbar').getBoundingClientRect()
win.setSheetOffset(toolbarRect.height)
win.flashFrame(flag)
flagboolean
开始或停止闪烁窗口以吸引用户注意。
win.setSkipTaskbar(skip) macOS Windows
skip布尔值
使窗口不在任务栏中显示。
win.setKiosk(flag)
flagboolean
进入或退出全屏触摸屏模式 (kiosk mode)。
win.isKiosk()
返回 boolean - 窗口是否处于全屏触摸屏模式 (kiosk mode)。
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函数wParamBuffer - 提供给 WndProc 的wParamlParamBuffer - 提供给 WndProc 的lParam
挂钩 Windows 消息。当 WndProc 接收到消息时，将调用 callback。
win.isWindowMessageHooked(message) Windows
message整数
返回 boolean - 根据消息是否被挂钩返回 true 或 false。
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.focusOnWebView()
win.blurWebView()
win.capturePage([rect, opts])
rectRectangle (可选) - 要捕获的边界optsObject (可选)stayHidden布尔值 (可选) - 保持页面隐藏而不是可见。默认为false。stayAwake布尔值 (可选) - 保持系统唤醒而不是允许其睡眠。默认为false。
返回 Promise<NativeImage> - 解析为 NativeImage
捕获 rect 内页面的快照。省略 rect 将捕获整个可见页面。如果页面不可见，rect 可能为空。当其浏览器窗口隐藏且捕获器计数非零时，页面被视为可见。如果您希望页面保持隐藏状态，应确保 stayHidden 设置为 true。
win.loadURL(url[, options])
url字符串
返回 Promise<void> - 当页面完成加载时（参见 did-finish-load），Promise 将解析，如果页面加载失败（参见 did-fail-load），则拒绝。
与 webContents.loadURL(url[, options]) 相同。
url 可以是远程地址（例如 http://），也可以是使用 file:// 协议的本地 HTML 文件路径。
为确保文件 URL 格式正确，建议使用 Node 的 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('https://:8000/post', {
postData: [{
type: 'rawData',
bytes: Buffer.from('hello=world')
}],
extraHeaders: 'Content-Type: application/x-www-form-urlencoded'
})
win.loadFile(filePath[, options])
filePath字符串
返回 Promise<void> - 当页面完成加载时（参见 did-finish-load），Promise 将解析，如果页面加载失败（参见 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])
progress双精度浮点数
设置进度条中的进度值。有效范围是 [0, 1.0]。
当进度 < 0 时移除进度条；当进度 > 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，则清除覆盖层。description字符串 - 将提供给辅助功能屏幕阅读器的描述。
在当前任务栏图标上设置一个 16 x 16 像素的叠加层，通常用于传达某种应用程序状态或被动通知用户。
win.invalidateShadow() macOS
使窗口阴影失效，以便根据当前窗口形状重新计算。
透明的 BrowserWindows 有时会在 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 实验性
rectsRectangle[] - 在窗口上设置形状。传入空列表将使窗口恢复为矩形。
设置窗口形状决定了系统允许绘图和用户交互的窗口区域。在给定区域之外，将不会绘制任何像素，也不会注册任何鼠标事件。区域外的鼠标事件将不会被该窗口接收，而是会穿透到窗口后面的内容。
win.setThumbarButtons(buttons) Windows
buttonsThumbarButton[]
返回 boolean - 按钮是否成功添加。
将指定的一组按钮添加到任务栏按钮布局中窗口的缩略图图像的缩略图工具栏。返回一个 boolean 对象，指示缩略图是否已成功添加。
由于空间限制，缩略图工具栏中的按钮数量不应超过 7 个。一旦设置了缩略图工具栏，由于平台限制，该工具栏无法被移除。但是，您可以调用 API 并传入空数组来清除按钮。
buttons 是 Button 对象的数组。
Button对象iconNativeImage - 显示在缩略图工具栏中的图标。click函数tooltip字符串 (可选) - 按钮工具提示的文本。flags字符串数组 (可选) - 控制按钮的特定状态和行为。默认情况下，它是['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
toolTip字符串
设置当鼠标悬停在任务栏中的窗口缩略图上时显示的工具提示。
win.setAppDetails(options) Windows
设置窗口任务栏按钮的属性。
relaunchCommand 和 relaunchDisplayName 必须始终一起设置。如果其中一个属性未设置，则两者都不会使用。
win.showDefinitionForSelection() macOS
与 webContents.showDefinitionForSelection() 相同。
win.setIcon(icon) Windows Linux
iconNativeImage | string
更改窗口图标。
win.setWindowButtonVisibility(visible) macOS
visible布尔值
设置窗口的红绿灯按钮是否可见。
win.setAutoHideMenuBar(hide) Windows Linux
hide布尔值
设置窗口菜单栏是否应自动隐藏。一旦设置，菜单栏只有在用户按下 Alt 键时才会显示。
如果菜单栏已经可见，调用 setAutoHideMenuBar(true) 不会立即将其隐藏。
win.isMenuBarAutoHide() Windows Linux
返回 boolean - 菜单栏是否自动隐藏。
win.setMenuBarVisibility(visible) Windows Linux
visible布尔值
设置菜单栏是否可见。如果菜单栏是自动隐藏的，用户仍然可以通过按下 Alt 键来调出菜单栏。
win.isMenuBarVisible() Windows Linux
返回 boolean - 菜单栏是否可见。
win.isSnapped() Windows
返回 boolean - 窗口是否通过 分屏辅助 排列。
窗口通过鼠标悬停在窗口最大化按钮上时显示的按钮，或通过将其拖动到屏幕边缘来分屏。
win.setVisibleOnAllWorkspaces(visible[, options]) macOS Linux
visible布尔值
设置窗口是否应在所有工作区中可见。
此 API 在 Windows 上不起作用。
win.isVisibleOnAllWorkspaces() macOS Linux
返回 boolean - 窗口是否在所有工作区中可见。
此 API 在 Windows 上始终返回 false。
win.setIgnoreMouseEvents(ignore[, options])
ignore布尔值
使窗口忽略所有鼠标事件。
发生在此窗口中的所有鼠标事件都将传递给此窗口下方的窗口，但如果此窗口具有焦点，它仍将接收键盘事件。
win.setContentProtection(enable) macOS Windows
enable布尔值
防止窗口内容被其他应用程序捕获。
在 macOS 上，它将 NSWindow 的 sharingType 设置为 NSWindowSharingNone。在 Windows 上，它调用 SetWindowDisplayAffinity 并使用 WDA_EXCLUDEFROMCAPTURE。对于 Windows 10 版本 2004 及更高版本，窗口将完全从捕获中移除，较旧的 Windows 版本表现为应用了 WDA_MONITOR，捕获一个黑色窗口。
win.isContentProtected() macOS Windows
返回 boolean - 内容保护是否当前已启用。
win.setFocusable(focusable) macOS Windows
focusable布尔值
更改窗口是否可以获得焦点。
在 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
autoHide布尔值
控制打字时是否隐藏光标。
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
type字符串 | 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
material字符串auto- 让桌面窗口管理器 (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
为当前窗口设置触控栏布局。指定 null 或 undefined 将清除触控栏。此方法仅在机器具有触控栏时才有效。
TouchBar API 目前是实验性的，未来 Electron 版本中可能会更改或移除。
win.setBrowserView(browserView) 实验性 已废弃
browserViewBrowserView | null - 将browserView附加到win。如果已附加其他BrowserView，它们将从该窗口中移除。
BrowserView 类已弃用，并由新的 WebContentsView 类取代。
win.getBrowserView() 实验性 已废弃
返回 BrowserView | null - 附加到 win 的 BrowserView。如果未附加，则返回 null。如果附加了多个 BrowserView，则抛出错误。
BrowserView 类已弃用，并由新的 WebContentsView 类取代。
win.addBrowserView(browserView) 实验性 已废弃
browserViewBrowserView
用于 setBrowserView 的替代 API，支持多浏览器视图工作。
BrowserView 类已弃用，并由新的 WebContentsView 类取代。
win.removeBrowserView(browserView) 实验性 已废弃
browserViewBrowserView
BrowserView 类已弃用，并由新的 WebContentsView 类取代。
win.setTopBrowserView(browserView) 实验性 已废弃
browserViewBrowserView
将 browserView 提升到附加到 win 的其他 BrowserView 之上。如果 browserView 未附加到 win，则抛出错误。
BrowserView 类已弃用，并由新的 WebContentsView 类取代。
win.getBrowserViews() 实验性 已废弃
返回 BrowserView[] - 一个按 Z 轴索引排序的所有通过 addBrowserView 或 setBrowserView 附加的 BrowserView 数组。最顶层的 BrowserView 是数组的最后一个元素。
BrowserView 类已弃用，并由新的 WebContentsView 类取代。
win.setTitleBarOverlay(options) Windows Linux
对于已启用窗口控制叠加层的窗口，此方法会更新标题栏叠加层的样式。
在 Linux 上，如果未明确设置，symbolColor 会自动计算以与 color 具有最小可访问对比度。