Drawer
A panel that slides up from the bottom, for phones.
Left out of Dense data A drawer is for phones. Dense data's experts work at a desk with a mouse and keyboard, and the scheme avoids first-time visitors on phones. Use instead: Sheet, Dialog
See it live
npm run storybookWhen to use it
- Use it when: Filters, details or a short form on a phone, while the page stays partly in view.
- Not when: A blocking decision (dialog), or a wide screen where a side panel fits better (sheet).
Instead:
Words
- Lead with the object, then the state: "Alert 2041 contained."
- Use numbers, not words for numbers.
- One verb per button. No "please", no exclamation marks.
- Use: Investigate, Filter, Assign, Escalated, Resolved. Avoid: Oops, Awesome, Please, Simply.
The labels components use, from the voice tokens:
content.action.commit: Savecontent.action.cancel: Cancelcontent.action.destroy: Deletecontent.action.retry: Retrycontent.action.empty-action: Change filters
See Voice and tone for the whole voice.
Accessibility and keyboard
| Keyboard | What happens | Not |
|---|---|---|
| undefined | Escape closes it. | undefined |
Test before you ship:
- It behaves as a dialog: named, focus moves in and back. undefined
Use it in code
npx open-ds add drawer
The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.
Tokens it reads
Drawer reads 14 tokens of its own, each an alias of a semantic token. Each row is one part: its own token, the semantic it aliases, and the value it ends at. Change a semantic and every component that reads it follows; override one of Drawer's tokens to change Drawer alone.
Dense data decides what changes when you switch theme. Here a switch changes colors only, so the marked rows differ between light and dark; everything else holds steady.
| Part | Its token and the semantic it aliases | Value |
|---|---|---|
| Shared | ||
| Transition panels duration | component.transition.panels-durationmotion.duration.panelsvar(--transition-panels-duration) | duration.fast:120ms |
| Overlay | ||
| Fill Changes with theme | component.drawer.overlay.backgroundcolor.surface.scrimvar(--drawer-overlay-background) | Lightblack.light.scrim:#0000008CDarkblack.dark.scrim:#000000B3 |
| Content | ||
| Fill Changes with theme | component.drawer.content.backgroundcolor.surface.canvasvar(--drawer-content-background) | Lightslate.light.50:#F7F8FADarkslate.dark.0:#0D1117 |
| Drawer | ||
| Corner | component.drawer.radiusradius.roundvar(--drawer-radius) | radius.full:9999px |
| Fill Changes with theme | component.drawer.backgroundcolor.surface.sunkenvar(--drawer-background) | Lightslate.light.100:#EEF1F5Darkslate.dark.100:#262D38 |
| Header | ||
| Gap | component.drawer.header.gapcomponent-spacing-map.hairlinevar(--drawer-header-gap) | space.2:0.125rem |
| Padding | component.drawer.header.paddingspace.inset.containervar(--drawer-header-padding) | space.16:1rem |
| Gap 2 | component.drawer.header.gap-2component-spacing-map.x2var(--drawer-header-gap-2) | space.8:0.5rem |
| Footer | ||
| Gap | component.drawer.footer.gapspace.gap.defaultvar(--drawer-footer-gap) | space.8:0.5rem |
| Padding | component.drawer.footer.paddingspace.inset.containervar(--drawer-footer-padding) | space.16:1rem |
| Title | ||
| Weight | component.drawer.title.font-weighttype.title.font-weightvar(--drawer-title-font-weight) | font.weight.600:600 |
| Text Changes with theme | component.drawer.title.labelcolor.text.primaryvar(--drawer-title-label) | Lightslate.light.900:#161B23Darkslate.dark.900:#F7F8FA |
| Description | ||
| Text size | component.drawer.description.font-sizetype.body.font-sizevar(--drawer-description-font-size) | font.size.14:0.875rem |
| Text Changes with theme | component.drawer.description.labelcolor.text.mutedvar(--drawer-description-label) | Lightslate.light.600:#535D6DDarkslate.dark.400:#969FAD |
| From the system | ||
| Edge Changes with theme | color.border.default straight from the system, through --border | Lightslate.light.200 · #DDE2EADarkslate.dark.100 · #262D38 |
| Corner | radius.container straight from the system, through --radius-lg | radius.4 · 0.25rem (4px) |