跳转到主要内容

类：Dock

类别：Dock​

控制您的应用程序在 macOS Dock 中的行为

进程：主进程
此类未从 'electron' 模块导出。它仅作为 Electron API 中其他方法的返回值可用。

以下示例显示了如何让 Dock 中的图标振动。

const { app } = require('electron')
app.dock?.bounce()

实例方法​

dock.bounce([type]) macOS​

  • type 字符串（可选）- 可以是 critical 或 informational。 默认为 informational

返回 Integer - 代表请求的 ID。

当传递 critical 时，Dock 图标会持续振动，直到应用程序变为活动状态或请求被取消。

当传递 informational 时，Dock 图标会振动一秒钟。 但是，请求会一直保持活动状态，直到应用程序变为活动状态或请求被取消。

注意

此方法只能在应用程序未获得焦点时使用；当应用程序获得焦点时，它将返回 -1。

dock.cancelBounce(id) macOS​

  • id Integer

取消 id 的振动。

dock.downloadFinished(filePath) macOS​

  • filePath string

如果 filePath 位于 Downloads 文件夹内，则振动 Downloads 堆栈。

dock.setBadge(text) macOS​

  • text string

设置要在 Dock 的徽章区域显示的字符串。

dock.getBadge() macOS​

返回 string - Dock 的徽章字符串。

dock.hide() macOS​

隐藏 Dock 图标。

dock.show() macOS​

返回 Promise<void> - Dock 图标显示时解析。

dock.isVisible() macOS​

返回 boolean - Dock 图标是否可见。

dock.setMenu(menu) macOS​

设置应用程序的Dock 菜单。

dock.getMenu() macOS​

返回 Menu | null - 应用程序的Dock 菜单。

dock.setIcon(image) macOS​

设置与此 Dock 图标关联的 image。