Scroll area
A region with its own styled scrollbars.
In Brand expressive
See it live
npm run storybookWhen to use it
In Brand expressive: A fixed-height list inside a popover or drawer. 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
- Headlines are short and bold. Three to six words.
- Verbs that move: Join, Try, Go.
- Playful in headlines, plain in errors.
- Use: Join, Drop, Go, Love. Avoid: Synergy, Leverage, Kindly.
The labels components use, from the voice tokens:
content.action.commit: Gocontent.action.cancel: Not nowcontent.action.destroy: Removecontent.action.retry: Try againcontent.action.empty-action: Explore the drop
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.
Brand expressive 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 |
|---|---|---|
| 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) | Lightpink.light.600:#D61F7ADarkpink.dark.600:#F59ACA |
| 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) | Lighttaupe.light.50:#FFF8F3Darktaupe.dark.0:#120B09 |
| 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) | Lighttaupe.light.200:#F2DCCFDarktaupe.dark.100:#33241F |
| From the system | ||
| Edge Changes with theme | color.border.default straight from the system, through --border | Lighttaupe.light.200 · #F2DCCFDarktaupe.dark.100 · #33241F |