跳到主内容

类: Dock

类: Dock​

控制 macOS dock 中的应用程序

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

以下示例展示了如何让应用程序图标在 dock 中跳动。

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

实例方法​

dock.bounce([type]) macOS​

  • type string (可选) - 可以是 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。