Scroll Area

A scrollable region with styled scrollbars.

Preview

Loading Preview...

bun add xiod-ui

1import { ScrollArea, ScrollBar } from "xiod-ui/scroll-area";

Detailed documentation of properties and options.

Accepts className, style and render, plus every native attribute of the element it renders.

Prop	Type	Default	Description
`overflowEdgeThreshold`	`number \| Partial<{ xStart: number; xEnd: number; yStart: number; yEnd: number; }>`	`0`	The threshold in pixels that must be passed before the overflow edge attributes are applied. Accepts a single number for all edges or an object to configure them individually.
`scrollbarGutter`	`boolean`	`false`	Whether to reserve space for the scrollbars so they don't overlap the content.
`scrollbarSize`

Accepts className, style and render, plus every native attribute of the element it renders.

Prop	Type	Default	Description
`keepMounted`	`boolean`	`false`	Whether to keep the HTML element in the DOM when the viewport isn't scrollable.
`orientation`	`"horizontal"`

|

"vertical"