mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-25 21:56:08 +00:00
102 lines
1.9 KiB
Plaintext
102 lines
1.9 KiB
Plaintext
---
|
|
title: Scroll Area
|
|
description: Augments native scroll functionality for custom, cross-browser styling.
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/scroll-area
|
|
api: https://base-ui.com/react/components/scroll-area#api-reference
|
|
---
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="scroll-area-demo"
|
|
previewClassName="h-96"
|
|
/>
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add scroll-area
|
|
```
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install @base-ui/react
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="scroll-area"
|
|
title="components/ui/scroll-area.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import { ScrollArea, ScrollBar } from "@/components/ui/scroll-area"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<ScrollArea className="h-[200px] w-[350px] rounded-md border p-4">
|
|
Your scrollable content here.
|
|
</ScrollArea>
|
|
```
|
|
|
|
## Composition
|
|
|
|
Use the following composition to build a `ScrollArea`:
|
|
|
|
```text
|
|
ScrollArea
|
|
└── ScrollBar
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Horizontal
|
|
|
|
Use `ScrollBar` with `orientation="horizontal"` for horizontal scrolling.
|
|
|
|
<ComponentPreview styleName="base-nova" name="scroll-area-horizontal-demo" />
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="scroll-area-rtl"
|
|
direction="rtl"
|
|
previewClassName="h-auto"
|
|
/>
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI Scroll Area](https://base-ui.com/react/components/scroll-area#api-reference) documentation.
|