Skip to content
THE COMPONENT LIBRARY
Skip to content

Component reference

ScrollArea

A bounded, scrollable activity list.

Preview

Live preview

Changes apply to this preview only.

Releases

Fourteen rows in a 260px viewport.

Release 142026-10-19
Release 132026-10-18
Release 122026-10-17
Release 112026-10-16
Release 102026-10-15
Release 92026-10-14
Release 82026-10-13
Release 72026-10-12
Release 62026-10-11
Release 52026-10-10
Release 42026-10-09
Release 32026-10-08
Release 22026-10-07
Release 12026-10-06

Width adapts to the available space

More examples

Different configurations and compositions using the real Pimolu API. Each preview runs independently and follows the site appearance.

Keyboard-scrollable activity log

Focus the viewport and scroll a labelled sequence without moving the page.

Open preview

Horizontal

The viewport scrolls sideways; the content keeps its natural width.

Open preview

Both

A wide table can scroll in both directions inside a bounded height.

Open preview

Usage

Constrain the region deliberately rather than clipping content or the entire page.

API reference

Generated from the public TypeScript declarations. Native HTML attributes are inherited where the component extends them; this reference includes Pimolu props and selected common native attributes.

PimoluScrollAreaProps

Type source
PimoluScrollAreaProps public API
NameTypeDefaultDescription
orientation"horizontal" | "vertical" | "both" | undefined"vertical"Scroll direction. Defaults to "vertical".
maxHeightstring | number | undefined—Maximum height of the scroll viewport.
viewportClassNamestring | undefined—Class applied to the scrollable viewport.
childrenRequiredReactNode—Public Pimolu prop; see the source declaration for details.
defaultValuestring | number | readonly string[] | undefined—Standard React/HTML attribute.
classNamestring | undefined—Standard React/HTML attribute.
styleCSSProperties | undefined—Standard React/HTML attribute.
aria-labelstring | undefined—Defines a string value that labels the current element.
onChangeChangeEventHandler<HTMLDivElement, Element> | undefined—Standard React/HTML attribute.
onClickMouseEventHandler<HTMLDivElement> | undefined—Standard React/HTML attribute.
orientation

"horizontal" | "vertical" | "both" | undefined

Default: "vertical"

Scroll direction. Defaults to "vertical".

maxHeight

string | number | undefined

No default extracted.

Maximum height of the scroll viewport.

viewportClassName

string | undefined

No default extracted.

Class applied to the scrollable viewport.

childrenRequired

ReactNode

No default extracted.

Public Pimolu prop; see the source declaration for details.

defaultValue

string | number | readonly string[] | undefined

No default extracted.

Standard React/HTML attribute.

className

string | undefined

No default extracted.

Standard React/HTML attribute.

style

CSSProperties | undefined

No default extracted.

Standard React/HTML attribute.

aria-label

string | undefined

No default extracted.

Defines a string value that labels the current element.

onChange

ChangeEventHandler<HTMLDivElement, Element> | undefined

No default extracted.

Standard React/HTML attribute.

onClick

MouseEventHandler<HTMLDivElement> | undefined

No default extracted.

Standard React/HTML attribute.

Accessibility

  • Make the region discoverable and ensure keyboard users can reach all its content.
Read the accessibility guide →