Tray

System tray icon with an optional dropdown menu.

Config key	tray
JS namespace	Tray
Core	No
Phases	Bindable
Hard deps	—
Soft deps	event (menu item clicks emitted as events when event is active)
Platforms	macOS · Linux · Windows

Tray has a soft dependency on event. When event is active, tray icon clicks and menu item selections emit events automatically. When event is absent, use the Crystal-side callbacks in the opts.tray block instead.

---

Click model

Per click direction (left or right), the first rule that matches wins:

1. User override set (on_click / on_right_click) — fires the callback. Full takeover.
2. Click listed in toggle_window_on — toggles the window (positioned relative to the tray icon on macOS + Windows).
3. A menu is set — pops it up.
4. Otherwise — emits trayEvent with payload "left_click" or "right_click".

Left and right are independently configurable. Setting a menu wires it to both clicks (rule 3) unless that click is captured by an earlier rule.

---

Crystal options

Configure the tray in the Lune.run block:

Lune.run(app) do |opts|
  opts.tray do |t|
    # Optional: which clicks toggle the window relative to the tray icon
    # (macOS positions below the menu-bar icon, Windows above the taskbar icon).
    t.toggle_window_on = [:left_click]

    # Optional: custom Crystal callbacks (override every default for that click).
    t.on_click       = -> { puts "left clicked" }
    t.on_right_click = -> { puts "right clicked" }
    t.on_menu_click  = ->(id : String) { puts "menu: #{id}" }

    # Optional: override the event name used when emitting via event.
    t.event = "myTrayEvent"  # default: "trayEvent"

    # Optional: show the tray icon at boot without a JS `lune.Tray.show("")` call.
    # Auto-enabled by `opts.menubar_mode`.
    t.auto_show = true
  end
end

Option	Type	Default	Description
event	String	"trayEvent"	Event name emitted via Event on click / menu select
on_click	-> Nil	—	Crystal callback for left-click (full takeover)
on_right_click	-> Nil	—	Crystal callback for right-click (full takeover)
on_menu_click	String -> Nil	emit menu item id	Crystal callback for menu item selection
toggle_window_on	Array(Symbol)	[]	Clicks that toggle the window. :left_click, :right_click
auto_show	Bool	false	Show the tray icon at boot (set by opts.menubar_mode)

---

JavaScript API

Show the tray icon, set a menu, and handle events:

import { lune } from "../lunejs/runtime/runtime.js";

// Show the tray icon
await lune.Tray.show({ iconPath: "/assets/icon.png" });

// Set a dropdown menu
await lune.Tray.setMenu({
  items: [
    { id: "show", label: "Show window" },
    { id: "---", label: "" }, // separator
    { id: "quit", label: "Quit" },
  ],
});

// Listen for tray events (requires event)
lune.Event.on("trayEvent", (payload) => {
  if (payload === "left_click") console.log("plain left click");
  if (payload === "right_click") console.log("plain right click");
  if (payload === "show") lune.Window.show();
  if (payload === "quit") lune.System.quit();
});

// Open the menu programmatically (no-op if no menu set)
await lune.Tray.popupMenu();

// Update the icon dynamically
await lune.Tray.setIcon({ path: "/assets/icon-active.png" });

// Hide the tray icon
await lune.Tray.hide();

Method	Signature	Returns	Description
show	show({ iconPath })	Promise<void>	Show tray icon from path
hide	hide()	Promise<void>	Hide the tray icon
setIcon	setIcon({ path })	Promise<void>	Swap the icon image
setMenu	setMenu({ items })	Promise<void>	Set the dropdown menu items
popupMenu	popupMenu()	Promise<void>	Open the menu (no-op if not set)

Menu item shape

setMenu takes an array of { id: string; label: string }. The shape is inlined in runtime.d.ts — Lune doesn't ship a named TrayMenuItem interface. Use "---" as the id for a separator.

await lune.Tray.setMenu({
  items: [
    { id: "show", label: "Show window" },
    { id: "---", label: "" }, // separator
    { id: "quit", label: "Quit" },
  ],
});

---

Events

When event is active (the default), tray interactions emit on the bus:

Trigger	Payload
Left-click (no override/toggle/menu)	"left_click"
Right-click (same conditions)	"right_click"
Menu item selected	The id string of the clicked item

Event name defaults to "trayEvent". Override with opts.tray.event:

opts.tray do |t|
  t.event = "app-tray"  # lune.Event.on("app-tray", ...) in JS
end

---

Recipes

Both clicks show the menu (Docker style):

# Nothing to set in Crystal — just call lune.Tray.setMenu from JS.

lune.Tray.setMenu({ items: [{ id: "quit", label: "Quit" }] });

Left toggles window, right shows menu (popover style):

opts.tray.toggle_window_on = [:left_click]

Both clicks open the menu, regardless of overrides:

opts.tray.on_click       = -> { Lune::Native::Tray.popup_menu; nil }
opts.tray.on_right_click = -> { Lune::Native::Tray.popup_menu; nil }

---

Windows notes

Tray ships fully on Windows via Shell_NotifyIconW + CreatePopupMenu + LoadImageW. Three behavioural differences from macOS / Linux to be aware of:

• lune.Tray.setIcon requires a .ico file. Pass a path ending in .ico; PNG / SVG / JPEG fall back to the default Windows app icon (IDI_APPLICATION) and emit a logger.warn. Convert your icon at build time — the bundled assets/lune-logo.ico is a multi-resolution example (16/32/48/64/128/256 px embedded as PNG entries) generated from assets/lune-logo.png.
• opts.tray.toggle_window_on positions the window above the taskbar icon via Shell_NotifyIconGetRect. Returns nil when the icon is in the overflow flyout, in which case the window still shows / hides but isn't repositioned.
• Native context menus render at the cursor position, not anchored to the tray icon (this matches Win32 convention — TrackPopupMenu takes screen coordinates and Lune passes GetCursorPos). The Win32 menu also uses the system's classic submenu style, not the rounded "Mica" popovers you see in some Windows 11 apps — those require Acrylic / DirectComposition work that isn't in scope.

---

Platform notes

• macOS — Verified.
• Linux — Untested. Requires XWayland on Wayland compositors.
• Windows — Verified with caveats. Core functionality (icon, menu, click, right-click) works via Shell_NotifyIconW. setIcon requires .ico (PNG/SVG fall back to default with warning); toggle_window_on positions the window above the taskbar icon via Shell_NotifyIconGetRect; native menus render at cursor position rather than anchored to icon.

---

Disabling

plugins:
  disabled:
    - tray