phosphor-shell-bar

The spectrum-rail bar surface and its built-in widgets.

The Phosphor.Bar QML module. BarHost is one layer-shell PanelWindow per output: a 2 px spectrum rail on the screen edge over a 26 px band, reserving both as its exclusive zone and taking no keyboard focus. Widgets sit on the band in three Slot regions (left, center, right), and each slot mounts them by id through a widget registry the shell provides, so the bar owns no widget code. A popout hangs from the bar as a pane joined to the rail by a PaneTether. When the placement engine positions the pane as its own toplevel the bar draws only the tether, routed along the rail to where the pane landed; on an output with no placement engine the pane is drawn inside the bar's own surface. The built-in widgets cover the clock, audio, network, Bluetooth, battery, media, tray, CPU and memory, the focused app, and a placement map that replaces the workspace pager, plus the buttons that open the control center, notifications, and power menu.

Full API →

Key types

BarHost
Per-output layer-shell bar: rail, band, three slots, and the anchored pane with its tether.
Slot
One left/center/right region; mounts widget groups by id through the shell's widget registry.
PaneTether
2 px wire from a chip to its pane, routed along the rail when the pane sits elsewhere.
MapPane
Expanded placement map with desktop buttons and the map's layout and algorithm menu.
BarWidget
Base for a widget that collapses to zero width when it has nothing to show.
PlacementMap
Live miniature of this screen's placement geometry, with one tick per virtual desktop.

Dependencies

See also

References