---
title: "Scroll Area"
description: "Scroll Area with accessible presentation and local state."
---

# Scroll Area

Scroll Area with accessible presentation and local state.

## Installation

Install the shared package once in your Exact app. This version is a beta.

```sh
bun add --exact @rightui/ui@0.4.0-beta.4
```

Or choose another package manager:

```sh
npm install --save-exact @rightui/ui@0.4.0-beta.4
pnpm add --save-exact @rightui/ui@0.4.0-beta.4
yarn add --exact @rightui/ui@0.4.0-beta.4
```

Exact compilation uses Bun 1.4.2. Register Geist and Newsreader, declare the font marker and add the root provider using [Installation](/docs/installation).

### Manual source setup

Install an editable copy of the complete package:

```sh
mkdir -p vendor/rightui vendor/rightui-ui
npm pack @rightui/ui@0.4.0-beta.4 --pack-destination vendor/rightui
tar -xzf ./vendor/rightui/rightui-ui-0.4.0-beta.4.tgz -C vendor/rightui-ui --strip-components=1
bun add file:./vendor/rightui-ui
```

Keep package.json, the Contract files, ui.tamber, assets and licenses together.

### Import

```contract
use ScrollArea, ScrollAreaAdvanced from "@rightui/ui"
```

## Usage

Import ScrollArea, ScrollAreaAdvanced from @rightui/ui. Store its value in state and update it through the provided action callback.

## Example

```contract
use FontWeights from "@rightui/ui"
use uiFontFamily, ScrollAreaAdvanced from "@rightui/ui"

component Demo
  props
    width: number
    reduced: bool
  inject
    uiWeights: FontWeights
    uiFont: string
  derive narrow = width < 600
  state vertical = 0
  action recordVertical(left: number, top: number, totalWidth: number, totalHeight: number, width: number, height: number)
    verticalPosition = top < 1 ? "Top of list" : totalHeight - top - height < 1 ? "End of list" : "Scrolling"
  state verticalPosition = "Top of list"
  view
    column gap="ui.space-16" min-width=0 max-width="100%"
      ScrollAreaAdvanced(id="layout-scroll-vertical", label="Component list", height=240, contentWidth=0, direction="vertical", type="auto", reduced=reduced, observeScroll=recordVertical)
        for item, i in ["Accordion", "Alert Dialog", "Aspect Ratio", "Avatar", "Badge", "Breadcrumb", "Button", "Calendar", "Card", "Carousel", "Checkbox", "Collapsible", "Combobox", "Command", "Context Menu", "Dialog", "Drawer", "Dropdown Menu", "Form", "Hover Card", "Input", "Input OTP", "Label", "Menubar", "Navigation Menu", "Popover", "Progress", "Radio Group", "Scroll Area", "Select"] key=item
          text item testId=("layout-scroll-row-" + i.toString()) padding="ui.space-4 ui.space-0" border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border" font-size="ui.text-sm" color="ui.foreground" font-family=uiFontFamily(uiFont) data-rightui-font="body"
      text "Horizontal scrolling" font-size="ui.text-sm" font-weight=uiWeights.semibold font-family=uiFontFamily(uiFont) data-rightui-font="body"
      ScrollAreaAdvanced(id="variation-scroll-horizontal", label="Wide content", height=100, contentWidth=1000, direction="horizontal", type="auto", reduced=reduced, observeScroll=recordVertical)
        text "Overview                              Library                              Timeline                              Export" font-family=uiFontFamily(uiFont) data-rightui-font="body"

```

## API Reference

| Property | Type |
| --- | --- |
| ScrollArea.id | string |
| ScrollArea.label | string |
| ScrollArea.height | number |
| ScrollAreaAdvanced.id | string |
| ScrollAreaAdvanced.label | string |
| ScrollAreaAdvanced.height | number |
| ScrollAreaAdvanced.contentWidth | number |
| ScrollAreaAdvanced.direction | string |
| ScrollAreaAdvanced.type | string |
| ScrollAreaAdvanced.reduced | bool |
| ScrollAreaAdvanced.observeScroll | action |

## Source

File: packages/ui/display.contract

```contract
use FontWeights from "./typography-context.contract"
use AvatarFrame from "./composition.contract"
use uiFontFamily from "./typography-context.contract"
keyframes uiSkeletonPulse
  from opacity=1
  50% opacity=0.5
  to opacity=1

component Alert
  props
    id: string
    title: string
    description: string
    variant: string
  inject
    uiWeights: FontWeights
    uiFont: string
  view
    row id=id testId=id role="status" gap="ui.space-12" padding="ui.space-12 ui.space-16" border-width="ui.border-width" border-style="solid" border-color="ui.border" border-radius="ui.radius-control" min-width="0px" background-color="ui.surface"
      svg width="ui.space-16" height="ui.space-16" margin-top="ui.space-2" flex-shrink=0 viewBox="0 0 24 24" fill="none" stroke=((variant == "danger" or variant == "destructive") ? "ui.danger" : "ui.foreground") stroke-width="ui.stroke-medium" aria-hidden=true
        circle cx=12 cy=12 r=9
        path d="M12 7v6m0 3v1"
      column gap="ui.space-2" min-width="0px"
        text title font-size="ui.text-sm" font-weight=uiWeights.medium color=((variant == "danger" or variant == "destructive") ? "ui.danger" : "ui.foreground") font-family=uiFontFamily(uiFont) data-rightui-font="body"
        text description font-size="ui.text-sm" line-height="ui.leading-normal" color=((variant == "danger" or variant == "destructive") ? "ui.danger" : "ui.muted-foreground") hyphens="auto" font-family=uiFontFamily(uiFont) data-rightui-font="body"

component Avatar
  props
    id: string
    src: string
    name: string
    fallback: string
  view
    AvatarFrame(id=id, name=name, src=src, fallback=fallback, size="default")

component Progress
  props
    id: string
    label: string
    value: number
  inject
    uiFont: string
  derive bounded = max(0, min(100, value))
  view
    column gap="ui.space-8" min-width="0px"
      row justify-content="space-between" gap="ui.space-12" flex-wrap="wrap"
        text label font-size="ui.text-caption" color="ui.foreground" font-family=uiFontFamily(uiFont) data-rightui-font="body"
        text (bounded.toFixed(0) + " %") testId=(id + "-value") font-size="ui.text-caption" font-variant-numeric="tabular-nums" color="ui.muted-foreground" font-family=uiFontFamily(uiFont) data-rightui-font="body"
      ProgressTrack(id=id, label=label, value=bounded)

component ProgressTrack
  props
    id: string
    label: string
    value: number
  derive bounded = max(0, min(100, value))
  view
    view id=id testId=id role="progressbar" aria-label=label aria-valuemin=0 aria-valuemax=100 aria-valuenow=bounded height="ui.space-8" border-radius="ui.radius-control" background-color="ui.muted" overflow="hidden"
      view width=(bounded.toString() + "%") height="100%" background-color="ui.primary"

component Separator
  props
    vertical: bool
  view
    view role="separator" aria-orientation=(vertical ? "vertical" : "horizontal") flex-shrink=0
      width=(vertical ? "ui.border-width" : "100%") height=(vertical ? "100%" : "ui.border-width") background-color="ui.border"

component Skeleton
  props
    id: string
    label: string
    reduced: bool
  view
    column id=id testId=id role="status" aria-label=label gap="ui.space-12" animation=(reduced ? "none" : "uiSkeletonPulse ui.duration-shimmer ui.easing infinite")
      view height="ui.space-16" width="60%" border-radius="ui.radius-md" background-color="ui.muted" aria-hidden=true
      view height="ui.space-12" width="100%" border-radius="ui.radius-md" background-color="ui.muted" aria-hidden=true
      view height="ui.space-12" width="85%" border-radius="ui.radius-md" background-color="ui.muted" aria-hidden=true

component Kbd
  props
    label: string
  inject
    uiWeights: FontWeights
    uiFont: string
  view
    text label display="flex" align-items="center" justify-content="center" min-width="ui.space-20" height="ui.space-20" box-sizing="border-box" font-family=uiFontFamily(uiFont) data-rightui-font="body" font-size="ui.text-xs" font-weight=uiWeights.medium line-height="ui.leading-normal" padding="0px ui.space-4" background-color="ui.muted" color="ui.muted-foreground" border-radius="ui.radius-sm"

component Empty
  props
    id: string
    title: string
    description: string
  inject
    uiWeights: FontWeights
    uiFont: string
  slot
  view
    column id=id testId=id align-items="center" justify-content="center" gap="ui.space-24" padding="ui.space-24" border-width="ui.border-width" border-style="dashed" border-color="ui.border" border-radius="ui.radius-panel" min-width="0px"
      svg width="ui.space-32" height="ui.space-32" viewBox="0 0 24 24" stroke="ui.muted-foreground" stroke-width="ui.stroke-medium" fill="none" aria-hidden=true
        path d="M3 7h7l2 2h9v11H3ZM3 7V4h7l2 3"
      text title font-size="ui.text-lg" font-weight=uiWeights.medium text-align="center" color="ui.foreground" font-family=uiFontFamily(uiFont) data-rightui-font="body"
      text description font-size="ui.text-sm" line-height="ui.leading-normal" text-align="center" color="ui.muted-foreground" font-family=uiFontFamily(uiFont) data-rightui-font="body"
      children

component AspectRatio
  props
    ratio: number
  slot
  view
    AspectRatioFrame(ratio=ratio, radius="ui.radius-control")
      children

component AspectRatioFrame
  props
    ratio: number
    radius: string
  slot
  view
    view appearance="none" aspect-ratio=(ratio > 0 ? ratio : 1) width="100%" min-width="0px" position="relative" overflow="hidden" border-radius=radius
      children

component Item
  props
    id: string
    title: string
    description: string
  inject
    uiWeights: FontWeights
    uiFont: string
  slot
  view
    row id=id testId=id flex-wrap="wrap" align-items="center" gap="ui.space-16" padding="ui.space-16" border-width="ui.border-width" border-style="solid" border-color="ui.border" border-radius="ui.radius-control"
      column flex="1 1 10rem" min-width="0px" gap="ui.space-4"
        text title font-size="ui.text-sm" font-weight=uiWeights.semibold color="ui.foreground" font-family=uiFontFamily(uiFont) data-rightui-font="body"
        text description font-size="ui.text-caption" line-height="ui.leading-normal" color="ui.muted-foreground" font-family=uiFontFamily(uiFont) data-rightui-font="body"
      children

component ScrollArea
  props
    id: string
    label: string
    height: number
  slot
  view
    scroll id=id testId=id aria-label=label tabindex=0 height=height min-width="0px" border-width="ui.border-width" border-style="solid" border-color="ui.border" border-radius="ui.radius-control"
      :focus-visible
        box-shadow="ui.shadow-focus"
      column padding="ui.space-16" gap="ui.space-12" min-width="0px"
        children

shape TableRow
  id: string
  cells: string[]

component Table
  props
    id: string
    label: string
    headers: string[]
    rows: TableRow[]
  inject
    uiWeights: FontWeights
    uiFont: string
  view
    scroll id=(id + "-scroll") aria-label=(label + ": horizontal scrolling") tabindex=0 min-width="0px" max-height="30rem"
      table id=id testId=id aria-label=label width="100%" border-spacing=0 font-size="ui.text-sm" color="ui.foreground"
        thead
          tr
            for heading in headers key=heading
              th scope="col" height="ui.space-40" padding="0px ui.space-8" text-align="left" border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border" color="ui.foreground" font-weight=uiWeights.medium
                text heading font-family=uiFontFamily(uiFont) data-rightui-font="body"
        tbody
          for row in rows key=row.id
            tr
              :hover
                background-color="ui.muted"
              for heading, j in headers key=heading
                td padding="ui.space-8" border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border" font-variant-numeric="tabular-nums"
                  match row.cells.at(j)
                    case some(cell)
                      text cell font-family=uiFontFamily(uiFont) data-rightui-font="body"
                    case none
                      text "" font-family=uiFontFamily(uiFont) data-rightui-font="body"

```
