Aller au contenu principal

Class: Dock

Class: Dock​

Contrôlez votre application dans le dock macOS

Process: Main
This class is not exported from the 'electron' module. Elle n'est disponible qu'en tant que valeur de retour des autres méthodes dans l'API Electron.

L'exemple suivant montre comment rebondir votre icône sur le dock.

const { app } = require('electron')
app.dock.bounce()

Méthodes d’instance​

dock.bounce([type]) macOS​

  • type string (facultatif) -Peut être critical ou informational. Par défaut, informational

Retourne ID un Integer représentant la requête.

Lorsque critical est passé, l’icône du dock rebondira jusqu'à ce que l’application redevienne active ou que la requête soit annulée.

Lorsque informational est passé, l'icône du dock rebondit pendant une seconde. Cependant, la requête reste active jusqu'à ce que l'application devienne active ou que la demande soit annulée.

Nota Bene : Cette méthode ne peut être utilisée que si l'application n'a pas le focus ; dans le cas contraire elle retourne -1.

dock.cancelBounce(id) macOS​

  • id Integer

Annule le rebond de l'id.

dock.downloadFinished(filePath) macOS​

  • filePath string

Fait rebondir la pile de téléchargements si le chemin d'accès se trouve dans le dossier Téléchargements.

dock.setBadge(text) macOS​

  • text string

Définit la chaîne de caractères à afficher dans la zone du badge du dock.

dock.getBadge() macOS​

Retourne string - Le texte du badge du dock.

dock.hide() macOS​

Masque l’icône du dock.

dock.show() macOS​

Retourne une Promise<void> -qui se résout lorsque l'icône du dock est affichée.

dock.isVisible() macOS​

Retourne un boolean - disant si l'icône du dock est visible.

dock.setMenu(menu) macOS​

Définit le dock menu de l’application.

dock.getMenu() macOS​

Retourne Menu | null - dock menu de l'application.

dock.setIcon(image) macOS​

Définit l’image associée à l'icône du dock.