mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-26 06:05:56 +00:00
81 lines
1.8 KiB
Plaintext
81 lines
1.8 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"
|
|
description="A scroll area component."
|
|
/>
|
|
|
|
## 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 } from "@/components/ui/scroll-area"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<ScrollArea className="h-[200px] w-[350px] rounded-md border p-4">
|
|
Jokester began sneaking into the castle in the middle of the night and leaving
|
|
jokes all over the place: under the king's pillow, in his soup, even in the
|
|
royal toilet. The king was furious, but he couldn't seem to stop Jokester. And
|
|
then, one day, the people of the kingdom discovered that the jokes left by
|
|
Jokester were so funny that they couldn't help but laugh. And once they
|
|
started laughing, they couldn't stop.
|
|
</ScrollArea>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Horizontal Scrolling
|
|
|
|
<ComponentPreview styleName="base-nova" name="scroll-area-horizontal-demo" />
|