Scroll area
A region with its own styled scrollbars.
In Multi-brand
See it live
npm run storybookWhen to use it
In Multi-brand: A fixed-height list or panel inside a page. Not the whole page; let the page scroll.
- Use it when: A fixed-height list or panel inside a larger page.
- Not when: The whole page: let the page scroll.
Instead:
- Message scroller: A conversation that keeps the newest in view.
Words
- Shared structure: object, state, next step.
- Brand tone lives in headlines and marketing copy, not in errors.
- Errors and confirmations read the same in every brand.
- Use: Get started, Plan, Order. Avoid: Brand-specific words in errors, Jargon.
The labels components use, from the voice tokens:
content.action.commit: Savecontent.action.cancel: Cancelcontent.action.destroy: Removecontent.action.retry: Try againcontent.action.empty-action: Get started
See Voice and tone for the whole voice.
Accessibility and keyboard
| Keyboard | What happens | Not |
|---|---|---|
| undefined | The 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.
Multi-brand decides what changes when you switch theme. Here a switch changes colors, type and shape, so the marked rows differ between its brands and between light and dark; everything else holds steady.
| Part | Its token and the semantic it aliases | Value |
|---|---|---|
| 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) | Aster Lightteal.light.600:#0F766EAster Darkteal.dark.600:#7FCFC6Birch Lightpurple.light.600:#6D28D9Birch Darkpurple.dark.600:#B79DF7Coral Lightorange.light.600:#C2410CCoral Darkorange.dark.600:#F7A67F |
| 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) | Aster Lightslate-deep.light.50:#F8FAFCAster Darkslate-deep.dark.0:#020617Birch Lightslate-deep.light.50:#F8FAFCBirch Darkslate-deep.dark.0:#020617Coral Lightslate-deep.light.50:#F8FAFCCoral Darkslate-deep.dark.0:#020617 |
| Thumb | ||
| Corner | component.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) | Aster Lightslate-deep.light.200:#E2E8F0Aster Darkslate-deep.dark.100:#1E293BBirch Lightslate-deep.light.200:#E2E8F0Birch Darkslate-deep.dark.100:#1E293BCoral Lightslate-deep.light.200:#E2E8F0Coral Darkslate-deep.dark.100:#1E293B |
| From the system | ||
| Edge Changes with theme | color.border.default straight from the system, through --border | Aster Lightslate-deep.light.200 · #E2E8F0Aster Darkslate-deep.dark.100 · #1E293BBirch Lightslate-deep.light.200 · #E2E8F0Birch Darkslate-deep.dark.100 · #1E293BCoral Lightslate-deep.light.200 · #E2E8F0Coral Darkslate-deep.dark.100 · #1E293B |