mirror of
https://github.com/electron/electron.git
synced 2026-05-02 03:00:22 -04:00
b4460a05da
* Document known issue for dock.hide() method Added a note about a known issue with dock.hide() method. * Adjust workaround time for dock.hide() method Updated workaround time for dock.hide() known issue. * Fix known issue timing for dock.hide() workaround Updated the workaround time in the known issue section for dock.hide() to 1000ms. * Adjust workaround delay for dock.hide() method Updated workaround time for dock.hide() known issue.
87 lines
2.4 KiB
Markdown
87 lines
2.4 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._
|
||
|
||
> [!TIP]
|
||
> See also: [A detailed guide about how to implement Dock menus](../tutorial/macos-dock.md).
|
||
|
||
### 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.
|
||
|
||
> [!IMPORTANT]
|
||
> You need to ensure that your application has the permission to display notifications for this method to work.
|
||
|
||
#### `dock.getBadge()` _macOS_
|
||
|
||
Returns `string` - The badge string of the dock.
|
||
|
||
#### `dock.hide()` _macOS_
|
||
|
||
Hides the dock icon.
|
||
|
||
> [!IMPORTANT]
|
||
> **Known issue:** Calling `dock.hide()` within one second of a previous call will have no effect. As a workaround, ensure at least one second has elapsed between calls — for example, by deferring with a `setTimeout` of 1100ms or more after a previous call.
|
||
|
||
#### `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
|