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 窗口的顶部。

模态窗口是一个禁用父窗口的子窗口。要创建模态窗口，您必须同时设置 parent 和 modal 选项

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 时，WebContentsView 的 webContents 不会自动销毁。

关闭 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。

警告

Electron 的内置类不能被用户代码继承。更多信息，请参阅常见问题解答。

`new BaseWindow([options])`

options BaseWindowConstructorOptions (可选)
- width Integer (可选) - 窗口宽度（像素）。默认为 800。
- height Integer (可选) - 窗口高度（像素）。默认为 600。
- x Integer (可选) - (如果使用了 y，则**必需**) 窗口到屏幕的左偏移量。默认为居中窗口。
- y Integer (可选) - (如果使用了 x，则**必需**) 窗口到屏幕的顶偏移量。默认为居中窗口。
- useContentSize boolean (可选) - width 和 height 将用作网页的大小，这意味着实际窗口的大小将包括窗口边框的大小，并且会稍大一些。默认为 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 会使窗口停止与 WM 交互，因此窗口将始终显示在所有工作区的顶部。
- alwaysOnTop boolean (可选) - 窗口是否应始终显示在其他窗口之上。默认为 false。
- fullscreen boolean (可选) - 窗口是否应全屏显示。当明确设置为 false 时，macOS 上的全屏按钮将被隐藏或禁用。默认为 false。
- fullscreenable boolean (可选) - 窗口是否可以进入全屏模式。在 macOS 上，这也决定了最大化/缩放按钮是切换全屏模式还是最大化窗口。默认为 true。
- simpleFullscreen boolean (可选) macOS - 在 macOS 上使用 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 - 点击非活动窗口是否也会穿透到 Web 内容。在 macOS 上默认为 false。此选项在其他平台上不可配置。
- disableAutoHideCursor boolean (可选) - 输入时是否隐藏光标。默认为 false。
- autoHideMenuBar boolean (可选) Linux Windows - 自动隐藏菜单栏，除非按下 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 Object | Boolean (可选) - 当无边框窗口与 macOS 上的 win.setWindowButtonVisibility(true) 结合使用，或使用 titleBarStyle 使标准窗口控件（macOS 上的“交通灯”）可见时，此属性会启用窗口控件叠加层JavaScript API 和CSS 环境变量。指定 true 将产生具有默认系统颜色的叠加层。默认为 false。
  - color String (可选) Windows Linux - 启用窗口控件叠加层时的窗口的 CSS 颜色。默认为系统颜色。
  - symbolColor String (可选) Windows Linux - 启用窗口控件叠加层时符号的 CSS 颜色。默认为系统颜色。
  - height Integer (可选) - 标题栏和窗口控件叠加层的高度（像素）。默认为系统高度。
- accentColor boolean | string (可选) Windows - 窗口的强调色。默认情况下，遵循系统设置中的用户偏好设置。设置为 false 可显式禁用，或设置为十六进制、RGB、RGBA、HSL、HSLA 或命名 CSS 颜色格式。Alpha 值将被忽略。
- trafficLightPosition Point (可选) macOS - 在无边框窗口中为交通灯按钮设置自定义位置。
- roundedCorners boolean (可选) macOS Windows - 无边框窗口是否应具有圆角。默认为 true。将此属性设置为 false 将阻止窗口在 macOS 上全屏。在 Windows 11 Build 22000 之前的版本上，此属性无效，无边框窗口将没有圆角。
- thickFrame boolean (可选) - 在 Windows 上为无边框窗口使用 WS_THICKFRAME 样式，它会添加标准的窗口边框。将其设置为 false 将移除窗口阴影和窗口动画。默认为 true。
- vibrancy string (可选) macOS - 为窗口添加一种振动效果，仅在 macOS 上。可以是 appearance-based, titlebar, selection, menu, popover, sidebar, header, sheet, window, hud, fullscreen-ui, tooltip, content, under-window, 或 under-page。
- backgroundMaterial string (可选) Windows - 设置窗口的系统绘制背景材质，包括非客户区域的后面。可以是 auto, none, mica, acrylic, 或 tabbed。有关更多信息，请参阅 win.setBackgroundMaterial。
- zoomToPageWidth boolean (可选) macOS - 控制在 macOS 上按住 Option 键单击工具栏上的绿色停止按钮或单击 Window > Zoom 菜单项时的行为。如果为 true，则窗口在缩放时将增长到网页的首选宽度，false 将导致其缩放到屏幕宽度。这也会影响调用 maximize() 的直接行为。默认为 false。
- tabbingIdentifier string (可选) macOS - 选项卡组名称，允许将窗口作为本机选项卡打开。具有相同 tabbingIdentifier 的窗口将被分组在一起。这还会向窗口的选项卡栏添加一个本机新建选项卡按钮，并允许您的 app 和窗口接收 new-window-for-tab 事件。
设置最小或最大窗口大小时，使用 minWidth/maxWidth/ minHeight/maxHeight，只会限制用户。这不会阻止您将不符合大小约束的值传递给 setBounds/setSize 或 BrowserWindow 的构造函数。

type 选项的可能值和行为取决于平台。可能的值包括：
- 在 Linux 上，可能类型为 desktop, dock, toolbar, splash, notification。
  - desktop 类型将窗口置于桌面背景窗口级别（kCGDesktopWindowLevel - 1）。但是，请注意，桌面窗口不会接收焦点、键盘或鼠标事件。您仍然可以使用 globalShortcut 来谨慎接收输入。
  - dock 类型创建类似 dock 的窗口行为。
  - toolbar 类型创建具有工具栏外观的窗口。
  - splash 类型表现方式很特别。它不可拖动，即使窗口正文的 CSS 样式包含 -webkit-app-region: drag。此类型通常用于启动屏幕。
  - notification 类型创建的行为类似系统通知的窗口。
- 在 macOS 上，可能类型为 desktop, textured, panel。
  - textured 类型增加了金属渐变外观。此选项已**弃用**。
  - desktop 类型将窗口置于桌面背景窗口级别（kCGDesktopWindowLevel - 1）。请注意，桌面窗口不会接收焦点、键盘或鼠标事件，但您可以使用 globalShortcut 来谨慎接收输入。
  - panel 类型通过在运行时添加 NSWindowStyleMaskNonactivatingPanel 样式蒙版（通常保留给 NSPanel）来使窗口浮动在全屏应用程序之上。此外，窗口将出现在所有空间（桌面）上。
- 在 Windows 上，可能类型为 toolbar。

实例事件

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

注意

某些事件仅在特定操作系统上可用，并已相应标记。

事件：'close'

event 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'

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

事件：'query-session-end' Windows

event WindowSessionEndEvent

由于关机、重启或用户注销而即将结束会话时触发。调用 event.preventDefault() 可以延迟系统关机，尽管通常最好尊重用户结束会话的决定。但是，如果结束会话可能导致用户丢失数据，您可以选择使用它。

事件：'session-end' Windows

event WindowSessionEndEvent

由于关机、重启或用户注销而即将结束会话时触发。一旦此事件触发，就无法阻止会话结束。

事件：'blur'

event Event

当窗口失去焦点时触发。

事件：'focus'

event Event

当窗口获得焦点时触发。

事件：'show'

当窗口显示时触发。

事件：'hide'

当窗口隐藏时触发。

事件：'maximize'

当窗口最大化时触发。

事件：'unmaximize'

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

事件：'minimize'

当窗口最小化时触发。

事件：'restore'

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

事件：'will-resize' macOS Windows

event Event
newBounds Rectangle - 窗口被调整到的新边界。
details Object
- edge (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

event 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 Event
isAlwaysOnTop boolean

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

事件：'app-command' Windows Linux

event Event
command string

调用 App 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 Event
direction string

三指滑动时触发。可能的方向为 up, right, down, left。

此事件的底层方法是为了处理旧的 macOS 风格的触控板滑动，其中屏幕上的内容不会随滑动而移动。大多数 macOS 触控板不再配置为允许此类滑动，因此为了使其正确触发，必须在 系统偏好设置 > 触控板 > 更多手势 中将“滑动页面”首选项设置为“使用两指或三指滑动”。

事件：'rotate-gesture' macOS

event Event
rotation Float

在触控板旋转手势时触发。在旋转手势结束前持续触发。每次触发时的 rotation 值是自上次触发以来旋转的角度（度）。旋转手势结束时最后一次触发的事件始终值为 0。逆时针旋转值为正，顺时针值为负。

事件：'sheet-begin' macOS

当窗口打开一个窗口时触发。

事件：'sheet-end' macOS

当窗口关闭一个窗口时触发。

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

当单击本机新建选项卡按钮时触发。

event Event
point Point - 触发上下文菜单的屏幕坐标。

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

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

要将 point 转换为 DIP，请使用 screen.screenToDipPoint(point)。

静态方法

BaseWindow 类具有以下静态方法

`BaseWindow.getAllWindows()`

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

`BaseWindow.getFocusedWindow()`

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

`BaseWindow.fromId(id)`

id Integer

返回 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` 只读

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

`win.contentView`

窗口内容视图的 View 属性。

`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 属性，用于确定窗口是否处于 kiosk 模式。

`win.documentEdited` macOS

一个 boolean 属性，用于指定窗口的文档是否已编辑。设置为 true 时，标题栏中的图标将变为灰色。

当设置为 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 { 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 属性，定义了仅提供给屏幕阅读器等辅助工具的替代标题。此字符串对用户不可见。

`win.snapped` Windows 只读

一个 boolean 属性，指示窗口是否通过对齐方式进行排列。

实例方法

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

注意

某些方法仅在特定操作系统上可用，并已如此标记。

`win.setContentView(view)`

view View

设置窗口的内容视图。

`win.getContentView()`

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

`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 boolean

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

注意

在 macOS 上，全屏转换是异步发生的。如果后续操作依赖于全屏状态，请使用 'enter-full-screen' 或 > 'leave-full-screen' 事件。

`win.isFullScreen()`

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

`win.setSimpleFullScreen(flag)` macOS

flag boolean

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

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

`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 值的示例

Hex
- #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 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 的高度。Tray 的高度会随着时间而变化，并取决于操作系统，但介于 20-40 像素之间。传递小于 Tray 高度的值将导致窗口与 Tray 对齐。

`win.getBounds()`

返回 Rectangle - 窗口的 bounds（以 Object 形式）。

注意

在 macOS 上，返回的 y 坐标值至少为 Tray 的高度。例如，调用 win.setBounds({ x: 25, y: 20, width: 800, height: 600 })，如果 Tray 高度为 38，则 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

将窗口的大小调整为 width 和 height。如果 width 或 height 低于任何设置的最小尺寸约束，窗口将调整到其最小尺寸。

`win.getSize()`

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

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

width Integer
height Integer
animate boolean (可选) macOS

将窗口的客户区（例如网页）的大小调整为 width 和 height。

`win.getContentSize()`

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

`win.setMinimumSize(width, height)`

width Integer
height Integer

将窗口的最小尺寸设置为 width 和 height。

`win.getMinimumSize()`

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

`win.setMaximumSize(width, height)`

width Integer
height Integer

将窗口的最大尺寸设置为 width 和 height。

`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

设置用户切换到 Mission Control 时是否隐藏窗口。

`win.isHiddenInMissionControl()` macOS

返回 boolean - 用户切换到 Mission Control 时是否隐藏窗口。

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

flag boolean
level string (可选) macOS Windows - 值包括 normal, floating, torn-off-menu, modal-panel, main-menu, status, pop-up-menu, screen-saver，以及~~dock~~（已弃用）。当 flag 为 true 时，默认为 floating。当 flag 为 false 时，level 重置为 normal。请注意，从 floating 到 status（含）的窗口显示在 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 - 格式为 DesktopCapturerSource 的 id 的窗口 id。例如 "window:1869:0"。

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

`win.moveTop()`

将窗口移动到顶部（z 顺序），无论是否获得焦点。

`win.center()`

将窗口移动到屏幕中央。

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

x Integer
y Integer
animate boolean (可选) macOS

将窗口移动到 x 和 y。

`win.getPosition()`

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

`win.setTitle(title)`

title string

将本机窗口的标题更改为 title。

`win.getTitle()`

返回 string - 本机窗口的标题。

注意

网页的标题可能与本机窗口的标题不同。

`win.setSheetOffset(offsetY[, offsetX])` macOS

offsetY Float
offsetX Float (可选)

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

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

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

`win.flashFrame(flag)`

历史

版本(s)	更改
>=31.0.0	`window.flashFrame(bool)` 在 macOS 上会持续闪烁 Dock 图标
>=29.0.0	API ADDED

flag boolean

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

`win.setSkipTaskbar(skip)` macOS Windows

skip boolean

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

`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 - 格式为 DesktopCapturerSource 的 id 的窗口 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 Integer
callback Function
- wParam Buffer - 提供给 WndProc 的 wParam
- lParam Buffer - 提供给 WndProc 的 lParam

挂钩窗口消息。当在 WndProc 中收到消息时，会调用 callback。

`win.isWindowMessageHooked(message)` Windows

message Integer

返回 boolean - true 或 false，取决于消息是否被挂钩。

`win.unhookWindowMessage(message)` Windows

message Integer

取消挂钩窗口消息。

`win.unhookAllWindowMessages()` Windows

取消挂钩所有窗口消息。

`win.setRepresentedFilename(filename)` macOS

filename string

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

`win.getRepresentedFilename()` macOS

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

`win.setDocumentEdited(edited)` macOS

edited boolean

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

`win.isDocumentEdited()` macOS

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

`win.setMenu(menu)` Linux Windows

menu Menu | null

将 menu 设置为窗口的菜单栏。

`win.removeMenu()` Linux Windows

删除窗口的菜单栏。

`win.setProgressBar(progress[, options])`

progress Double
options Object (可选)
- mode string Windows - 进度条模式。可以是 none, normal, indeterminate, error 或 paused。

设置进度条的进度值。有效范围为 [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

overlay NativeImage | null - 显示在任务栏图标右下角的图标。如果此参数为 null，则清除叠加层
description string - 将提供给辅助功能屏幕阅读器的描述

在当前任务栏图标的右下角设置一个 16 x 16 像素的叠加层，通常用于传达某种应用程序状态或被动通知用户。

`win.invalidateShadow()` macOS

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

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

`win.setHasShadow(hasShadow)`

hasShadow boolean

设置窗口是否应有阴影。

`win.hasShadow()`

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

`win.setOpacity(opacity)` Windows macOS

opacity number - 介于 0.0（完全透明）和 1.0（完全不透明）之间

设置窗口的透明度。在 Linux 上无效。超出范围的数值将被限制在 [0, 1] 范围内。

`win.getOpacity()`

返回 number - 介于 0.0（完全透明）和 1.0（完全不透明）之间。在 Linux 上，始终返回 1。

`win.setShape(rects)` Windows Linux Experimental

rects Rectangle[] - 设置窗口的形状。传递一个空数组会将窗口恢复为矩形。

设置窗口形状可以确定窗口中系统允许绘制和用户交互的区域。在给定区域之外，将不会绘制任何像素，也不会注册任何鼠标事件。区域外的鼠标事件将不会被该窗口接收，而是会传递给窗口下方的其他内容。

`win.setThumbarButtons(buttons)` Windows

buttons ThumbarButton[]

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

在任务栏按钮布局的窗口缩略图上添加一个带有指定按钮的缩略图工具栏。返回一个 boolean 对象，指示缩略图是否已成功添加。

由于空间有限，缩略图工具栏中的按钮数量不应超过 7 个。一旦设置了缩略图工具栏，由于平台限制，就无法将其移除。但是，您可以通过传递一个空数组来清理按钮。

buttons 是一个 Button 对象的数组

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

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

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

`win.setThumbnailClip(region)` Windows

region Rectangle - 窗口区域

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

`win.setThumbnailToolTip(toolTip)` Windows

toolTip string

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

`win.setAppDetails(options)` Windows

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

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

注意

relaunchCommand 和 relaunchDisplayName 必须一起设置。如果其中一个属性未设置，则两者都将不起作用。

`win.setAccentColor(accentColor)` Windows

accentColor boolean | string - 窗口的强调色。默认情况下，遵循系统设置中的用户偏好设置。

设置系统强调色和活动窗口边框的突出显示。

accentColor 参数接受以下值

颜色字符串 - 使用标准的 CSS 颜色格式（Hex、RGB、RGBA、HSL、HSLA 或命名颜色）设置自定义强调色。RGBA/HSLA 格式的 Alpha 值将被忽略，颜色将被视为完全不透明。
true - 使用系统设置中用户偏好设置的系统默认强调色。
false - 明确禁用窗口的强调色突出显示。

示例

const win = new BrowserWindow({ frame: false })

// Set red accent color.
win.setAccentColor('#ff0000')

// RGB format (alpha ignored if present).
win.setAccentColor('rgba(255,0,0,0.5)')

// Use system accent color.
win.setAccentColor(true)

// Disable accent color.
win.setAccentColor(false)

`win.getAccentColor()` Windows

返回 string | boolean - 系统强调色和活动窗口边框的突出显示，格式为十六进制 RGB。

如果为窗口设置了与系统强调色不同的颜色，将返回窗口强调色。否则，将返回一个布尔值，true 表示窗口使用全局系统强调色，false 表示该窗口的强调色突出显示被禁用。

`win.setIcon(icon)` Windows Linux

icon NativeImage | string

更改窗口图标。

`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.isSnapped()` Windows

返回 boolean - 窗口是否通过 Snap 排列。

窗口通过鼠标悬停在窗口最大化按钮上时显示的按钮，或通过将其拖动到屏幕边缘来捕捉。

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

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

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

注意

此 API 在 Windows 上无效。

`win.isVisibleOnAllWorkspaces()` macOS Linux

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

注意

此 API 在 Windows 上始终返回 false。

`win.setIgnoreMouseEvents(ignore[, options])`

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

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

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

`win.setContentProtection(enable)` macOS Windows

enable boolean

防止窗口内容被其他应用程序捕获。

在 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 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-window, 或 under-page。有关更多详细信息，请参阅 macOS 文档。

为窗口添加一个活力效果。传递 null 或空字符串将移除窗口的活力效果。

`win.setBackgroundMaterial(material)` Windows

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

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

有关更多详细信息，请参阅 Windows 文档。

注意

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

`win.setWindowButtonPosition(position)` macOS

position Point | null

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

`win.getWindowButtonPosition()` macOS

返回 Point | null - 无边框窗口交通灯按钮的自定义位置，如果没有自定义位置则返回 null。

`win.setTouchBar(touchBar)` macOS

touchBar TouchBar | null

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

注意

TouchBar API 目前仍处于实验阶段，在未来的 Electron 版本中可能会发生更改或被移除。

`win.setTitleBarOverlay(options)` Windows Linux

options Object
- color String (optional) - 启用窗口控件覆盖时的 CSS 颜色。
- symbolColor String (optional) - 启用窗口控件覆盖时的符号的 CSS 颜色。
- height Integer (optional) - 标题栏和窗口控件覆盖的高度（以像素为单位）。

在已启用窗口控件覆盖的窗口上，此方法将更新标题栏覆盖的样式。

在 Linux 上，如果未显式设置 symbolColor，则会自动计算以实现与 color 的最低可访问对比度。

父子窗口
模态窗口
平台通知
资源管理
类：BaseWindow

父子窗口​

模态窗口​

平台提示​

资源管理​

类：BaseWindow​

new BaseWindow([options])​

实例事件​

事件：'close'​

事件：'closed'​

事件：'query-session-end' Windows​

事件：'session-end' Windows​

事件：'blur'​

事件：'focus'​

事件：'show'​

事件：'hide'​

事件：'maximize'​

事件：'unmaximize'​

事件：'minimize'​

事件：'restore'​

事件：'will-resize' macOS Windows​

事件：'resize'​

事件：'resized' macOS Windows​

事件：'will-move' macOS Windows​

事件：'move'​

事件：'moved' macOS Windows​

事件：'enter-full-screen'​

事件：'leave-full-screen'​

事件：'always-on-top-changed'​

事件：'app-command' Windows Linux​

事件：'swipe' macOS​

事件：'rotate-gesture' macOS​

事件：'sheet-begin' macOS​

事件：'sheet-end' macOS​

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

事件：'system-context-menu' Windows Linux​

静态方法​

BaseWindow.getAllWindows()​

BaseWindow.getFocusedWindow()​

BaseWindow.fromId(id)​

实例属性​

win.id 只读​

win.contentView​

win.tabbingIdentifier macOS 只读​

win.autoHideMenuBar Linux Windows​

win.simpleFullScreen​

win.fullScreen​

win.focusable Windows macOS​

win.visibleOnAllWorkspaces macOS Linux​

win.shadow​

win.menuBarVisible Windows Linux​

win.kiosk​

win.documentEdited macOS​

win.representedFilename macOS​

win.title​

win.minimizable macOS Windows​

win.maximizable macOS Windows​

win.fullScreenable​

win.resizable​

win.closable macOS Windows​

win.movable macOS Windows​

win.excludedFromShownWindowsMenu macOS​

win.accessibleTitle​

win.snapped Windows 只读​

实例方法​

win.setContentView(view)​

win.getContentView()​

win.destroy()​

win.close()​

win.focus()​

win.blur()​

win.isFocused()​

win.isDestroyed()​

win.show()​

win.showInactive()​

win.hide()​

win.isVisible()​

win.isModal()​

win.maximize()​

win.unmaximize()​

win.isMaximized()​

父子窗口

模态窗口

平台提示

资源管理

类：BaseWindow

`new BaseWindow([options])`

实例事件

事件：'close'

事件：'closed'

事件：'query-session-end' Windows

事件：'session-end' Windows

事件：'blur'

事件：'focus'

事件：'show'

事件：'hide'

事件：'maximize'

事件：'unmaximize'

事件：'minimize'

事件：'restore'

事件：'will-resize' macOS Windows

事件：'resize'

事件：'resized' macOS Windows

事件：'will-move' macOS Windows

事件：'move'

事件：'moved' macOS Windows

事件：'enter-full-screen'

事件：'leave-full-screen'

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

事件：'app-command' Windows Linux

事件：'swipe' macOS

事件：'rotate-gesture' macOS

事件：'sheet-begin' macOS

事件：'sheet-end' macOS

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

事件：'system-context-menu' Windows Linux

静态方法

`BaseWindow.getAllWindows()`

`BaseWindow.getFocusedWindow()`

`BaseWindow.fromId(id)`

实例属性

`win.id` 只读

`win.contentView`

`win.tabbingIdentifier` macOS 只读

`win.autoHideMenuBar` Linux Windows

`win.simpleFullScreen`

`win.fullScreen`

`win.focusable` Windows macOS

`win.visibleOnAllWorkspaces` macOS Linux

`win.shadow`

`win.menuBarVisible` Windows Linux

`win.kiosk`

`win.documentEdited` macOS

`win.representedFilename` macOS

`win.title`

`win.minimizable` macOS Windows

`win.maximizable` macOS Windows

`win.fullScreenable`

`win.resizable`

`win.closable` macOS Windows

`win.movable` macOS Windows

`win.excludedFromShownWindowsMenu` macOS

`win.accessibleTitle`

`win.snapped` Windows 只读

实例方法

`win.setContentView(view)`

`win.getContentView()`

`win.destroy()`

`win.close()`

`win.focus()`

`win.blur()`

`win.isFocused()`

`win.isDestroyed()`

`win.show()`

`win.showInactive()`

`win.hide()`

`win.isVisible()`

`win.isModal()`

`win.maximize()`

`win.unmaximize()`

`win.isMaximized()`