Scroll area
A region with its own styled scrollbars.
In Content first
See it live
npm run storybookWhen to use it
In Content first: A fixed-height panel inside a page, such as the phone menu in a sheet. Not the article: 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
- 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: Savecontent.action.cancel: Not nowcontent.action.destroy: Removecontent.action.retry: Try againcontent.action.empty-action: Browse guides
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.
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.
| 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) | Lightnavy.light.600:#1E3A5FDarknavy.dark.600:#8FA6C4 |
| 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) | Lightstone.light.50:#FFFDF8Darkstone.dark.0:#14110D |
| 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) | Lightstone.light.200:#E4DDD0Darkstone.dark.100:#2E2A24 |
| From the system | ||
| Edge Changes with theme | color.border.default straight from the system, through --border | Lightstone.light.200 · #E4DDD0Darkstone.dark.100 · #2E2A24 |