mirror of
https://github.com/electron/electron.git
synced 2026-01-14 09:58:04 -05:00
15c404a3c8
Fix the Apple human interface guidelines link for Dock context menu The link seems to have changed. This is the up to date link.
84 lines
2.0 KiB
Markdown
84 lines
2.0 KiB
Markdown
## Class: Dock
|
||
|
||
> Control your app in the macOS dock
|
||
|
||
Process: [Main](../glossary.md#main-process)<br />
|
||
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._
|
||
|
||
The following example shows how to bounce your icon on the dock.
|
||
|
||
```js
|
||
const { app } = require('electron')
|
||
app.dock.bounce()
|
||
```
|
||
|
||
### Instance Methods
|
||
|
||
#### `dock.bounce([type])` _macOS_
|
||
|
||
* `type` string (optional) - Can be `critical` or `informational`. The default is
|
||
`informational`
|
||
|
||
Returns `Integer` - an ID representing the request.
|
||
|
||
When `critical` is passed, the dock icon will bounce until either the
|
||
application becomes active or the request is canceled.
|
||
|
||
When `informational` is passed, the dock icon will bounce for one second.
|
||
However, the request remains active until either the application becomes active
|
||
or the request is canceled.
|
||
|
||
**Note:** This method can only be used while the app is not focused; when the app is focused it will return -1.
|
||
|
||
#### `dock.cancelBounce(id)` _macOS_
|
||
|
||
* `id` Integer
|
||
|
||
Cancel the bounce of `id`.
|
||
|
||
#### `dock.downloadFinished(filePath)` _macOS_
|
||
|
||
* `filePath` string
|
||
|
||
Bounces the Downloads stack if the filePath is inside the Downloads folder.
|
||
|
||
#### `dock.setBadge(text)` _macOS_
|
||
|
||
* `text` string
|
||
|
||
Sets the string to be displayed in the dock’s badging area.
|
||
|
||
#### `dock.getBadge()` _macOS_
|
||
|
||
Returns `string` - The badge string of the dock.
|
||
|
||
#### `dock.hide()` _macOS_
|
||
|
||
Hides the dock icon.
|
||
|
||
#### `dock.show()` _macOS_
|
||
|
||
Returns `Promise<void>` - Resolves when the dock icon is shown.
|
||
|
||
#### `dock.isVisible()` _macOS_
|
||
|
||
Returns `boolean` - Whether the dock icon is visible.
|
||
|
||
#### `dock.setMenu(menu)` _macOS_
|
||
|
||
* `menu` [Menu](menu.md)
|
||
|
||
Sets the application's [dock menu][dock-menu].
|
||
|
||
#### `dock.getMenu()` _macOS_
|
||
|
||
Returns `Menu | null` - The application's [dock menu][dock-menu].
|
||
|
||
#### `dock.setIcon(image)` _macOS_
|
||
|
||
* `image` ([NativeImage](native-image.md) | string)
|
||
|
||
Sets the `image` associated with this dock icon.
|
||
|
||
[dock-menu]: https://developer.apple.com/design/human-interface-guidelines/dock-menus
|