Zum Hauptteil springen

Class: Dock

Class: Dock​

Steuern Sie Ihre App im MacOS-Dock

Process: Main
This class is not exported from the 'electron' module. Es ist nur als Rückgabewert anderer Methoden in der Electron-API verfügbar.

[!TIP] Siehe auch: Eine detaillierte Anleitung zur Implementierung von Dock-Menüs.

Beispiel Methoden​

dock.bounce([type]) macOS​

  • type string (optional) - Kann critical oder informational sein. Standard ist informational

Returns Integer - Eine ID welche den Request repräsentiert.

Wenn critical übergeben ist, wird das Dock-Symbol übersprungen, bis entweder die Anwendung aktiv wird oder die Anfrage abgebrochen wird.

Wenn informational übergeben ist, wird das Dock-Symbol eine Sekunde lang springen. Die Anfrage bleibt jedoch so lange aktiv, bis entweder die Anwendung aktiv wird oder die Anfrage abgebrochen wird.

[!NOTE] Diese Methode kann nur verwendet werden, wenn die Anwendung nicht fokussiert ist. Wenn sie fokussiert ist, wird diese Methode -1 zurückgeben.

dock.cancelBounce(id) macOS​

  • id Integer

Abbrechen des Bouncens von id.

dock.downloadFinished(filePath) macOS​

  • filePath string

Lässt den Downloads-Stapel bouncen, wenn der Dateipfad innerhalb des Downloads-Ordners liegt.

dock.setBadge(text) macOS​

  • text string

Legt die Zeichenfolge fest, die im Ausweisbereich des Docks angezeigt werden soll.

[!IMPORTANT] Du musst sicherstellen, dass deine Anwendung die Berechtigung hat, Benachrichtigungen anzuzeigen, damit diese Methode funktioniert.

dock.getBadge() macOS​

Rückgabe string - Der Ausweisstring des Docks.

dock.hide() macOS​

Versteckt das dock icon.

dock.show() macOS​

Returns Promise<void> - Resolves when the dock icon is shown.

dock.isVisible() macOS​

Gibt boolean zurück - Ob das Dock Icon sichtbar ist.

dock.setMenu(menu) macOS​

Setzt das Dock Menü der Anwendung.

dock.getMenu() macOS​

Gibt Menu | null zurück - Das Dock Menü der Anwendung.

dock.setIcon(image) macOS​

Setzt das image welches als Dock Icon verwendet werden soll.