@labpane/os 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,178 @@
-# Temporary Holding Version
+# @labpane/os
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A browser-tab workspace for React. Tabs can be reordered, dragged into new panes, split left, right, or below, and resized, with full keyboard support. It depends only on React and ships its own plain CSS.
+
+```sh
+npm install @labpane/os
+```
+
+## Quick start
+
+```tsx
+import { useState } from "react";
+import { Workspace, type Layout, type WorkspaceTab } from "@labpane/os";
+import "@labpane/os/styles.css";
+
+const initial: WorkspaceTab[] = [
+  { key: "inbox", label: "Inbox" },
+  { key: "reports", label: "Reports" },
+];
+
+export function App() {
+  const [tabs, setTabs] = useState(initial);
+  const [active, setActive] = useState<string | undefined>("inbox");
+  const [layout, setLayout] = useState<Layout>({
+    id: "main",
+    tabs: initial.map((tab) => tab.key),
+    active: "inbox",
+  });
+
+  return (
+    <div style={{ height: "100vh" }}>
+      <Workspace
+        tabs={tabs}
+        active={active}
+        onSelect={setActive}
+        onClose={(key, next) => {
+          setTabs((tabs) => tabs.filter((tab) => tab.key !== key));
+          setActive((current) => (current === key ? next : current));
+        }}
+        layout={layout}
+        onLayoutChange={setLayout}
+        empty={() => <p>No tabs open</p>}
+      >
+        {(tab) => <h1>{tab.label}</h1>}
+      </Workspace>
+    </div>
+  );
+}
+```
+
+The workspace owns no state: you keep the tabs, the active tab, and the layout, so they can live in your router, store, or URL.
+
+## Tabs
+
+Each tab is a `WorkspaceTab`:
+
+| Field       |                                                                        |
+| ----------- | ---------------------------------------------------------------------- |
+| `key`       | Unique id                                                              |
+| `label`     | Text on the tab                                                        |
+| `icon`      | Optional icon before the label                                         |
+| `actions`   | Buttons shown at the end of the pane's toolbar while the tab is active |
+| `href`      | Makes the tab a real link, so middle-click and copy link work          |
+| `scrollKey` | The panel scrolls to the top when this changes                         |
+| `opener`    | Key of the tab that opened it; closing returns there                   |
+| `fill`      | Removes the panel padding, for full-bleed content such as a terminal   |
+
+Tabs whose content has unsaved changes call `useUnsavedChanges(true)`. Closing one asks first: through `confirmClose` if you pass it, and the browser's `confirm` otherwise. The page also warns before unloading.
+
+## Slots
+
+The workspace renders no menus or buttons of its own. You fill these slots with your own components, or with `@labpane/ui`:
+
+| Prop                                       |                                                                                                                                      |
+| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `toolbar(pane)`                            | Content at the end of each pane's toolbar, such as an "open a tab" button                                                            |
+| `menu(target, actions, restoreFocus, tab)` | Wraps a tab, or a divider, in your context menu. `actions` are the workspace's own (move, split, close); add your own for that `tab` |
+| `confirmClose(tab)`                        | Asks before closing a tab with unsaved changes; return or resolve `true` to close                                                    |
+| `leading`                                  | Content at the top left of the workspace, such as an app menu                                                                        |
+| `trailing`                                 | Content pinned to the top right corner, such as window buttons; the top-right pane keeps room for it                                 |
+
+## Layout
+
+`layout` is a tree of panes and splits:
+
+```ts
+type Pane = { id: string; tabs: string[]; active?: string };
+type Split = {
+  id: string;
+  axis: "x" | "y";
+  ratio: number;
+  first: Layout;
+  second: Layout;
+};
+type Layout = Pane | Split;
+```
+
+`restoreLayout`, `reconcileLayout`, `dockTab`, and `panes` help you save, repair, and inspect layouts, for example after restoring one from storage.
+
+## Size
+
+`density` scales the workspace from 0 (dense) to 100 (comfortable). `densitySize(density)` returns the matching tab height, logo size, and gaps. The workspace also sets `--lab-tab-height` and `--lab-logo-size` on its element for content placed in its slots.
+
+`WorkspaceFrame` wraps a workspace in a centred frame that users can resize or expand to full width.
+
+## Desktop windows
+
+To run the workspace in a frameless desktop window (Wails, Tauri, Electron, or your own shell), describe the window as a `WindowHost` and the workspace becomes its title bar:
+
+```tsx
+import {
+  WindowControls,
+  useFullscreen,
+  useWindowFrame,
+  type WindowHost,
+} from "@labpane/os";
+
+const host: WindowHost = {
+  platform: "windows", // or "macos" or "linux"
+  minimize: () => shell.minimize(),
+  toggleMaximize: () => shell.toggleMaximize(),
+  close: () => shell.close(),
+  drag: () => shell.startDrag(), // optional
+  resize: (edge) => shell.startResize(edge), // optional, for windows without a native frame
+  fullscreen: (on) => shell.setFullscreen(on), // optional
+};
+
+function App() {
+  const [fullscreen] = useFullscreen(host);
+  useWindowFrame(host);
+  return (
+    <Workspace
+      leading={
+        host.platform === "macos" &&
+        !fullscreen && <div style={{ width: 72 }} />
+      }
+      trailing={<WindowControls host={host} />}
+      // ...
+    />
+  );
+}
+```
+
+- `WindowControls` are Windows-style minimise, maximise, and close buttons, flush in the window's top-right corner and reaching down to the top pane. They hide on macOS, which keeps its own traffic lights, and in full screen.
+- `useWindowFrame` moves the window when an empty part of a toolbar is dragged, maximises it on a double click, resizes it from its edges, and toggles full screen with F11, or Ctrl+Cmd+F on macOS. Add `data-window-drag` to other elements that should move the window.
+- `useFullscreen(host)` returns `[fullscreen, setFullscreen]`. Without a host it uses the browser's Fullscreen API.
+
+## Keyboard
+
+- Left and Right move between tabs, Home and End jump to the first and last, and Space selects
+- Alt+Left and Alt+Right move the focused tab
+- Alt+Shift+Left, Right, or Down split the focused tab into a new pane on that side
+- Delete closes the focused tab
+- F6 moves between panes
+- Arrow keys on a divider resize the panes beside it
+
+## Theming
+
+Set these on `:root`, or on any ancestor of the workspace. Add a `dark` class to an ancestor for the dark defaults.
+
+```css
+:root {
+  --lab-font-sans: inherit;
+  --lab-background: #f4f1ea;
+  --lab-foreground: #242424;
+  --lab-card: #ffffff;
+  --lab-muted-foreground: #626262;
+  --lab-accent: #e6e6e6;
+  --lab-border: #d6d6d6;
+  --lab-ring: #1d9db4;
+}
+```
+
+All classes start with `lab-` and the CSS has no global rules, so it doesn't affect the rest of your page.
+
+## License
+
+MIT

package/dist/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Authors of Labpane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.