Command Palette
Search for a command to run...
Scroll Area
Augments native scroll functionality for custom, cross-browser styling.
Tags
v1.2.0-beta.50
v1.2.0-beta.49
v1.2.0-beta.48
v1.2.0-beta.47
v1.2.0-beta.46
v1.2.0-beta.45
v1.2.0-beta.44
v1.2.0-beta.43
v1.2.0-beta.42
v1.2.0-beta.41
v1.2.0-beta.40
v1.2.0-beta.39
v1.2.0-beta.38
v1.2.0-beta.37
v1.2.0-beta.36
v1.2.0-beta.35
v1.2.0-beta.34
v1.2.0-beta.33
v1.2.0-beta.32
v1.2.0-beta.31
v1.2.0-beta.30
v1.2.0-beta.29
v1.2.0-beta.28
v1.2.0-beta.27
v1.2.0-beta.26
v1.2.0-beta.25
v1.2.0-beta.24
v1.2.0-beta.23
v1.2.0-beta.22
v1.2.0-beta.21
v1.2.0-beta.20
v1.2.0-beta.19
v1.2.0-beta.18
v1.2.0-beta.17
v1.2.0-beta.16
v1.2.0-beta.15
v1.2.0-beta.14
v1.2.0-beta.13
v1.2.0-beta.12
v1.2.0-beta.11
v1.2.0-beta.10
v1.2.0-beta.9
v1.2.0-beta.8
v1.2.0-beta.7
v1.2.0-beta.6
v1.2.0-beta.5
v1.2.0-beta.4
v1.2.0-beta.3
v1.2.0-beta.2
v1.2.0-beta.1
A scroll area component built on top of Radix UI Scroll Area.
Installation
npx shadcn@latest add scroll-area
Usage
import { ScrollArea } from "@/components/ui/scroll-area"
<ScrollArea className="h-[200px] w-[350px] rounded-md border p-4">Jokester began sneaking into the castle in the middle of the night and leavingjokes all over the place: under the king's pillow, in his soup, even in theroyal toilet. The king was furious, but he couldn't seem to catch theprankster. Finally, he decided to set up a trap. He announced that he wasgoing on a journey and would be gone for a week. But instead of leaving, hehid in the castle. That night, as the jokester was leaving a whoopee cushionon the throne, the king jumped out and caught him. "Aha!" he cried. "So you'rethe one who's been making a fool of me all this time!" The jokester replied,"I'm not the one who sat on a whoopee cushion!"</ScrollArea>
Examples
Vertical
Tags
v1.2.0-beta.50
v1.2.0-beta.49
v1.2.0-beta.48
v1.2.0-beta.47
v1.2.0-beta.46
v1.2.0-beta.45
v1.2.0-beta.44
v1.2.0-beta.43
v1.2.0-beta.42
v1.2.0-beta.41
v1.2.0-beta.40
v1.2.0-beta.39
v1.2.0-beta.38
v1.2.0-beta.37
v1.2.0-beta.36
v1.2.0-beta.35
v1.2.0-beta.34
v1.2.0-beta.33
v1.2.0-beta.32
v1.2.0-beta.31
v1.2.0-beta.30
v1.2.0-beta.29
v1.2.0-beta.28
v1.2.0-beta.27
v1.2.0-beta.26
v1.2.0-beta.25
v1.2.0-beta.24
v1.2.0-beta.23
v1.2.0-beta.22
v1.2.0-beta.21
v1.2.0-beta.20
v1.2.0-beta.19
v1.2.0-beta.18
v1.2.0-beta.17
v1.2.0-beta.16
v1.2.0-beta.15
v1.2.0-beta.14
v1.2.0-beta.13
v1.2.0-beta.12
v1.2.0-beta.11
v1.2.0-beta.10
v1.2.0-beta.9
v1.2.0-beta.8
v1.2.0-beta.7
v1.2.0-beta.6
v1.2.0-beta.5
v1.2.0-beta.4
v1.2.0-beta.3
v1.2.0-beta.2
v1.2.0-beta.1
import * as React from "react"import { ScrollArea } from "@/components/ui/scroll-area"import { Separator } from "@/components/ui/separator"const tags = Array.from({ length: 50 }).map((_, i, a) => `v1.2.0-beta.${a.length - i}`)export default function ScrollAreaDemo() {return ( <ScrollArea className="h-72 w-48 rounded-md border"> <div className="p-4"> <h4 className="mb-4 text-sm font-medium leading-none">Tags</h4> {tags.map((tag) => ( <> <div key={tag} className="text-sm"> {tag} </div> <Separator className="my-2" /> </> ))} </div> </ScrollArea>)}
Horizontal
import * as React from "react"import Image from "next/image"import { ScrollArea, ScrollBar } from "@/components/ui/scroll-area"export interface Artwork {artist: stringart: string}export const works: Artwork[] = [{ artist: "Ornella Binni", art: "https://images.unsplash.com/photo-1465869185982-5a1a7522cbcb?auto=format&fit=crop&w=300&q=80",},{ artist: "Tom Byrom", art: "https://images.unsplash.com/photo-1548516173-3cabfa4607e9?auto=format&fit=crop&w=300&q=80",},{ artist: "Vladimir Malyavko", art: "https://images.unsplash.com/photo-1494337480532-3725c85fd2ab?auto=format&fit=crop&w=300&q=80",},]export default function ScrollAreaHorizontalDemo() {return ( <ScrollArea className="w-96 whitespace-nowrap rounded-md border"> <div className="flex w-max space-x-4 p-4"> {works.map((artwork) => ( <figure key={artwork.artist} className="shrink-0"> <div className="overflow-hidden rounded-md"> <Image src={artwork.art} alt={`Photo by ${artwork.artist}`} className="aspect-[3/4] h-fit w-fit object-cover" width={300} height={400} /> </div> <figcaption className="pt-2 text-xs text-muted-foreground"> Photo by{" "} <span className="font-semibold text-foreground"> {artwork.artist} </span> </figcaption> </figure> ))} </div> <ScrollBar orientation="horizontal" /> </ScrollArea>)}
Props
ScrollArea
Extends React.ComponentProps<typeof ScrollAreaPrimitive.Root>
| Prop | Type | Default | Description |
| :-- | :-- | :-- | :-- |
| type
| "auto" \| "always" \| "scroll" \| "hover"
| "hover"
| Determines when scrollbars are shown. |
| scrollHideDelay
| number
| 600
| Duration in ms after which scrollbars are hidden when type
is "scroll"
or "hover"
. |
ScrollBar
Extends React.ComponentProps<typeof ScrollAreaPrimitive.ScrollAreaScrollbar>
| Prop | Type | Default | Description |
| :-- | :-- | :-- | :-- |
| orientation
| "vertical" \| "horizontal"
| "vertical"
| The orientation of the scrollbar. |