Component catalog
Browse the public controls by interaction purpose. Every result links to generated API facts, accessibility behavior, source, and exhaustive stories.
Browse the public controls by interaction purpose. Every result links to generated API facts, accessibility behavior, source, and exhaustive stories.
A reusable single-selection navigation sidebar, preserving the visual language of liquidify-page's docs sidebar without depending on Fumadocs or a router.
import { Sidebar } from "@liquidify/react/sidebar"| Prop | Type | Default | Description |
|---|---|---|---|
| children | ReactNode | undefined | Navigation content and optional direct Header/Footer slots. |
| className | string | undefined | — | Optional additional CSS class merged into the glass surface class. The supported per-instance customisation seam: override any `--lq-*` custom property from this class's CSS — the token cascade the engine reads (ADR-0004). No raw inline style is involved, so this stays ADR-0003 clean. |
| defaultValue | string | null | undefined | null | Initial uncontrolled selection. |
| dir | "auto" | "ltr" | "rtl" | undefined | undefined | Text direction, inherited from the host when omitted. |
| id | string | undefined | undefined | Native root id. |
| onChange | ((value: string | null) => void) | undefined | undefined | Requests the next selection in either mode; unchanged requests are suppressed. |
| ref | Ref<HTMLElement> | undefined | — | Forwarded ref to the rendered element — the component's native root (or the merged child element on a component that opts into {@link SlottableProps}). Generic over `E` (charter `docs/api-conventions.md` §4 rule 1, default `HTMLElement`) so a component with a polymorphic root (Link's navigation / action mode union, Text's `as`) can instantiate the concrete element per variant instead of leaving every consumer with a widened `Ref<HTMLElement>`. A component that does not narrow simply inherits the `HTMLElement` default — source-compatible with every pre-existing non-generic `extends ControlProps`. |
| tint | LiquidTintValue | undefined | — | System-accent of the control — drawn from the RESTRICTED {@link LIQUID_COLORS} palette (the thirteen Apple system colours). **Orthogonal to a component's `variant`**: it recolours the accent the surface draws from (focus ring, tinted fill, selection) without changing its variant. Resolved via `data-tint` attribute selectors in CSS (tokens-only, ADR-0003). |
| value | string | null | undefined | undefined | Controlled selected identity; null explicitly means no selection. |