@domicile-desktop/manganese

Domicile's reference shell: a tiling desktop with sway's layout and keys, under a transparent top bar.

• The chrome is a React app built from @domicile-desktop/component-library and styled with Panda CSS from the library's preset.
• Each Wayland client is an <app> element. Each browser window is a <webview> under an address bar. Both tile, float and close with the same keys.
• One page spans every monitor. The bar is drawn once per screen; the windows are drawn once for the whole desktop. See ONE-PAGE-FOR-THE-DESK.md.

Configure

A config module exports Shell = runManganese(options) (see WRITING-A-SHELL.md). Every option is optional:

• applications: omit, desktop file IDs the launcher hides, and bookmarks, pages it opens by name. See LAUNCHER.md.
• keybindings: the key table. Defaults to DEFAULT_KEYBINDINGS and DEFAULT_MODES, sway's keys on Meta.
• topBar: the bar's left, middle and right columns. Defaults to DEFAULT_TOP_BAR.

More

• Window management: workspaces, screens, focus, floating, dragging, title bars and animations.
• Keys: default bindings, commands, and the differences from sway.
• The top bar: workspaces, clock, battery, brightness, volume, notifications and tray.
• The launcher, the clipboard and the wallpaper.
• Host readouts: how the backlight and audio are read.
• Custom bar items: styling your own bar items.
• Focus internals.
• Source layout.

Build and run

• bun run turbo build:vite --filter @domicile-desktop/manganese builds the chrome to .vite/renderer/main_window/.
• nix run 'github:cprussin/domicile/stable#manganese' runs it. ./scripts/dev-shell.sh manganese does the same from a checkout.
• bun run --filter @domicile-desktop/manganese start:dev runs it on the pinned engine and a compositor built from the checkout, and rebuilds on edit. To load the rebuilt shell, run domicile load-shell .vite/renderer/main_window/shell.js in a terminal on that desktop.
• styled-system/ is Panda's generated output. bun run prepare makes it, and turbo runs that before build, type check and tests. It is not checked in.

Test

bun run turbo test --filter @domicile-desktop/manganese

Runs the type check, the unit tests and the Vite build. Components render against happy-dom via @domicile-desktop/test-support.