Skip to content

Actions

Toggle

A two-state button. Pressed state is visual only — it does not submit.
Available
Ports as-is

All variants

Every variant this component declares, rendered together in one frame from its maintained Storybook story. Lantern stores only the story id and embeds Storybook rather than duplicating the component or its demo.

Toggle

Rendered live from Storybook

Storybook must be running for this to load — bun run start:storybook from the monorepo root, or set NEXT_PUBLIC_STORYBOOK_URL to a deployed instance.

Props

The component's public API, read from its TypeScript source. Descriptions come from TSDoc on the prop, so this table cannot drift from the component.

PropTypeDefaultDescription
...propsReact.ComponentPropsWithoutRef<typeof TogglePrimitive.Root> & VariantProps<typeof toggleVariants>—Native attributes are forwarded to the underlying element, along with the ref.

Reference

Transcribed from the component audit. If this disagrees with the source, the source is right.

Source
src/components/ui/toggle.tsx
Portability
Copies across unchanged — only the utils import path moves.
Variants
defaultoutlinesm / default / lg
States to cover
offonhoverdisabledfocus ringicon-only
Dependencies
@radix-ui/react-toggle
Props the port adds
pressed / onPressedChange
Notes
Port alongside ToggleGroup — they share toggleVariants.