跳至主要内容

类:Dock

类:Dock

在 macOS 的 Dock 中控制您的应用

进程:主进程
此类不会从 'electron' 模块导出。它仅作为 Electron API 中其他方法的返回值提供。

以下示例演示如何在 Dock 上弹跳您的图标。

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

实例方法

dock.bounce([type]) macOS

  • type 字符串(可选) - 可以是 criticalinformational。默认值为 informational

返回值 Integer - 表示请求的 ID。

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

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

注意:此方法只能在应用未获得焦点时使用;当应用获得焦点时,它将返回 -1。

dock.cancelBounce(id) macOS

  • id 整数

取消 id 的弹跳。

dock.downloadFinished(filePath) macOS

  • filePath 字符串

如果 filePath 在 Downloads 文件夹内,则弹跳 Downloads 堆栈。

dock.setBadge(text) macOS

  • text 字符串

设置要在 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