# Scroll View

Scrollable container with scrollbar



<ComponentPreview base="opentui" name="scroll-view-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/opentui-scroll-view
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource base="opentui" name="scroll-view" title="components/ui/scroll-view.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { ScrollView } from "@/components/ui/scroll-view";
```

```tsx
<ScrollView height={5} contentHeight={20}>
  <Text>Line 1</Text>
  <Text>Line 2</Text>
  <Text>Line 3</Text>
</ScrollView>
```

Examples [#examples]

Scrollbar and keys [#scrollbar-and-keys]

Set `contentHeight` to the total line count of scrollable content so the thumb size reflects how much is hidden. Use arrow keys, Page Up/Down, Home, and End to scroll.

<ComponentPreview base="opentui" name="scroll-view-scrollbar" />

API Reference [#api-reference]

ScrollView [#scrollview]

| Prop             | Type        | Default    |
| ---------------- | ----------- | ---------- |
| `height`         | `number`    | `required` |
| `children`       | `ReactNode` | `required` |
| `contentHeight`  | `number`    | `0`        |
| `showScrollbar`  | `boolean`   | `true`     |
| `scrollbarColor` | `string`    | -          |
| `thumbColor`     | `string`    | -          |
| `trackChar`      | `string`    | `"│"`      |
| `thumbChar`      | `string`    | `"█"`      |