Sheet
A panel that slides in from an edge.
In Dense data
See it live
Start Storybook to see it live:
npm run storybookWhen to use it
In Dense data: Record details beside the table.
- Use it when: Filters, details or a secondary form while the page stays in view.
- Not when: A blocking decision (dialog), or a tiny confirmation.
Instead:
How Dense data uses it
A menu or dialog
Use elevation.overlay and a dimmed page for dialogs
Not A border only
Floating things need a shadow so they read as on top.
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 sheet
The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.
Tokens it reads
Sheet reads 19 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 Sheet's tokens to change Sheet alone.
Changes with theme
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.sheet.overlay.backgroundcolor.surface.scrimvar(--sheet-overlay-background) | Lightblack.light.scrim:#0000008CDarkblack.dark.scrim:#000000B3 |
| Content | ||
| Gap | component.sheet.content.gapspace.gap.groupvar(--sheet-content-gap) | space.16:1rem |
| Fill Changes with theme | component.sheet.content.backgroundcolor.surface.canvasvar(--sheet-content-background) | Lightslate.light.50:#F7F8FADarkslate.dark.0:#0D1117 |
| Shadow Changes with theme | component.sheet.content.shadowelevation.overlayvar(--sheet-content-shadow) | Lightshadow.overlayDarkshadow.overlay-dark |
| Sheet | ||
| Corner | component.sheet.radiusradius.badgevar(--sheet-radius) | radius.0:0rem |
| Focus ring offset Changes with theme | component.sheet.focus-ring-offsetcolor.surface.canvasvar(--sheet-focus-ring-offset) | Lightslate.light.50:#F7F8FADarkslate.dark.0:#0D1117 |
| Focus on focus | component.sheet.focusborder-width.focusvar(--sheet-focus) | border-width.2:2px |
| Focus ring focus Changes with theme on focus | component.sheet.focus-ring-focuscolor.border.focusvar(--sheet-focus-ring-focus) | Lightviolet.light.600:#4B3FD9Darkviolet.dark.600:#A9A3F6 |
| Background open Changes with theme when open | component.sheet.background-opencolor.action.secondaryvar(--sheet-background-open) | Lightslate.light.0:#FFFFFFDarkslate.dark.50:#161B23 |
| Icon size | component.sheet.icon-sizesize.iconvar(--sheet-icon-size) | size.16:1rem |
| Header | ||
| Gap | component.sheet.header.gapcomponent-spacing-map.x2var(--sheet-header-gap) | space.8:0.5rem |
| Padding | component.sheet.header.paddingspace.inset.containervar(--sheet-header-padding) | space.16:1rem |
| Footer | ||
| Gap | component.sheet.footer.gapspace.gap.defaultvar(--sheet-footer-gap) | space.8:0.5rem |
| Padding | component.sheet.footer.paddingspace.inset.containervar(--sheet-footer-padding) | space.16:1rem |
| Title | ||
| Weight | component.sheet.title.font-weighttype.title.font-weightvar(--sheet-title-font-weight) | font.weight.600:600 |
| Text Changes with theme | component.sheet.title.labelcolor.text.primaryvar(--sheet-title-label) | Lightslate.light.900:#161B23Darkslate.dark.900:#F7F8FA |
| Description | ||
| Text size | component.sheet.description.font-sizetype.body.font-sizevar(--sheet-description-font-size) | font.size.14:0.875rem |
| Text Changes with theme | component.sheet.description.labelcolor.text.mutedvar(--sheet-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 |