Drawer
A panel that slides up from the bottom, for phones.
Left out of Accessible first Only dialogs separate from the page here, with a dimmed page and a border. A sliding panel adds a second layer the scheme does not use. Use instead: Dialog, Collapsible
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
- Use common words. Explain any term you must use.
- One idea per sentence. Put the action first.
- Never blame the person.
- Use: Continue, Change, Start, You. Avoid: Invalid, Utilise, Submit, Error code.
The labels components use, from the voice tokens:
content.action.commit: Continuecontent.action.cancel: Go backcontent.action.destroy: Deletecontent.action.retry: Try againcontent.action.empty-action: Start a new application
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.
Accessible first 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.moderate:200ms |
| 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) | Lightgray.light.50:#F7F7F7Darkgray.dark.0:#0A0A0A |
| Drawer | ||
| Corner | component.drawer.radiusradius.roundvar(--drawer-radius) | radius.full:9999px |
| Fill Changes with theme | component.drawer.backgroundcolor.surface.sunkenvar(--drawer-background) | Lightgray.light.100:#EDEDEDDarkgray.dark.100:#222222 |
| 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.24:1.5rem |
| 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.16:1rem |
| Padding | component.drawer.footer.paddingspace.inset.containervar(--drawer-footer-padding) | space.24:1.5rem |
| Title | ||
| Weight | component.drawer.title.font-weighttype.title.font-weightvar(--drawer-title-font-weight) | font.weight.700:700 |
| Text Changes with theme | component.drawer.title.labelcolor.text.primaryvar(--drawer-title-label) | Lightgray.light.900:#141414Darkgray.dark.900:#F7F7F7 |
| Description | ||
| Text size | component.drawer.description.font-sizetype.body.font-sizevar(--drawer-description-font-size) | font.size.19:1.1875rem |
| Text Changes with theme | component.drawer.description.labelcolor.text.mutedvar(--drawer-description-label) | Lightgray.light.500:#595959Darkgray.dark.500:#949494 |
| From the system | ||
| Edge Changes with theme | color.border.default straight from the system, through --border | Lightgray.light.200 · #D6D6D6Darkgray.dark.100 · #222222 |
| Corner | radius.container straight from the system, through --radius-lg | radius.8 · 0.5rem (8px) |