Skip to main content

Scroll area

A region with its own styled scrollbars.

In Dense data

See it live​

Start Storybook to see it live: npm run storybook
Live from StorybookOpen Scroll area in StorybookSee it in dark

When to use it​

In Dense data: Long tables in fixed panels.

  • Use it when: A fixed-height list or panel inside a larger page.
  • Not when: The whole page: let the page scroll.

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: Save
  • content.action.cancel: Cancel
  • content.action.destroy: Delete
  • content.action.retry: Retry
  • content.action.empty-action: Change filters

See Voice and tone for the whole voice.

Accessibility and keyboard​

KeyboardWhat happensNot
undefinedThe region can be focused and scrolled with the keyboard.undefined

Use it in code​

npx open-ds add scroll-area

The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.

Tokens it reads​

Scroll area reads 5 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 Scroll area's tokens to change Scroll area 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.

PartIts token and the semantic it aliasesValue
Viewport
Focus
on focus		component.scroll-area.viewport.focusborder-width.focusvar(--scroll-area-viewport-focus)border-width.2:2px
Focus ring focus
Changes with theme
on focus		component.scroll-area.viewport.focus-ring-focuscolor.border.focusvar(--scroll-area-viewport-focus-ring-focus)Lightviolet.light.600:#4B3FD9Darkviolet.dark.600:#A9A3F6
Focus ring offset focus
Changes with theme
on focus		component.scroll-area.viewport.focus-ring-offset-focuscolor.surface.canvasvar(--scroll-area-viewport-focus-ring-offset-focus)Lightslate.light.50:#F7F8FADarkslate.dark.0:#0D1117
Thumb
Cornercomponent.scroll-area.thumb.radiusradius.roundvar(--scroll-area-thumb-radius)radius.full:9999px
Fill
Changes with theme		component.scroll-area.thumb.backgroundcolor.border.defaultvar(--scroll-area-thumb-background)Lightslate.light.200:#DDE2EADarkslate.dark.100:#262D38
From the system
Edge
Changes with theme		color.border.default
straight from the system, through --border		Lightslate.light.200 · #DDE2EADarkslate.dark.100 · #262D38