Skip to content

gpui: set and clear the dock icon's badge - #16

Open
Cyberistic wants to merge 2 commits into
remorses:gpuixfrom
Cyberistic:feat/dock-badge
Open

Cyberistic wants to merge 2 commits into
remorses:gpuixfrom
Cyberistic:feat/dock-badge

Conversation

@Cyberistic

@Cyberistic Cyberistic commented Oct 25, 2026 •

Copy link
Copy Markdown

depends on #15

add badge number thingy to icons in mac.
tested in mac only (obv)

slop below:

App::set_dock_badge(label) writes the label macOS draws on the dock icon, and
None clears it. Platform::set_dock_badge is a documented no-op by default:
Windows and Linux have no badge on a taskbar or notification-area icon, so there
is nothing to draw and no honest approximation to fake.

The label belongs to the dock tile (crates/gpui_macos/src/dock.rs), so an app
without a dock icon — a menu-bar-only app on ActivationPolicy::Accessory — has
nowhere to show it. That is a platform constraint, documented on the method
rather than worked around by forcing a policy.

crates/gpui/examples/tray.rs gains two menu entries that set the badge to 3
and clear it, so the behaviour is one click away when running the tray example.

Adds `App::create_tray`, `App::on_tray_event`, `App::keep_running`, and
the `TrayOptions`, `TrayMenuItem`, `TrayEvent` and `TrayHandle` types.

Tray events never reach the application from a native callback: AppKit's
menu tracking, the Windows message loop and the Linux tray service only
fill a channel, and the foreground task built by `App::on_tray_event`
drains it with an unborrowed App. `App::keep_running` is the tray's
companion: it keeps the process alive when the last window closes.

macOS backs the items with an `NSStatusItem` in the menu bar, Windows
with `Shell_NotifyIconW` and a hidden message window, and Linux with a
StatusNotifierItem through `ksni`, which also serves the dbusmenu.
`set_title` is macOS-only and `set_tooltip` maps to each platform's
nearest equivalent; both are documented as no-ops where unsupported.
Adds `App::set_dock_badge`, which writes the label macOS draws on the dock
icon and clears it with `None`. The platform method is a no-op by default:
Windows and Linux have no badge on a taskbar or notification-area icon, so
there is nothing to draw.

The label lives on the dock tile, so a menu-bar-only app
(`ActivationPolicy::Accessory`) has no icon to badge. The tray example gains
entries that set and clear it.
@Cyberistic
Cyberistic marked this pull request as ready for review October 25, 2026 04:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant