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.
2.4 KiB
Class: Dock
Control your app in the macOS dock
Process: Main
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.
Instance Methods
dock.bounce([type]) macOS
typestring (optional) - Can becriticalorinformational. The default isinformational
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
idInteger
Cancel the bounce of id.
dock.downloadFinished(filePath) macOS
filePathstring
Bounces the Downloads stack if the filePath is inside the Downloads folder.
dock.setBadge(text) macOS
textstring
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 asetTimeoutof 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
menuMenu
Sets the application's dock menu.
dock.getMenu() macOS
Returns Menu | null - The application's dock menu.
dock.setIcon(image) macOS
image(NativeImage | string)
Sets the image associated with this dock icon.