2020-03-31 04:06:25 +00:00
|
|
|
# macOS Dock
|
2018-02-19 23:09:43 +00:00
|
|
|
|
2020-10-20 01:32:40 +00:00
|
|
|
## Overview
|
|
|
|
|
|
2018-02-19 23:09:43 +00:00
|
|
|
Electron has APIs to configure the app's icon in the macOS Dock. A macOS-only
|
2020-10-20 01:32:40 +00:00
|
|
|
API exists to create a custom dock menu, but Electron also uses the app dock
|
|
|
|
|
icon as the entry point for cross-platform features like
|
|
|
|
|
[recent documents][recent-documents] and [application progress][progress-bar].
|
2018-02-19 23:09:43 +00:00
|
|
|
|
|
|
|
|
The custom dock is commonly used to add shortcuts to tasks the user wouldn't
|
|
|
|
|
want to open the whole app window for.
|
|
|
|
|
|
|
|
|
|
__Dock menu of Terminal.app:__
|
|
|
|
|
|
|
|
|
|
![Dock Menu][dock-menu-image]
|
|
|
|
|
|
2020-10-20 01:32:40 +00:00
|
|
|
To set your custom dock menu, you need to use the
|
|
|
|
|
[`app.dock.setMenu`](../api/dock.md#docksetmenumenu-macos) API,
|
|
|
|
|
which is only available on macOS.
|
|
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
|
|
|
|
|
Starting with a working application from the
|
|
|
|
|
[Quick Start Guide](quick-start.md), update the `main.js` file with the
|
|
|
|
|
following lines:
|
2018-02-19 23:09:43 +00:00
|
|
|
|
2020-11-30 07:48:39 +00:00
|
|
|
```javascript fiddle='docs/fiddles/features/macos-dock-menu'
|
2018-02-19 23:09:43 +00:00
|
|
|
const { app, Menu } = require('electron')
|
|
|
|
|
|
|
|
|
|
const dockMenu = Menu.buildFromTemplate([
|
|
|
|
|
{
|
|
|
|
|
label: 'New Window',
|
|
|
|
|
click () { console.log('New Window') }
|
|
|
|
|
}, {
|
|
|
|
|
label: 'New Window with Settings',
|
|
|
|
|
submenu: [
|
|
|
|
|
{ label: 'Basic' },
|
|
|
|
|
{ label: 'Pro' }
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{ label: 'New Command...' }
|
|
|
|
|
])
|
|
|
|
|
|
2020-10-20 01:32:40 +00:00
|
|
|
app.whenReady().then(() => {
|
|
|
|
|
app.dock.setMenu(dockMenu)
|
|
|
|
|
})
|
2018-02-19 23:09:43 +00:00
|
|
|
```
|
|
|
|
|
|
2020-10-20 01:32:40 +00:00
|
|
|
After launching the Electron application, right click the application icon.
|
|
|
|
|
You should see the custom menu you just defined:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2018-02-19 23:09:43 +00:00
|
|
|
[dock-menu-image]: https://cloud.githubusercontent.com/assets/639601/5069962/6032658a-6e9c-11e4-9953-aa84006bdfff.png
|
|
|
|
|
[recent-documents]: ./recent-documents.md
|
|
|
|
|
[progress-bar]: ./progress-bar.md
|
