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()
})
页面可见性
页面可见性 API 的工作原理如下。
- 在所有平台上，可见性状态都会跟踪窗口是否隐藏/最小化。
- 此外，在 macOS 上，可见性状态还会跟踪窗口遮挡状态。如果窗口被另一个窗口完全遮挡，则可见性状态将为
hidden。在其他平台上，只有当窗口最小化或使用win.hide()显式隐藏时，可见性状态才会为hidden。 - 如果使用
show: false创建BrowserWindow，则初始可见性状态将为visible，尽管窗口实际上是隐藏的。 - 如果禁用
backgroundThrottling，即使窗口最小化、遮挡或隐藏，可见性状态也将保持visible。
建议您在可见性状态为 hidden 时暂停耗时的操作，以最大程度地减少功耗。
平台说明
- 在 macOS 上，模态窗口将显示为附加到父窗口的表单。
- 在 macOS 上，当父窗口移动时，子窗口将保持与父窗口的相对位置，而在 Windows 和 Linux 上，子窗口将不会移动。
- 在 Linux 上，模态窗口的类型将更改为
dialog。 - 在 Linux 上，许多桌面环境不支持隐藏模态窗口。
类：BrowserWindow 扩展 BaseWindow
创建和控制浏览器窗口。
进程：主进程
BrowserWindow 是一个EventEmitter。
它使用 options 设置的本机属性创建一个新的 BrowserWindow。
new BrowserWindow([options])
实例事件
使用 new BrowserWindow 创建的对象会发出以下事件
注意：某些事件仅在特定操作系统上可用，并已标注。
事件：'page-title-updated'
返回值
event事件title字符串explicitSet布尔值
当文档更改其标题时发出，调用 event.preventDefault() 将阻止本机窗口标题更改。当标题从文件 URL 合成时，explicitSet 为 false。
事件：'close'
返回值
event事件
当窗口即将关闭时发出。它在 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'
当窗口关闭时发出。收到此事件后，您应删除对窗口的引用并避免进一步使用它。
事件：'session-end' Windows
由于强制关机或机器重启或会话注销而导致窗口会话即将结束时发出。
事件：'unresponsive'
当网页变得无响应时发出。
事件：'responsive'
当无响应的网页再次变得响应时发出。
事件：'blur'
当窗口失去焦点时发出。
事件：'focus'
当窗口获得焦点时发出。
事件：'show'
当窗口显示时发出。
事件：'hide'
当窗口隐藏时发出。
事件：'ready-to-show'
当网页已渲染（但未显示）并且窗口可以在没有视觉闪烁的情况下显示时发出。
请注意，使用此事件意味着即使 show 为 false，渲染器也将被视为“可见”并进行绘制。如果您使用 paintWhenInitiallyHidden: false，则此事件将永远不会触发。
事件：'maximize'
当窗口最大化时发出。
事件：'unmaximize'
当窗口退出最大化状态时发出。
事件：'minimize'
当窗口最小化时发出。
事件：'restore'
当窗口从最小化状态恢复时发出。
事件：'will-resize' macOS Windows
返回值
event事件newBounds矩形 - 窗口正在调整到的尺寸。details对象edge（字符串） - 正在拖动以调整大小的窗口边缘。可以是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
返回值
event事件newBounds矩形 - 窗口将要移动到的位置。
窗口移动之前发出。在 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'
返回值
event事件isAlwaysOnTop布尔值
当窗口设置为始终显示在其他窗口的顶部或取消此设置时发出。
事件: 'app-command' Windows Linux
返回值
event事件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
返回值
event事件direction字符串
在三指滑动时发出。可能的方向为up、right、down、left。
此事件的基础方法旨在处理旧版 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点 - 触发上下文菜单的屏幕坐标
当在窗口上触发系统上下文菜单时发出，这通常仅在用户右键单击窗口的非客户端区域时触发。这是窗口标题栏或您在无边框窗口中声明为-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 只读
表示窗口唯一 ID 的整数属性。每个 ID 在整个 Electron 应用程序的所有BrowserWindow实例中都是唯一的。
win.tabbingIdentifier macOS 只读
一个字符串（可选）属性，等于传递给BrowserWindow构造函数的tabbingIdentifier，如果没有设置，则为undefined。
win.autoHideMenuBar
一个布尔值属性，确定窗口菜单栏是否应自动隐藏自身。设置后，菜单栏仅在用户按下单个Alt键时显示。
如果菜单栏已可见，则将其属性设置为true不会立即隐藏它。
win.simpleFullScreen
一个布尔值属性，确定窗口是否处于简单（Lion 之前的）全屏模式。
win.fullScreen
一个布尔值属性，确定窗口是否处于全屏模式。
win.focusable Windows macOS
一个布尔值属性，确定窗口是否可聚焦。
win.visibleOnAllWorkspaces macOS Linux
一个布尔值属性，确定窗口是否在所有工作区中可见。
注意：在 Windows 上始终返回 false。
win.shadow
一个布尔值属性，确定窗口是否具有阴影。
win.menuBarVisible Windows Linux
一个布尔值属性，确定菜单栏是否应可见。
注意：如果菜单栏是自动隐藏的，用户仍然可以通过按下单个Alt键调出菜单栏。
win.kiosk
一个 boolean 类型的属性，用于确定窗口是否处于 Kiosk 模式。
win.documentEdited macOS
一个 boolean 类型的属性，用于指定窗口的文档是否已被编辑。
当设置为 true 时，标题栏中的图标将变灰。
win.representedFilename macOS
一个 string 类型的属性，用于确定窗口表示的文件的路径名，并且文件图标将显示在窗口的标题栏中。
win.title
一个 string 类型的属性，用于确定原生窗口的标题。
注意：网页的标题可能与原生窗口的标题不同。
win.minimizable macOS Windows
一个 boolean 类型的属性，用于确定窗口是否可以被用户手动最小化。
在 Linux 上，设置器不起作用，尽管获取器返回 true。
win.maximizable macOS Windows
一个 boolean 类型的属性，用于确定窗口是否可以被用户手动最大化。
在 Linux 上，设置器不起作用，尽管获取器返回 true。
win.fullScreenable
一个 boolean 类型的属性，用于确定最大化/缩放窗口按钮是切换全屏模式还是最大化窗口。
win.resizable
一个 boolean 类型的属性，用于确定窗口是否可以被用户手动调整大小。
win.closable macOS Windows
一个 boolean 类型的属性，用于确定窗口是否可以被用户手动关闭。
在 Linux 上，设置器不起作用，尽管获取器返回 true。
win.movable macOS Windows
一个 boolean 类型的属性，用于确定窗口是否可以被用户移动。
在 Linux 上，设置器不起作用，尽管获取器返回 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)
flagboolean
设置窗口是否应处于全屏模式。
注意：在 macOS 上，全屏转换异步进行。如果后续操作依赖于全屏状态，请使用 'enter-full-screen' 或 'leave-full-screen' 事件。
win.isFullScreen()
返回 boolean - 窗口是否处于全屏模式。
注意：在 macOS 上，全屏转换异步进行。当查询 BrowserWindow 的全屏状态时，应确保已发出 'enter-full-screen' 或 'leave-full-screen' 事件。
win.setSimpleFullScreen(flag) macOS
flagboolean
进入或退出简单全屏模式。
简单全屏模式模拟了 Lion (10.7) 之前版本的 macOS 中找到的原生全屏行为。
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 以编程方式调整窗口大小时，不会尊重纵横比。
要重置纵横比，请将 0 作为 aspectRatio 值传递：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 颜色模块级别 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<矩形>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-40 像素之间。传递小于托盘高度的值会导致窗口与托盘齐平。
win.getBounds()
返回 矩形 - 窗口的 bounds 作为 Object。
注意：在 macOS 上，返回的 y 坐标值至少为 托盘 高度。例如，调用 win.setBounds({ x: 25, y: 20, width: 800, height: 600 }) 且托盘高度为 38，则 win.getBounds() 将返回 { x: 25, y: 38, width: 800, height: 600 }。
win.getBackgroundColor()
返回 字符串 - 以十六进制 (#RRGGBB) 格式获取窗口的背景颜色。
请参阅 设置 backgroundColor。
注意：alpha 值不会与红色、绿色和蓝色值一起返回。
win.setContentBounds(bounds[, animate])
bounds矩形animate布尔值（可选） macOS
调整窗口的客户区（例如网页）大小并将其移动到提供的边界。
win.getContentBounds()
返回 矩形 - 窗口客户区的 bounds 作为 Object。
win.getNormalBounds()
返回 矩形 - 包含正常状态的窗口边界
注意：无论窗口的当前状态是最大化、最小化还是全屏，此函数始终返回窗口在正常状态下的位置和大小。在正常状态下，getBounds 和 getNormalBounds 返回相同的 矩形。
win.setEnabled(enable)
enable布尔值
禁用或启用窗口。
win.isEnabled()
返回 布尔值 - 窗口是否已启用。
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()
返回 布尔值 - 用户是否可以手动调整窗口大小。
win.setMovable(movable) macOS Windows
movable布尔值
设置用户是否可以移动窗口。在 Linux 上不起作用。
win.isMovable() macOS Windows
返回 布尔值 - 用户是否可以移动窗口。
在 Linux 上始终返回 true。
win.setMinimizable(minimizable) macOS Windows
minimizable布尔值
设置用户是否可以手动最小化窗口。在 Linux 上不起作用。
win.isMinimizable() macOS Windows
返回 布尔值 - 用户是否可以手动最小化窗口。
在 Linux 上始终返回 true。
win.setMaximizable(maximizable) macOS Windows
maximizable布尔值
设置用户是否可以手动最大化窗口。在 Linux 上不起作用。
win.isMaximizable() macOS Windows
返回 布尔值 - 用户是否可以手动最大化窗口。
在 Linux 上始终返回 true。
win.setFullScreenable(fullscreenable)
fullscreenable布尔值
设置最大化/缩放窗口按钮是否切换全屏模式或最大化窗口。
win.isFullScreenable()
返回 布尔值 - 最大化/缩放窗口按钮是否切换全屏模式或最大化窗口。
win.setClosable(closable) macOS Windows
closable布尔值
设置用户是否可以手动关闭窗口。在 Linux 上不起作用。
win.isClosable() macOS Windows
返回 布尔值 - 用户是否可以手动关闭窗口。
在 Linux 上始终返回 true。
win.setHiddenInMissionControl(hidden) macOS
hidden布尔值
设置用户切换到 Mission Control 时窗口是否隐藏。
win.isHiddenInMissionControl() macOS
返回 布尔值 - 用户切换到 Mission Control 时窗口是否隐藏。
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)
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)
title字符串
将原生窗口的标题更改为 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)
flagboolean
开始或停止闪烁窗口以吸引用户的注意力。
win.setSkipTaskbar(skip) macOS Windows
skipboolean
使窗口不显示在任务栏中。
win.setKiosk(flag)
flagboolean
进入或退出 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
挂钩窗口消息。当 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> - 页面加载完成后（请参阅 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)
您可以通过以下方式使用 URL 编码数据发出 POST 请求来加载 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> - 页面加载完成后（请参阅 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]。
当 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，则清除叠加层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 | 字符串
更改窗口图标。
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.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 上，它使用 WDA_EXCLUDEFROMCAPTURE 调用 SetWindowDisplayAffinity。对于 Windows 10 2004 及更高版本，窗口将完全从捕获中移除，较旧的 Windows 版本的行为类似于应用了 WDA_MONITOR，捕获一个黑色窗口。
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) macOS
type字符串 | null - 可以是titlebar、selection、menu、popover、sidebar、header、sheet、window、hud、fullscreen-ui、tooltip、content、under-window或under-page。有关更多详细信息，请参阅 macOS 文档。
为浏览器窗口添加活力效果。传递 null 或空字符串将删除窗口上的活力效果。
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
设置当前窗口的 touchBar 布局。指定 null 或 undefined 将清除触控栏。此方法仅在机器具有触控栏时才有效。
注意：TouchBar API 目前处于实验阶段，可能会在未来的 Electron 版本中更改或删除。
win.setBrowserView(browserView) 实验性 已弃用
browserViewBrowserView | null - 将browserView附加到win。如果还有其他BrowserView附加，它们将从该窗口中移除。
注意
BrowserView类已弃用，并由新的WebContentsView类替换。
win.getBrowserView() 实验性 已弃用
返回 BrowserView | null - 附加到 win 的 BrowserView。如果未附加任何 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[] - 使用 addBrowserView 或 setBrowserView 附加的所有 BrowserViews 的按 z 索引排序的数组。最顶层的 BrowserView 是数组的最后一个元素。
注意
BrowserView类已弃用，并由新的WebContentsView类替换。
win.setTitleBarOverlay(options) Windows Linux
在已启用窗口控件叠加层的窗口上，此方法更新标题栏叠加层的样式。
在 Linux 上，如果未显式设置，则 symbolColor 将自动计算为与 color 具有最低可访问对比度。