Scroll Area

A native scroll container with custom scrollbars.

View as Markdown

Anatomy

Import the component and assemble its parts:

Anatomy

Examples

Both scrollbars

Gradient scroll fade

Use the viewport overflow CSS variables to fade the scroll edges, which gradually increases in strength as the user scrolls away from the edges.

The CSS variables do not inherit by default to improve rendering performance in complex scroll areas with deep subtrees. To use them in child elements (or pseudo-elements on <ScrollArea.Viewport>), you must manually set each variable to inherit.

scroll-area.module.css

For SSR, a fallback can be used as part of the var() function to provide a default height.

SSR fallback

API reference

Root

Groups all parts of the scroll area. Renders a <div> element.

overflowEdgeThreshold

Union

0

Description

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.

Type
| number
| {
    xStart?: number
    xEnd?: number
    yStart?: number
    yEnd?: number
  }
| undefined
Default

0

style

React.CSSProperties | function

Name
Type
| React.CSSProperties
| ((
    state: ScrollArea.Root.State,
  ) => CSSProperties | undefined)
| undefined
className

string | function

Description

CSS class applied to the element, or a function that returns a class based on the component’s state.

Type
| string
| ((state: ScrollArea.Root.State) => string | undefined)
render

ReactElement | function

Name
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: ScrollArea.Root.State,
  ) => ReactElement)
data-has-overflow-x

Present when the scroll area content is wider than the viewport.

data-has-overflow-y

Present when the scroll area content is taller than the viewport.

data-overflow-x-end

Present when there is overflow on the horizontal end side.

data-overflow-x-start

Present when there is overflow on the horizontal start side.

data-overflow-y-end

Present when there is overflow on the vertical end side.

data-overflow-y-start

Present when there is overflow on the vertical start side.

--scroll-area-corner-height

The scroll area's corner height.

--scroll-area-corner-width

The scroll area's corner width.

Viewport

The actual scrollable container of the scroll area. Renders a <div> element.

style

React.CSSProperties | function

Name
Type
| React.CSSProperties
| ((
    state: ScrollArea.Viewport.State,
  ) => CSSProperties | undefined)
| undefined
className

string | function

Description

CSS class applied to the element, or a function that returns a class based on the component’s state.

Type
| string
| ((state: ScrollArea.Viewport.State) => string | undefined)
render

ReactElement | function

Name
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: ScrollArea.Viewport.State,
  ) => ReactElement)
data-has-overflow-x

Present when the scroll area content is wider than the viewport.

data-has-overflow-y

Present when the scroll area content is taller than the viewport.

data-overflow-x-end

Present when there is overflow on the horizontal end side.

data-overflow-x-start

Present when there is overflow on the horizontal start side.

data-overflow-y-end

Present when there is overflow on the vertical end side.

data-overflow-y-start

Present when there is overflow on the vertical start side.

--scroll-area-overflow-x-end

The distance from the horizontal end edge in pixels.

--scroll-area-overflow-x-start

The distance from the horizontal start edge in pixels.

--scroll-area-overflow-y-end

The distance from the vertical end edge in pixels.

--scroll-area-overflow-y-start

The distance from the vertical start edge in pixels.

Content

A container for the content of the scroll area. Renders a <div> element.

style

React.CSSProperties | function

Name
Type
| React.CSSProperties
| ((
    state: ScrollArea.Content.State,
  ) => CSSProperties | undefined)
| undefined
className

string | function

Description

CSS class applied to the element, or a function that returns a class based on the component’s state.

Type
| string
| ((state: ScrollArea.Content.State) => string | undefined)
render

ReactElement | function

Name
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: ScrollArea.Content.State,
  ) => ReactElement)

Scrollbar

A vertical or horizontal scrollbar for the scroll area. Renders a <div> element.

style

React.CSSProperties | function

Name
Type
| React.CSSProperties
| ((
    state: ScrollArea.Scrollbar.State,
  ) => CSSProperties | undefined)
| undefined
orientation

'horizontal' | 'vertical'

'vertical'

Description

Whether the scrollbar controls vertical or horizontal scroll.

Type
'horizontal' | 'vertical' | undefined
Default

'vertical'

className

string | function

Description

CSS class applied to the element, or a function that returns a class based on the component’s state.

Type
| string
| ((
    state: ScrollArea.Scrollbar.State,
  ) => string | undefined)
keepMounted

boolean

false

Description

Whether to keep the HTML element in the DOM when the viewport isn’t scrollable.

Type
boolean | undefined
Default

false

render

ReactElement | function

Name
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: ScrollArea.Scrollbar.State,
  ) => ReactElement)
data-orientation

Indicates the orientation of the scrollbar.

data-has-overflow-x

Present when the scroll area content is wider than the viewport.

data-has-overflow-y

Present when the scroll area content is taller than the viewport.

data-hovering

Present when the pointer is over the scroll area.

data-overflow-x-end

Present when there is overflow on the horizontal end side.

data-overflow-x-start

Present when there is overflow on the horizontal start side.

data-overflow-y-end

Present when there is overflow on the vertical end side.

data-overflow-y-start

Present when there is overflow on the vertical start side.

data-scrolling

Present when the users scrolls inside the scroll area.

--scroll-area-thumb-height

The scroll area thumb's height.

--scroll-area-thumb-width

The scroll area thumb's width.

Thumb

The draggable part of the the scrollbar that indicates the current scroll position. Renders a <div> element.

style

React.CSSProperties | function

Name
Type
| React.CSSProperties
| ((
    state: ScrollArea.Thumb.State,
  ) => CSSProperties | undefined)
| undefined
className

string | function

Description

CSS class applied to the element, or a function that returns a class based on the component’s state.

Type
| string
| ((state: ScrollArea.Thumb.State) => string | undefined)
render

ReactElement | function

Name
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: ScrollArea.Thumb.State,
  ) => ReactElement)
data-orientation

Indicates the orientation of the scrollbar.

Corner

A small rectangular area that appears at the intersection of horizontal and vertical scrollbars. Renders a <div> element.

style

React.CSSProperties | function

Name
Type
| React.CSSProperties
| ((
    state: ScrollArea.Corner.State,
  ) => CSSProperties | undefined)
| undefined
className

string | function

Description

CSS class applied to the element, or a function that returns a class based on the component’s state.

Type
| string
| ((state: ScrollArea.Corner.State) => string | undefined)
render

ReactElement | function

Name
Description

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.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: ScrollArea.Corner.State,
  ) => ReactElement)