@liberation-data/desk 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,4 @@
+desk
+Copyright 2026 Jasper Blues
+
+This product is licensed under the Apache License, Version 2.0.

package/README.md

@@ -0,0 +1,436 @@
+# desk
+
+A desktop for the web, in React: windows that fill the desk, layered, and arrange when asked.
+
+```bash
+npm install @liberation-data/desk
+```
+
+## Window manager defaults
+
+Every window opens filling the desk, over the ones already open, and keeps filling it when the browser
+resizes. Nothing is laid out behind anyone's back.
+
+**Window → Arrange** (⌥⌘A) lays the open windows out once: two side by side, three one tall and two stacked,
+four a grid. After that they are ordinary windows. Move or resize one and only that one changes.
+
+Drag a window by its title bar to free it where it sits. Drop it against the left or right edge and it takes
+that half. Resize from the sides, the bottom or the corner. Double-click the title bar, or press the green
+control, to fill the desk and back.
+
+## Use it
+
+```tsx
+import { createDesk } from '@liberation-data/desk'
+import { Desktop, DeskProvider } from '@liberation-data/desk/react'
+import '@liberation-data/desk/desk.css'
+
+const desk = createDesk()
+
+export function App() {
+  return (
+    <DeskProvider desk={desk}>
+      <button onClick={() => desk.open('notes')}>Notes</button>
+      <Desktop
+        title={id => TITLES[id]}
+        renderWindow={id => SURFACES[id]}
+        empty={<p>Nothing open</p>}
+      />
+    </DeskProvider>
+  )
+}
+```
+
+Two windows onto the same thing are the same kind with different ids: `desk.openInstance('query')` gives
+`query`, then `query#2`. `windowType(id)` says what to render; the whole id says which one it is.
+
+A window's code can wait until the window opens, and each window loads and fails on its own:
+
+```tsx
+const RoutePlanner = lazyWindow(() => import('./apps/RoutePlanner'))
+```
+
+While it loads, that window says so and the rest of the desk carries on; if it cannot open, that window says
+what went wrong and offers Reload, which tries the import again rather than remembering the failure.
+`<Desktop loading={…} failed={…}>` replaces the wording.
+
+`renderWindow` is called with a window's id. The desk never owns your content, and a window keeps its DOM
+when focus moves, so scroll positions, carets and iframes survive.
+
+## Touch: one window at a time
+
+`<Desktop layout="auto">` (the default) reads the device. A touch screen that cannot hover gets
+`fullscreen`: the key window fills the stage, the dock stays as the way to switch, and windows are not
+moved or arranged. Windows you are not looking at stay mounted — their drafts, scroll positions and carets survive —
+and are simply offstage and `inert`. A tablet with a trackpad reports a fine pointer, so it gets the
+desktop. Pass `layout="desktop"` or `layout="fullscreen"` to decide for yourself.
+
+Links work the same everywhere: a link opens the same windows, shown one at a time on touch.
+
+## Dock
+
+```tsx
+import { Dock, dockItem, dockSeparator, dockStack } from '@liberation-data/desk/react'
+
+<Dock
+  entries={[
+    dockItem({ id: 'rides', label: 'Rides', icon: <RideIcon /> }),
+    dockItem({ id: 'service', label: 'Service', icon: <WrenchIcon />, badge: 2 }),
+    dockSeparator('stacks'),
+    dockStack({ id: 'plan', label: 'Plan', items: [routes, weather, calendar] }),
+  ]}
+/>
+```
+
+An item opens the window with its id (or `window`), and shows a dot while that window is open. A stack fans
+its items out above the dock and previews the first four icons. `onSelect` replaces opening a window.
+
+The dock is one tab stop: arrow keys move along it, Enter opens, Escape folds a stack away and returns focus
+to it. With `placement="overlay"` (the default) it floats over the bottom of its positioned parent; set
+`--desk-inset-bottom` so windows stop above it.
+
+## Controls
+
+```tsx
+import { Button, SegmentedControl, TextField, Toggle } from '@liberation-data/desk/react'
+
+<Button intent="default" onClick={save}>Save ride</Button>
+<SegmentedControl label="Filter by bike" options={BIKES} value={bike} onChange={setBike} />
+<Toggle checked={metric} onChange={setMetric} label="Kilometres and metres" description="Off shows miles" />
+<TextField label="Wheel size" value={wheel} onChange={e => setWheel(e.target.value)} error={wheelError} />
+```
+
+Each control carries its own behaviour and accessibility; the look comes only from tokens, and there are few
+style props on purpose. `intent="default"` marks the one action a view leads with. A segmented control is one
+tab stop whose arrow keys move the selection past disabled options. A toggle is a `switch` for settings that
+apply at once — a checkbox is for one that waits for Save. A text field always has a label (`labelHidden`
+keeps it for screen readers), and an `error` marks it invalid and replaces the help text. A choice group
+is the handful of cards a setup step turns on — an icon, a label, a line of why — with native radios
+underneath, so it is one tab stop and the arrow keys move the choice.
+
+## Setup assistant
+
+```tsx
+const steps: WizardStep[] = [
+  { id: 'welcome', name: 'Welcome', title: 'Welcome to the garage', continueLabel: 'Get started' },
+  { id: 'rider', name: 'Rider', title: 'Who is riding?', complete: name.length > 1, body: <TextField … /> },
+  { id: 'weather', name: 'Weather', title: 'Connect a weather service', complete: key.length > 0,
+    continueLabel: 'Connect', busyLabel: 'Checking the key…', onContinue: checkKey,
+    skip: { label: 'Set up later', onSkip: skipWeather } },
+  { id: 'finishing', name: 'Finishing', title: 'Setting up', working: true, complete: done, onEnter: install },
+]
+
+<Wizard steps={steps} index={index} onIndexChange={setIndex} onFinish={start} />
+```
+
+One pane, one question at a time, Back and Continue where the eye already is. `complete` gates Continue, so
+a step cannot be passed until it is answered; `skip` is the quiet way past a step that can wait; `working`
+is a step with nothing to do but wait, which offers no Back. `onContinue` is the work Continue does before
+moving on — create the account, check the key: while it runs Continue shows `busyLabel` and nothing can be
+pressed twice; throw to stay on the step with the message shown in it, or return `false` to stay quietly.
+Focus moves to each step's heading as it arrives, so it is announced — and only when the step changes, so a
+field in the pane keeps what is typed.
+
+```tsx
+const setup = useTasks([
+  { id: 'profile', name: 'Save your profile', run: () => saveProfile(profile) },
+  { id: 'rides', name: 'Import your rides', run: async report => { for await (const n of importRides()) report(`${n} of 24`) } },
+])
+
+{ id: 'finishing', name: 'Finishing', title: 'Setting up', working: !setup.failed, complete: setup.done,
+  onEnter: setup.restart, body: <Checklist items={setup.items} onRetry={setup.start} /> }
+```
+
+The jobs a setup does while someone watches run in order. Each says how it is getting on (`report`), and one
+that throws stops the rest and shows why, with **Try again** picking up from the task that failed rather than
+from the top. `working: !setup.failed` gives the step its Back again once something has gone wrong.
+
+```tsx
+const progress = useSetupProgress({ key: 'garage', initial: { rider: '', bikes: [] }, store: serverStore })
+if (!progress.loaded) return null
+if (!progress.finished) return <Wizard index={progress.index} onIndexChange={progress.setIndex} onFinish={progress.finish} … />
+```
+
+Setup is remembered: closing the tab on step four resumes on step four, and a finished setup is not shown
+again until `reset()` ("Set up again"). The store is the app's to choose — this browser's local storage by
+default, or a `SetupStore` with `load`, `save` and `clear` that talks to a server. Keep answers to what a
+person would mind retyping; never a password or a key.
+
+## Tours
+
+```tsx
+const TOUR: Tour = {
+  id: 'first-look',
+  name: 'What needs doing',
+  description: 'A minute on where the jobs are and what wore out.',
+  steps: [
+    { window: 'service', point: 'service-chain', caption: 'Service lists what the bikes need.' },
+    { window: 'rides', caption: 'Choose a ride in the table.', yourTurn: true, until: 'ride.selected' },
+    { window: 'chat', caption: 'Ask which job to do first.', yourTurn: true },
+  ],
+}
+
+{touring && <TourBar tour={TOUR} offer={firstRun} onFinish={done} onStop={done} />}
+```
+
+A tour drives the desk: each step opens the window it is about and points at the control it is talking
+about (`point` is a `data-tour` name or any selector), so the person watches the real app rather than
+reading about it. A `yourTurn` step hands over and waits, offering Done and Skip. Give it `until` — an event
+topic, or a topic and a test — and it moves on by itself when the person has done it, with no Done to press.
+`offer` asks first ("Show me" or "Not now") and opens nothing until the person says yes: use it the first time
+someone reaches the desktop, straight after setup, so nobody lands there without a word. The bar holds no
+content: the steps are the app's.
+
+## Dragging between windows
+
+```tsx
+// In the list — one source, because a hook cannot be called per row
+const rides = useDragSource<Ride>({ type: 'ride' })
+<Table rowProps={row => rides.dragProps(row, row.name)} … />
+
+// In the map
+const { dropProps, over, ready } = useDropTarget<Ride>({ accepts: 'ride', onDrop: ({ payload }) => draw(payload) })
+<div {...dropProps}>{ready && <p>Drop a ride here</p>}</div>
+```
+
+Built on Pointer Events, so touch and pen work the same way, the preview is drawn by us, and Escape calls
+the drag off. A drag carries a `type` and a `payload` and says which window it came from; a target says which
+types it takes and lights up while something acceptable is in the air. Dropping brings the window that took
+it forward. `useDraggable` is the single-item form of the same thing.
+
+## Generated apps
+
+A self-contained page — the kind an assistant writes when asked for an app — can run in a window and take
+part like any other:
+
+```tsx
+<AppFrame
+  title="Ride Card"
+  srcDoc={withAppBridge(generatedHtml)}
+  listens={['ride.selected']}   // what it may hear
+  says={['ride.selected']}      // what it may say
+  accepts="ride"                // what may be dropped on it
+  opens={['map']}               // windows it may ask for
+/>
+```
+
+Inside the page, the bridge gives it a small `desk` object: `desk.on(topic, …)`, `desk.onDrop(…)`,
+`desk.publish(topic, payload)` and `desk.open(window)`. The page runs sandboxed with no access to the host's
+origin, and talks only through messages. The host grants each app its topics, drop types and windows;
+anything else it sends is dropped, and messages from anywhere but its own frame are ignored.
+
+## Search
+
+```tsx
+import { SearchPalette, windowResults } from '@liberation-data/desk/react'
+
+<SearchPalette open={open} onOpenChange={setOpen} search={query => [
+  ...windowResults(desk, titleOf),
+  ...rides.filter(matching(query)).map(asResult),
+]} />
+```
+
+The app says what the results are; the palette does the typing, grouping, keyboard and choosing. It binds
+`mod+k` and answers the `desk.search` command, so a menu item can open it too (pass `shortcut={null}` when
+the menu binds the key itself). An async `search` is safe: a slower answer to an older query never overtakes
+a newer one.
+
+## Typing into the window you are in, and windows telling each other
+
+One bar to type into, which reaches whichever window is key:
+
+```tsx
+// In a window: take the text while this window is in front.
+useWindowInput(setFilter, { placeholder: 'Filter rides by name…', target: 'Rides' })
+
+// In the shell: the bar, and what happens when no window takes the text.
+<InputBar onSubmit={askTheAssistant} fallbackPlaceholder="Ask anything…" fallbackTarget="Chat" />
+```
+
+The bar is **summoned** (⌘J by default) and opens over the middle of the screen, the way Spotlight does;
+Escape dismisses it, and sending closes it. `mode="inline"` puts it wherever you like instead. Either way it
+asks the responder chain how to present itself, so its placeholder and the *goes to* line follow the key
+window, and a window that registers nothing lets the fallback have the text.
+
+Windows tell each other what happened rather than calling each other:
+
+```tsx
+const publish = usePublish()                 // stamped with the window it came from
+publish('ride.selected', ride)
+
+useDeskEvent<Ride>('ride.selected', event => show(event.payload), { replay: true })
+```
+
+Topics are dotted names; a subscriber can take a branch with `ride.*` or everything with `*`. A desk
+carries its own bus, so this needs no extra provider. `replay`
+delivers the last event on the topic straight away — the window that the event concerns is often opened by
+that very event, and would otherwise miss it by a frame.
+
+## Conversation
+
+```tsx
+import { Composer, Thread } from '@liberation-data/desk/react'
+
+<Thread messages={messages} me="me" typing={thinking} onRetry={resend} />
+<Composer value={draft} onChange={setDraft} onSubmit={send} busy={thinking} onStop={cancel} />
+```
+
+Presentational only: no transport, and no opinion about who is answering. The thread groups a run of
+messages from one author, marks yours apart, shows `sending` and `failed` states with Retry, and follows the
+conversation only while you are at the end of it — scroll back and new messages become a *2 new messages*
+button instead of yanking you away. The composer grows with the text, sends on Enter, keeps Shift+Enter for
+a new line, never sends mid-composition in an input method, and turns Send into Stop while an answer is
+arriving.
+
+## Lists and choices
+
+```tsx
+<Table label="Rides" rows={rides} columns={COLUMNS} rowId={r => r.id}
+       selected={selected} onSelect={choose} onActivate={open}
+       sort={sort} onSortChange={setSort} empty={<p>No rides yet</p>} />
+
+<Sidebar label="Bikes" sections={SECTIONS} value={bike} onChange={setBike} />
+
+<PopUpButton label="Distance" options={UNITS} value={units} onChange={setUnits} />
+<Checkbox checked={commutes} onChange={setCommutes} label="Count commutes towards wear" />
+<Slider label="Warn at" value={90} onChange={setThreshold} format={v => `${v}% worn`} />
+```
+
+A **table** renders what it is given — no paging, no fetching — and is one tab stop: arrow keys move the
+selection, Enter or a double click opens a row, and a sortable heading says which way it is sorted. A
+**sidebar** is navigation, so where you are is `aria-current` and stays put. A **pop-up button** is what a
+segmented control becomes when there are too many options to show at once; unlike a menu it takes focus, and
+typing jumps to an option. A **checkbox** is for a setting that waits for Save (a Toggle applies at once),
+and can stand for a mixed set. A **slider** reads its value in words for people who cannot see it.
+
+## Overlays
+
+Least interrupting to most (see [HIG.md](HIG.md) §7):
+
+```tsx
+import { Alert, Popover, Sheet, ToastProvider, useToast } from '@liberation-data/desk/react'
+
+<Popover open={open} onOpenChange={setOpen} label="More filters"
+         trigger={props => <Button {...props}>Filters</Button>}>…</Popover>
+
+<Sheet open={exporting} onDismiss={cancel} title="Export rides" actions={…}>…</Sheet>
+
+<Alert open={confirming} title="Clear these notes?" confirmLabel="Clear notes" destructive
+       onConfirm={clear} onCancel={stop} />
+
+const toast = useToast()
+toast.show({ message: 'Ride deleted', action: { label: 'Undo', onSelect: restore } })
+```
+
+A **popover** belongs to one control and closes when you press outside. A **sheet** belongs to one window
+and blocks only that window — it renders inside it, so the rest of the desk stays usable. An **alert** stops
+the app and is for what cannot be undone; Cancel comes before the action, and a destructive action is never
+the default button. A **toast** interrupts nothing, carries Undo, and waits while the pointer or focus is on
+it. All three overlays trap focus, give it back on close, and answer Escape topmost-first.
+
+## Menu bar
+
+```tsx
+import { MenuBar, menuAction, menuCommand, menuSeparator, windowMenuItems } from '@liberation-data/desk/react'
+
+<MenuBar
+  leading={<AppMark />}
+  menus={[
+    { id: 'app', label: 'Garage', items: [menuAction('About Garage', showAbout), menuSeparator(),
+                                           menuCommand('Settings…', 'app.settings', { shortcut: 'mod+comma' })] },
+    { id: 'window', label: 'Window', items: () => [                // a function: re-read each time it opens
+        menuCommand('Arrange', DeskCommands.arrange),
+        menuSeparator(),
+        ...windowMenuItems(desk.getState(), desk.focus, titleOf),
+    ] },
+  ]}
+  status={[{ id: 'service', label: 'Service, 2 due', title: <WrenchWithBadge />, items: dueItems }]}
+  trailing={<Clock />}
+/>
+```
+
+A `menuCommand` is enabled when something in the responder chain can perform it right now, and chooses the
+same responder a shortcut would: opening a menu never takes focus from the window you were working in. Menus
+own their shortcuts, as in AppKit — a command item's `shortcut` is shown and bound. Keyboard: Tab reaches
+the bar, arrow keys move between menus and items (skipping separators and disabled items), a letter jumps
+to an item, Enter chooses, Escape closes.
+
+## Commands and the responder chain
+
+Some commands name no target — Copy, Close, Find. They go to whoever is responsible, the way AppKit's
+responder chain works: the focused element, then its window, then the stage, then the app.
+
+```tsx
+function RideList() {
+  const [selection, setSelection] = useState<Ride[]>([])
+  // Inside a window this answers when that window is key.
+  useCommand('edit.copy', () => copyRides(selection), { enabled: selection.length > 0 })
+  …
+}
+
+const perform = usePerform()        // perform('edit.copy') → true if something handled it
+const canPerform = useCanPerform()  // what a menu asks before drawing the item enabled
+useShortcuts(KEYMAP)                // { 'mod+c': 'edit.copy', 'mod+shift+z': 'edit.redo' }
+```
+
+`isInstalledApp()` says whether the app is running installed rather than in a tab. Only then may it take
+shortcuts the browser owns: ⌘W for close window and ⌘\` for next window, and never ⌘T or ⌘N at all.
+
+The chain is the DOM: commands travel as events that bubble from the focused element, so there is no second
+tree to keep in step. The first responder that implements a command decides — if it is disabled, the
+command stops there. `mod` means ⌘ on Apple devices and Ctrl elsewhere; a shortcut nothing handles leaves
+the browser's default alone. The desk answers `DeskCommands` (close, zoom, arrange, next and previous
+window) at the stage, and any window can override them.
+
+## The core has no React in it
+
+`createDesk()` returns a plain object. Anything can drive it — a router, a tour, a keyboard shortcut, a
+test:
+
+```ts
+const { open, focus, close, float, fill, toggleMode, closeAll, subscribe, getState } = createDesk()
+```
+
+State is immutable. `windows` is the order windows were opened, which is the order Arrange lays them out,
+so focusing never reshuffles them. `stack` is back to front; `focusedId(state)` is its last entry.
+
+## Links and Back
+
+```ts
+import { syncWithLocation } from '@liberation-data/desk'
+
+const stop = syncWithLocation(desk, () => stageSize(), { isKnown: id => id in SURFACES })
+```
+
+The hash carries which windows are open, which float, and which has focus — `#w=notes,clock~&f=clock` —
+but never positions: a shared link opens the same things, not someone else's layout on a different
+screen. Opening or closing a window pushes a history entry, so Back closes it; focus and mode changes
+replace the entry. Other hash parameters are left alone.
+
+## Theming
+
+Every value in `desk.css` reads a `--desk-*` custom property. Redefine the tokens; don't override the
+selectors. Light and dark follow `prefers-color-scheme`, and `data-theme="light|dark"` on the root wins.
+
+## Docs
+
+- [docs/guide.md](docs/guide.md) — building an app with it, and what catches people out
+- [llms.txt](llms.txt) — the whole public surface in one file, for a coding agent
+- [HIG.md](HIG.md) — how an app built with it should look and behave
+
+## Develop
+
+```bash
+npm install
+npm test            # vitest
+npm run typecheck
+npm run example     # the Garage sample in examples/garage
+npm run size        # the gzipped budget: core 10 KiB, react 46, css 10
+npm run check       # everything CI runs
+npm run check:browser   # the generated-app bridge in real Chrome, against a running sample
+npm run build       # dist/
+```
+
+## Licence
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).