# @dolphinspired/solid-stage — documentation

Editor-chrome primitives for [Solid](https://www.solidjs.com/): collapsible side
panels, collapsible sections, a multi-layer canvas stage, a full set of compact
form controls, and app-level overlays (tooltip / modal / toast). Built for
property-heavy editor UIs — a 3D canvas in the middle, dense settings down the
sides.

## Start here

| Doc | What's in it |
|---|---|
| [Quick start](./quickstart.md) | Install, mount a stage, render your first field. |
| [Concepts](./concepts.md) | The mental model: stage, panel, section, **control vs field**, overlays, the dock model. Read this once. |

## Reference

| Doc | What's in it |
|---|---|
| [Controls & fields](./controls.md) | Every form widget — `TextField`, `NumberField`, `SliderField`, `SelectField`, `SearchField`, the button family, and their bare `*Control` counterparts. |
| [Layout](./layout.md) | `EditorPanels`, `Panel`, `Section`, `Toolbar`, `TitleBar`, `TabMenu`, `CanvasStage`. |
| [State](./state.md) | `createEditorStore` (reactive store + persistence + `bind`) and `createPersistedToggle`. |
| [Overlays](./overlays.md) | The three global singletons: `stageTooltip`, `stageModal`, `stageToast`. |
| [Drag, dock & float](./dnd.md) | Movable sections and floating panels — the dock model. |
| [Theming](./theming.md) | Design tokens, the size tiers, and the CSS conventions. |
| [Icons](./icons.md) | The bundled icon set and the `IconComponent` contract. |

## Guides

| Doc | What's in it |
|---|---|
| [Guides](./guides.md) | **Read before building UI.** Composing a section body, custom CSS, reactive values and `onChange`, choosing a button, toolbars, dock sections, app-wide shortcuts. Then extending the library: custom controls and fields, validation, custom search, deep-linking. |
| [Testing a consumer](./testing.md) | Configuring Vitest so your app's tests can import the library (the Kobalte `.jsx` inline recipe + Solid dedupe). |
| [Developing against a local checkout](./local-development.md) | The `link:` workflow for hacking on the library + your app together — rebuild-`dist`, Solid dedupe, the `stageIcons()` cast (all link-only). |

## For maintainers

| Doc | What's in it |
|---|---|
| [Architecture](./architecture.md) | The canonical design record — every decision and its rationale. Read before changing the library. |
| [Feature ideas](./feature-ideas.md) | Deferred / out-of-scope ideas awaiting a real consumer. |
| [Side-navigation research](./editor-side-navigation-patterns.md) | Background research for a future activity-bar primitive. |
| [Panel presence and docking research](./editor-panel-docking-patterns.md) | Background research on collapsed panels, rails and docking. |

> **Using this library through an AI agent?** Point it at
> [`AGENTS.md`](../AGENTS.md) in the repo root — a compact briefing of the
> conventions and the assumptions it can safely make.