electron/docs/api/tray.md

Tray

Add icons and context menus to the system's notification area.

const {app, Menu, Tray} = require('electron');

let appIcon = null;
app.on('ready', () => {
  appIcon = new Tray('/path/to/my/icon');
  const contextMenu = Menu.buildFromTemplate([
    {label: 'Item1', type: 'radio'},
    {label: 'Item2', type: 'radio'},
    {label: 'Item3', type: 'radio', checked: true},
    {label: 'Item4', type: 'radio'}
  ]);
  appIcon.setToolTip('This is my application.');
  appIcon.setContextMenu(contextMenu);
});

Platform limitations:

• On Linux the app indicator will be used if it is supported, otherwise GtkStatusIcon will be used instead.
• On Linux distributions that only have app indicator support, you have to install libappindicator1 to make the tray icon work.
• App indicator will only be shown when it has a context menu.
• When app indicator is used on Linux, the click event is ignored.
• On Linux in order for changes made to individual MenuItems to take effect, you have to call setContextMenu again. For example:

contextMenu.items[2].checked = false;
appIcon.setContextMenu(contextMenu);

• On Windows it is recommended to use ICO icons to get best visual effects.

If you want to keep exact same behaviors on all platforms, you should not rely on the click event and always attach a context menu to the tray icon.

Class: Tray

Tray is an EventEmitter.

new Tray(image)

• image NativeImage

Creates a new tray icon associated with the image.

Events

The Tray module emits the following events:

Note: Some events are only available on specific operating systems and are labeled as such.

Event: 'click'

• event Event
  • altKey Boolean
  • shiftKey Boolean
  • ctrlKey Boolean
  • metaKey Boolean
• bounds Object - the bounds of tray icon.
  • x Integer
  • y Integer
  • width Integer
  • height Integer

Emitted when the tray icon is clicked.

Note: The bounds payload is only implemented on OS X and Windows.

Event: 'right-click' OS X Windows

• event Event
  • altKey Boolean
  • shiftKey Boolean
  • ctrlKey Boolean
  • metaKey Boolean
• bounds Object - the bounds of tray icon.
  • x Integer
  • y Integer
  • width Integer
  • height Integer

Emitted when the tray icon is right clicked.

Event: 'double-click' OS X Windows

• event Event
  • altKey Boolean
  • shiftKey Boolean
  • ctrlKey Boolean
  • metaKey Boolean
• bounds Object - the bounds of tray icon
  • x Integer
  • y Integer
  • width Integer
  • height Integer

Emitted when the tray icon is double clicked.

Event: 'balloon-show' Windows

Emitted when the tray balloon shows.

Event: 'balloon-click' Windows

Emitted when the tray balloon is clicked.

Event: 'balloon-closed' Windows

Emitted when the tray balloon is closed because of timeout or user manually closes it.

Event: 'drop' OS X

Emitted when any dragged items are dropped on the tray icon.

Event: 'drop-files' OS X

• event
• files Array - the file path of dropped files.

Emitted when dragged files are dropped in the tray icon.

Event: 'drag-enter' OS X

Emitted when a drag operation enters the tray icon.

Event: 'drag-leave' OS X

Emitted when a drag operation exits the tray icon.

Event: 'drag-end' OS X

Emitted when a drag operation ends on the tray or ends at another location.

Methods

The Tray module has the following methods:

Note: Some methods are only available on specific operating systems and are labeled as such.

Tray.destroy()

Destroys the tray icon immediately.

Tray.setImage(image)

• image NativeImage

Sets the image associated with this tray icon.

Tray.setPressedImage(image) OS X

• image NativeImage

Sets the image associated with this tray icon when pressed on OS X.

Tray.setToolTip(toolTip)

• toolTip String

Sets the hover text for this tray icon.

Tray.setTitle(title) OS X

• title String

Sets the title displayed aside of the tray icon in the status bar.

Tray.setHighlightMode(highlight) OS X

• highlight Boolean

Sets whether the tray icon's background becomes highlighted (in blue) when the tray icon is clicked. Defaults to true.

Tray.displayBalloon(options) Windows

• options Object
  • icon NativeImage
  • title String
  • content String

Displays a tray balloon.

Tray.popUpContextMenu([menu, position]) OS X Windows

• menu Menu (optional)
• position Object (optional) - The pop up position.
  • x Integer
  • y Integer

Popups the context menu of tray icon. When menu is passed, the menu will showed instead of the tray's context menu.

The position is only available on Windows, and it is (0, 0) by default.

Tray.setContextMenu(menu)

• menu Menu

Sets the context menu for this icon.