Saltar al contenido principal

Clase: Dock

Clase: Dock​

Controla tu aplicación en el dock de macOS

Process: Main
This class is not exported from the 'electron' module. Sólo está disponible como un valor de retorno de otros métodos en la API de Electron.

[!TIP] See also: A detailed guide about how to implement Dock menus.

Métodos de Instancia​

dock.bounce([type]) macOS​

  • type string (opcional) - Puede ser critical o informational. Por defecto es informational

Devuelve Integer - un ID que representa la solicitud.

Cuando critical es pasado, el ícono del punto rebotará hasta que la aplicación se vuelva activa o la petición sea cancelada.

Cuando informational es pasado, el icono del dock rebotará por un segundo. Sin embargo, la solicitud permanece activa hasta que la aplicación se vuelta activa o la solicitud sea cancelada.

[!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 Íntegro

Cancela el rebote de id.

dock.downloadFinished(filePath) macOS​

  • filePath string

Rebota la apilación de descargas si el archivo de camino está dentro de la carpeta de descargas.

dock.setBadge(text) macOS​

  • texto cadena

Establece la cadena para ser mostrada en el área de insignia del punto.

[!IMPORTANT] You need to ensure that your application has the permission to display notifications for this method to work.

dock.getBadge() macOS​

Devuelve string - La insignia cadena del punto.

dock.hide() macOS​

Esconde el icono del punto.

dock.show() macOS​

Devuelve Promise<void> - Se resuelve cuando se muestra el icono del dock.

dock.isVisible() macOS​

Devuelve boolean - Si el icono del dock es visible.

dock.setMenu(menu) macOS​

Sets the application's dock menu.

dock.getMenu() macOS​

Returns Menu | null - The application's dock menu.

dock.setIcon(image) macOS​

Establece la image asociada con el ícono del punto.