@fayegram-ai/faye-ui/display/scroll-area

Import

import { ScrollArea } from '@fayegram-ai/faye-ui/display/scroll-area';

Usage and behavior guide · API JSON

This entry declares a client boundary. Follow the rendering guide for framework integration.

Public exports

Name	Kind	Resolved declaration type
`ScrollAreaRootProps`	type	`ScrollAreaRootProps`
`ScrollAreaViewportProps`	type	`ScrollAreaViewportProps`
`ScrollArea`	value	{ readonly Root: { (input: ScrollAreaRootProps & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "tone"> \| undefined; } \| undefined; }): import("react").ReactElement; displayName: string; }; readonly Viewport: { (input: ScrollAreaViewportProps & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "tone"> \| undefined; } \| undefined; }): import("react").ReactElement; displayName: string; }; readonly Scrollbar: { (input… (full type in API JSON)

ScrollArea

Public component; use the linked family guide for complete composition and behavior.

Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.

ScrollArea.Root

Property	Required	Type	Meaning
`className`	No	`string \| ((state: ScrollAreaRootState) => string \| undefined) \| undefined`	CSS class applied to the element, or a function that returns a class based on the component's state.
`interaction`	No	`InteractionOptions \| undefined`	See the usage contract and declaration.
`overflowEdgeThreshold`	No	`number \| Partial<{ xStart: number; xEnd: number; yStart: number; yEnd: number; }> \| undefined`	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.
`render`	No	`ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, ScrollAreaRootState> \| undefined`	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.
`style`	No	`CSSProperties \| ((state: ScrollAreaRootState) => React.CSSProperties \| undefined) \| undefined`	Style applied to the element, or a function that returns a style object based on the component's state.
`variants`	No	`{ readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "tone"> \| undefined; } \| undefined`	See the usage contract and declaration.

ScrollArea.Viewport

Property	Required	Type	Meaning
`className`	No	`string \| ((state: ScrollAreaViewportState) => string \| undefined) \| undefined`	CSS class applied to the element, or a function that returns a class based on the component's state.
`render`	No	`ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, ScrollAreaViewportState> \| undefined`	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.
`scrollChaining`	No	`"auto" \| "contain" \| undefined`	Allow page scrolling at the boundary by default; contain is opt-in for bounded panels.
`style`	No	`CSSProperties \| ((state: ScrollAreaViewportState) => React.CSSProperties \| undefined) \| undefined`	Style applied to the element, or a function that returns a style object based on the component's state.
`variants`	No	`{ readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "tone"> \| undefined; } \| undefined`	See the usage contract and declaration.

ScrollArea.Scrollbar

Property	Required	Type	Meaning
`className`	No	`string \| ((state: ScrollAreaScrollbarState) => string \| undefined) \| undefined`	CSS class applied to the element, or a function that returns a class based on the component's state.
`keepMounted`	No	`boolean \| undefined`	Whether to keep the HTML element in the DOM when the viewport isn't scrollable.
`orientation`	No	`"horizontal" \| "vertical" \| undefined`	Whether the scrollbar controls vertical or horizontal scroll.
`render`	No	`ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, ScrollAreaScrollbarState> \| undefined`	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.
`style`	No	`CSSProperties \| ((state: ScrollAreaScrollbarState) => React.CSSProperties \| undefined) \| undefined`	Style applied to the element, or a function that returns a style object based on the component's state.
`variants`	No	`{ readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "tone"> \| undefined; } \| undefined`	See the usage contract and declaration.

ScrollArea.Thumb

Property	Required	Type	Meaning
`className`	No	`string \| ((state: ScrollAreaThumbState) => string \| undefined) \| undefined`	CSS class applied to the element, or a function that returns a class based on the component's state.
`render`	No	`ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, ScrollAreaThumbState> \| undefined`	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.
`style`	No	`CSSProperties \| ((state: ScrollAreaThumbState) => React.CSSProperties \| undefined) \| undefined`	Style applied to the element, or a function that returns a style object based on the component's state.
`variants`	No	`{ readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "tone"> \| undefined; } \| undefined`	See the usage contract and declaration.

ScrollArea.Corner

Property	Required	Type	Meaning
`className`	No	`string \| ((state: ScrollAreaCornerState) => string \| undefined) \| undefined`	CSS class applied to the element, or a function that returns a class based on the component's state.
`render`	No	`ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, ScrollAreaCornerState> \| undefined`	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.
`style`	No	`CSSProperties \| ((state: ScrollAreaCornerState) => React.CSSProperties \| undefined) \| undefined`	Style applied to the element, or a function that returns a style object based on the component's state.
`variants`	No	`{ readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "tone"> \| undefined; } \| undefined`	See the usage contract and declaration.

ScrollArea.Content

Property	Required	Type	Meaning
`className`	No	`string \| ((state: ScrollAreaContentState) => string \| undefined) \| undefined`	CSS class applied to the element, or a function that returns a class based on the component's state.
`render`	No	`ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, ScrollAreaContentState> \| undefined`	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.
`style`	No	`CSSProperties \| ((state: ScrollAreaContentState) => React.CSSProperties \| undefined) \| undefined`	Style applied to the element, or a function that returns a style object based on the component's state.
`variants`	No	`{ readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"scroll-area", "tone"> \| undefined; } \| undefined`	See the usage contract and declaration.

Defaults and customization

Descriptor defaults: {"size":"md","tone":"neutral"}. Parts: root, viewport, scrollbar, thumb, corner, content. Explicit instance props take precedence over configured defaults.

Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.

State, events and accessibility

For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.

Declaration authority

Generated from packages/faye-ui/dist/display/scroll-area.d.ts after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. React DOM attributes and Base UI component contracts describe the inherited foundations.