Ir para o conteúdo principal

Class: Dock

Class: Dock​

Controle seu app no dock para macOS

Processo: Principal
Esta classe não é exportada do módulo 'electron'. Ele é somente disponibilizado como um valor de retorno de outros métodos na API Electron.

The following example shows how to bounce your icon on the dock.

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

Métodos de Instância​

dock.bounce([type]) macOS​

  • type string (opcional) - Pode ser crítico ou informacional. O valor padrão é informacional

Retorna um Número - um ID que representa a solicitação.

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. No entanto, a solicitação continua ativa até que a aplicação torne-se ativa ou a solicitação seja cancelada.

Nota: Esse método pode ser usado apenas quando o app não estiver focado; quando o app é focado ele retornará -1.

dock.cancelBounce(id) macOS​

  • id Inteiro

Cancel the bounce of id.

dock.downloadFinished(filePath) no macOS​

  • filePath string

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

dock.setBadge(text) no macOS​

  • text string

Seleciona a string a ser mostrada na área de emblemamento do dock.

dock.getBadge() no macOS​

Returns string - The badge string of the dock.

dock.hide() no macOS​

Esconde o ícone na Dock.

dock.show() no macOS​

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

dock.isVisible() no macOS​

Returns boolean - Whether the dock icon is visible.

dock.setMenu(menu) no macOS​

Define o dock menu da aplicação.

dock.getMenu() no macOS​

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

dock.setIcon(image) no macOS​

Define a imagem associada com o ícone do dock.