@dolphinspired/solid-stage — documentation #

Editor-chrome primitives for Solid: 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	Install, mount a stage, render your first field.
Concepts	The mental model: stage, panel, section, control vs field, overlays, the dock model. Read this once.

Reference #

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

Guides #

Doc	What's in it
Guides	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	Configuring Vitest so your app's tests can import the library (the Kobalte .jsx inline recipe + Solid dedupe).
Developing against a local checkout	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	The canonical design record — every decision and its rationale. Read before changing the library.
Feature ideas	Deferred / out-of-scope ideas awaiting a real consumer.
Side-navigation research	Background research for a future activity-bar primitive.
Panel presence and docking research	Background research on collapsed panels, rails and docking.

Using this library through an AI agent? Point it at AGENTS.md in the repo root — a compact briefing of the conventions and the assumptions it can safely make.