Skip to content

docs: keep the title plain and emoji every section heading #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
setchy merged 4 commits into from
Oct 14, 2026
Merged

docs: keep the title plain and emoji every section heading #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
28b9486
docs: add emoji headings to the README
setchy Oct 14, 2026
34ec1b8
docs: keep the title plain and emoji every section heading
setchy Oct 14, 2026
175af38
docs: keep the title plain and emoji every section heading
setchy Oct 14, 2026
89daab2
Update header in README.md to use emoji
setchy Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Before opening issues
## 🐛 Before opening issues

**If you are asking a question**:

Expand All @@ -16,7 +16,7 @@ Please provide the following information when opening issues:

Thanks!

## Releases
## 🚢 Releases

Releases are automated with [release-please](https://github.com/googleapis/release-please) and driven entirely from [Conventional Commits](https://www.conventionalcommits.org/) on `main`:

Expand Down
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

<br />

## Features
## 📦 Features

- ⚡️ Quick start for creating menubar applications using Electron.
- 🚀 Zero runtime dependencies.
Expand All @@ -32,7 +32,7 @@
> [!NOTE]
> On native Wayland, the desktop compositor controls window placement, so the popover cannot be anchored to the tray icon and is positioned by the desktop (usually centered). This is a Wayland limitation, not something the library can override. Tray-relative positioning works under X11/XWayland. See [window positioning on Linux][platforms] for the detail and a workaround.

## Why electron-menubar?
## 💡 Why electron-menubar?

`electron-menubar` builds on [max-mapper/menubar][github-upstream-repo], with fixes and controls developed for [Gitify](https://github.com/gitify-app/gitify). The original provides the tray-app foundation. This fork brings more of the platform-specific behavior into the library so applications have less to implement themselves.

Expand All @@ -47,7 +47,7 @@
| Packaging | Zero runtime dependencies, including a built-in positioner. Ships CommonJS and ESM entry points with TypeScript declarations. |
| Verification | Unit tests, native Electron end-to-end tests on macOS, Windows, and Linux, and visual checks that the tray icon and window render. The [platform report][platforms] includes screenshots and positioning limitations. |

### Popup behavior without platform checks
### 🪟 Popup behavior without platform checks

Menubar manages popup stacking and focus on every platform. A plain `menubar()` dismisses on click-away and opens above the Windows hidden-icons panel. To keep it open, change one option:

Expand All @@ -60,20 +60,20 @@ mb.setOption('hideOnBlur', true); // Resume click-away dismissal.

Opening DevTools temporarily keeps the popup open. Closing DevTools restores the latest `hideOnBlur` preference. Options set before window creation also apply when the window is recreated.

#### Migrating from 10.x
#### 🚚 Migrating from 10.x

These defaults apply starting with 11.0.0. Previously, menubar inferred dismissal from `window.isAlwaysOnTop()`. Use `hideOnBlur: false` for persistent popups instead of `browserWindow.alwaysOnTop: true` or runtime `window.setAlwaysOnTop(true)` calls. `browserWindow.alwaysOnTop` now controls stacking only; it does not disable dismissal. Setting `hideOnBlur: false` also keeps the popup on top on macOS and Linux.

Remove Windows `pop-up-menu` workarounds and DevTools focus handlers from apps. Menubar owns stacking during window creation, showing, preference changes, and DevTools transitions. Apps can still customize DevTools dimensions and layout.
See the [changelog](CHANGELOG.md) for released changes and the [API documentation](#api-documentation) for all options.

## Installation
## 🚀 Installation

```bash
pnpm add electron-menubar
```

## Usage
## 🔧 Usage

Starting with your own new project, run these commands:

Expand Down Expand Up @@ -102,17 +102,17 @@ Then use `electron` to run the app:
$ electron myApp.js
```

## Examples
## 📚 Examples

See [`examples`][examples] folder for a selection of working examples.

## API Documentation
## 📖 API Documentation

### `Menubar` Class
### 🧱 `Menubar` Class

The return value of `menubar()` is a `Menubar` class instance, which exposes the following properties and methods.

#### Properties
#### 🧾 Properties

| Property | Description |
| ------------ | ----------------------------------------------------------------------------- |
Expand All @@ -121,7 +121,7 @@ The return value of `menubar()` is a `Menubar` class instance, which exposes the
| `tray` | The [Electron Tray][electron-docs-tray] instance. |
| `positioner` | The `Positioner` instance used to compute the window's on-screen coordinates. |

#### Methods
#### 🧰 Methods

| Method | Description |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------ |
Expand All @@ -137,7 +137,7 @@ The return value of `menubar()` is a `Menubar` class instance, which exposes the
| `destroy()` | Tear down the menubar instance. |
| `isDestroyed()` | Whether the menubar is currently destroyed. |

### `menubar()` Options
### 🎛️ `menubar()` Options

You can pass an optional options object into the `menubar({ ... })` function:

Expand All @@ -163,7 +163,7 @@ You can pass an optional options object into the `menubar({ ... })` function:
| `ignoreDoubleClickEvents` | `true` (macOS only) | Calls `tray.setIgnoreDoubleClickEvents(true)` so an accidental double-click doesn't race the close-on-blur handler and flicker the tray icon. Pass `false` to opt out. No-op on Linux/Windows. |
| `globalShortcut` | | An [Accelerator][electron-docs-accelerator] string registered as a global keyboard shortcut that toggles the menubar window. Unregistered automatically on `destroy()`. Use `mb.setGlobalShortcut(accelerator)` to change or clear it at runtime. |

### Events
### 📡 Events

The `Menubar` class is an event emitter:

Expand All @@ -180,15 +180,15 @@ The `Menubar` class is an event emitter:
| `after-close` | After the `.window` (BrowserWindow) property has been deleted. |
| `focus-lost` | Emitted on click-away when `hideOnBlur` is `false` or DevTools is open. |

## Tips
## 🧠 Tips

- Use `mb.on('after-create-window', callback)` to run things after your app has loaded. For example you could run `mb.window.openDevTools()` to open the developer tools for debugging, or load a different URL with `mb.window.loadURL()`
- Use `mb.on('focus-lost')` if you would like to perform some operation when using the option `hideOnBlur: false`
- To restore focus of previous window after menubar hide, use `mb.on('after-hide', () => { mb.app.hide() } )` or similar
- To attach a native context menu, pass it as `contextMenu`: `menubar({ contextMenu })`. The library wires it via `setContextMenu` on Linux and `popUpContextMenu` on right-click on macOS/Windows so left-click still toggles the window. See [this example][examples-native] for more information.
- To avoid a flash when opening your menubar app, you can disable backgrounding the app using the following: `mb.app.commandLine.appendSwitch('disable-backgrounding-occluded-windows', 'true');`

## Acknowledgements
## 🤝 Acknowledgements

Originally created by [Max][github-upstream-creator] — hard-forked from [max-mapper/menubar][github-upstream-repo].

Expand Down
Loading