- Home
- Primitives
- Toggle
Toggle
A two-state button that can be toggled on or off.
Preview
This preview uses documentation-only styling. Ship with one of the included recipe outputs (CSS, Tailwind, or UnoCSS) for production styles.
A two-state button that can be toggled on or off.
Usage
Import and render Root.
import * as Toggle from "@solidiom/toggle"
;<Toggle.Root>Toggle content</Toggle.Root>Installation
Install the package with pnpm add @solidiom/toggle. The package requires compatible solid-js and @solidjs/web peer dependencies.
Parts
Toggle exposes 1 part:
- Root —
data-part="root".
Styling
Toggle carries data-scope="toggle" and data-part attributes on each part for CSS/recipe targeting. State attributes like data-state, data-disabled, and data-highlighted are exposed where applicable.
Keyboard & behavior
This primitive has no keyboard interaction. It renders content that does not independently receive focus or respond to key events.
SSR and hydration
Toggle renders as semantic HTML during server rendering. Interactive behavior (keyboard handlers, state management) activates on hydration without layout shift.