Overlays
Drawer
The mobile bottom sheet, with drag-to-dismiss and background scaling.
Available
Ports as-is
Examples
Rendered live from the maintained Storybook story. Lantern stores only the story id and embeds Storybook rather than duplicating the component or its demo.
Drawer
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.
| Prop | Type | Default | Description |
|---|---|---|---|
...props | React.ComponentPropsWithoutRef<typeof DrawerPrimitive.Overlay> | — | 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/drawer.tsx- Portability
- Copies across unchanged — only the utils import path moves.
- Variants
shouldScaleBackground on/off- States to cover
closedopenheaderfooterdraggingscrolling- Dependencies
vaul- Notes
- Needs a [vaul-drawer-wrapper] ancestor for the background scale to be visible.