Перейти к основному содержанию

Класс: Dock

Класс: Dock​

Управляйте вашим приложением в macOS dock

Process: Main
This class is not exported from the 'electron' module. Он доступен только в качестве возвращаемого значения других методов в Electron API.

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

Методы экземпляра​

dock.bounce([type]) macOS​

  • type string (опционально) - Может быть critical или informational. По умолчанию informational

Возвращает Integer - ID, представляющий запрос.

Когда critical передается, значок dock будет отскакивать, пока приложение не станет активным или запрос отменяется.

Когда informational пропущен, значок dock будет подпрыгивать в течение одной секунды. Тем не менее, запрос остается активным, пока приложение не станет активным или запрос не будет отменен.

[!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 Integer

Отменить отскок по id.

dock.downloadFinished(filePath) macOS​

  • filePath string

Отскакивает от "Downloads", если путь к файлу находится в папке "Downloads".

dock.setBadge(text) macOS​

  • text string

Устанавливает строку для отображения в панели dock запирающими областями.

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

dock.getBadge() macOS​

Возвращает string - строки значка в dock.

dock.hide() macOS​

Скрыть значок в dock.

dock.show() macOS​

Возвращает Promise<void> - выполняется, когда показан значок dock.

dock.isVisible() macOS​

Возвращает boolean - виден или нет значок dock.

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​

Задает image, связывает со значком в dock.