Menubar class: properties and methods reference

The return value of menubar() is a Menubar class instance, which exposes the following properties and methods. Menubar is also an event emitter; see Events.

import { menubar } from 'electron-menubar';

const mb = menubar({/* options */});

The menubar(options?: Partial<Options>) factory creates a Menubar using Electron’s app. See Options for every option.

Properties

Electron.App

The Electron App instance.

BrowserWindow | undefined

The Electron Browser Window instance.

Tray

The Electron Tray instance.

Positioner

The Positioner instance used to compute the window’s on-screen coordinates.

Methods

Method	Description
`setOption(option, value)`	Change an option after menubar is created.
`getOption(option)`	Get a menubar option.
`showWindow()`	Show the menubar window.
`hideWindow()`	Hide the menubar window.
`toggleWindow()`	Show the window if hidden, hide it if visible.
`recenterOnTray()`	Re-center the window over the tray icon.
`setContextMenu(menu)`	Replace the tray context menu (auto-re-publishes on Linux).
`refreshContextMenu()`	Re-publish the current context menu after mutating its items in place. Required on Linux, a no-op elsewhere.
`setGlobalShortcut(accelerator)`	Register a global accelerator that toggles the window. Returns `false` on registration failure.
`destroy()`	Tear down the menubar instance.
`isDestroyed()`	Whether the menubar is currently destroyed.

On macOS, show the window with showWindow() rather than window.show() or window.showInactive(), so it rejoins all workspaces when showOnAllWorkspaces is enabled.

Example

const { menubar } = require('electron-menubar');

const mb = menubar({ globalShortcut: 'CommandOrControl+Shift+M' });

mb.on('ready', () => {
  mb.setOption('hideOnBlur', false);
  mb.showWindow();
});

// Later, clean up listeners and the global shortcut.
mb.destroy();

Get Started

Guides

API Reference

Platforms

Menubar class: properties and methods reference

Properties

Methods

Example