Dock

external class Dock(source)

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
external fun bounce(type: DockBounceType = definedExternally): Double

an ID representing the request.

Link copied to clipboard
external fun cancelBounce(id: Double)

Cancel the bounce of id.

Link copied to clipboard
external fun downloadFinished(filePath: String)

Bounces the Downloads stack if the filePath is inside the Downloads folder.

Link copied to clipboard
external fun getBadge(): String

The badge string of the dock.

Link copied to clipboard
external fun getMenu(): Menu?

The application's dock menu.

Link copied to clipboard
external fun hide()

Hides the dock icon.

Link copied to clipboard
external fun isVisible(): Boolean

Whether the dock icon is visible.

Link copied to clipboard
external fun setBadge(text: String)

Sets the string to be displayed in the dock’s badging area.

Link copied to clipboard
external fun setIcon(image: NativeImage)
external fun setIcon(image: String)

Sets the image associated with this dock icon.

Link copied to clipboard
external fun setMenu(menu: Menu)

Sets the application's dock menu.

Link copied to clipboard
external fun show(): Promise<Void>

Resolves when the dock icon is shown.