Skip to main content

ScrollArea

Displaylayout

A scroll container with themed, overlay scrollbars that stay consistent across platforms.

import { ScrollArea } from "@elabs-ai/components-ui";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt for your coding agent

Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.

Add the brand-ui ScrollArea component (from @elabs-ai/components-ui) to this project.

1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`.
2. Look ScrollArea up before writing code: `npx -y @elabs-ai/components-cli docs ScrollArea` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-ui is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`.
4. Use it here: [the screen or file, and what it should show]
5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop.
6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.

API

ScrollArea

PropTypeDescription
viewportPropsComponentPropsWithoutRef<typeof ScrollAreaPrimitive.Viewport>Props for the scrolling VIEWPORT — the element that actually overflows, which is otherwise unreachable from the outside. The viewport is deliberately NOT focusable by default: when the content inside it is focusable (a list of links, rows of buttons) a keyboard user reaches the overflow by tabbing through it, and a tab stop on the viewport would be noise. When the content is plain text or non-focusable rows, that same user cannot scroll it at all — axe's `scrollable-region-focusable` is the gate that catches it. Make it a named tab stop the way `ChartFrame` does for its scrolling body: ```tsx viewportProps={{ tabIndex: 0, role: "group", "aria-label": "Scrollable list" }} ``` `role="group"` rather than `"region"`: ARIA 1.2 forbids `aria-label` on a generic element, and `group` gives the name a host without adding a landmark.

Also accepts: ComponentPropsWithoutRef<typeof ScrollAreaPrimitive.Root>