Skip to main content

Sheet

A panel that slides in from an edge.

In Content first

See it live​

Start Storybook to see it live: npm run storybook

When to use it​

In Content first: The menu on a phone.

  • 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:

  • Dialog: A centered blocking window.
  • Drawer: The bottom panel for phones.

How Content first uses it​

A menu or dialog
Use elevation.overlay and a dimmed page
Not No shadow
The dimmed page focuses the reader on the dialog.

Words​

  • Write to one person: "you", not "users".
  • Short sentences with room to breathe.
  • Explain why before asking for anything.
  • Use: Read, Save for later, You, Next issue. Avoid: Click here, Submit, Users, Content.

The labels components use, from the voice tokens:

  • content.action.commit: Save
  • content.action.cancel: Not now
  • content.action.destroy: Remove
  • content.action.retry: Try again
  • content.action.empty-action: Browse guides

See Voice and tone for the whole voice.

Accessibility and keyboard​

KeyboardWhat happensNot
undefinedEscape 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

Content 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.

PartIts token and the semantic it aliasesValue
Shared
Transition panels durationcomponent.transition.panels-durationmotion.duration.panelsvar(--transition-panels-duration)duration.relaxed:320ms
Overlay
Fill
Changes with theme
component.sheet.overlay.backgroundcolor.surface.scrimvar(--sheet-overlay-background)Lightblack.light.scrim:#0000008CDarkblack.dark.scrim:#000000B3
Content
Gapcomponent.sheet.content.gapspace.gap.groupvar(--sheet-content-gap)space.32:2rem
Fill
Changes with theme
component.sheet.content.backgroundcolor.surface.canvasvar(--sheet-content-background)Lightstone.light.50:#FFFDF8Darkstone.dark.0:#14110D
Shadow
Changes with theme
component.sheet.content.shadowelevation.overlayvar(--sheet-content-shadow)Lightshadow.overlayDarkshadow.overlay-dark
Sheet
Cornercomponent.sheet.radiusradius.badgevar(--sheet-radius)radius.999:9999px
Focus ring offset
Changes with theme
component.sheet.focus-ring-offsetcolor.surface.canvasvar(--sheet-focus-ring-offset)Lightstone.light.50:#FFFDF8Darkstone.dark.0:#14110D
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)Lightnavy.light.600:#1E3A5FDarknavy.dark.600:#8FA6C4
Background open
Changes with theme
when open
component.sheet.background-opencolor.action.secondaryvar(--sheet-background-open)Lightstone.light.0:#FFFFFFDarkstone.dark.50:#1F1B16
Icon sizecomponent.sheet.icon-sizesize.iconvar(--sheet-icon-size)size.16:1rem
Header
Gapcomponent.sheet.header.gapcomponent-spacing-map.x2var(--sheet-header-gap)space.8:0.5rem
Paddingcomponent.sheet.header.paddingspace.inset.containervar(--sheet-header-padding)space.24:1.5rem
Footer
Gapcomponent.sheet.footer.gapspace.gap.defaultvar(--sheet-footer-gap)space.16:1rem
Paddingcomponent.sheet.footer.paddingspace.inset.containervar(--sheet-footer-padding)space.24:1.5rem
Title
Weightcomponent.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)Lightstone.light.900:#1F1B16Darkstone.dark.900:#FFFDF8
Description
Text sizecomponent.sheet.description.font-sizetype.body.font-sizevar(--sheet-description-font-size)font.size.18:1.125rem
Text
Changes with theme
component.sheet.description.labelcolor.text.mutedvar(--sheet-description-label)Lightstone.light.600:#61594DDarkstone.dark.400:#A39A8B
From the system
Edge
Changes with theme
color.border.default
straight from the system, through --border
Lightstone.light.200 · #E4DDD0Darkstone.dark.100 · #2E2A24