Skip to main content

Scroll area

A region with its own styled scrollbars.

In Accessible first

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 Accessible first: A fixed-height list or panel inside a page that still works at 200% zoom. Not the whole page.

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

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: Continue
  • content.action.cancel: Go back
  • content.action.destroy: Delete
  • content.action.retry: Try again
  • content.action.empty-action: Start a new application

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

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.

PartIts token and the semantic it aliasesValue
Viewport
Focus
on focus		component.scroll-area.viewport.focusborder-width.focusvar(--scroll-area-viewport-focus)border-width.3:3px
Focus ring focus
Changes with theme
on focus		component.scroll-area.viewport.focus-ring-focuscolor.border.focusvar(--scroll-area-viewport-focus-ring-focus)Lightblue.light.600:#0B4FC0Darkblue.dark.600:#8AB4F8
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)Lightgray.light.50:#F7F7F7Darkgray.dark.0:#0A0A0A
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)Lightgray.light.200:#D6D6D6Darkgray.dark.100:#222222
From the system
Edge
Changes with theme		color.border.default
straight from the system, through --border		Lightgray.light.200 · #D6D6D6Darkgray.dark.100 · #222222