shadcn.io is not affiliated with official shadcn/ui

Shadcn Scroll Area for React

Custom scrollable area with styled scrollbars.

PreviewCode

Installation

bunx --bun shadcn@latest add https://kit.dev/r/base/scroll-area.json

npx shadcn@latest add https://kit.dev/r/base/scroll-area.json

pnpm dlx shadcn@latest add https://kit.dev/r/base/scroll-area.json

yarn shadcn@latest add https://kit.dev/r/base/scroll-area.json

Install the following dependencies:

bun add @base-ui/react

npm install @base-ui/react

pnpm add @base-ui/react

yarn add @base-ui/react

Copy and paste the following code into your project.

components/ui/scroll-area.tsx

"use client";

import { ScrollArea as ScrollAreaPrimitive } from "@base-ui/react/scroll-area";
import { cn } from "@/lib/utils";

export const ScrollArea = (props: ScrollAreaPrimitive.Root.Props) => {
  const { className, children, ...rest } = props;

  return (
    <ScrollAreaPrimitive.Root
      className={cn("cn-scroll-area relative", className)}
      data-slot="scroll-area"
      {...rest}
    >
      <ScrollAreaPrimitive.Viewport
        className="cn-scroll-area-viewport size-full rounded-[inherit] outline-none transition-[color,box-shadow] focus-visible:outline-1 focus-visible:ring-[3px] focus-visible:ring-ring/50"
        data-slot="scroll-area-viewport"
      >

Update the import paths to match your project setup.

Anatomy

ScrollArea
├── ScrollAreaViewport
├── ScrollAreaContent
├── ScrollAreaScrollbar
│   └── ScrollAreaThumb
└── ScrollAreaCorner

Usage

import { Fragment } 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}`
);

const ScrollAreaDemo = () => (
  <ScrollArea className="h-72 w-48 rounded-md border">
    <div className="p-4">
      <h4 className="mb-4 font-medium text-sm leading-none">Tags</h4>
      {tags.map((tag) => (
        <Fragment key={tag}>
          <div className="text-sm">{tag}</div>
          <Separator className="my-2" />
        </Fragment>
      ))}
    </div>
  </ScrollArea>
);

Accessibility

Key	Description
`Enter`	Activate the focused item.

Demos

Horizontal

Horizontal scrolling artwork strip.

PreviewCode

Rtl

Right-to-left scroll area. See the RTL configuration guide for document direction.

PreviewCode

API Reference

ScrollArea

div

PropType

overflowEdgeThreshold?number | Partial<{ xStart: number; xEnd: number; yStart: number; yEnd: number; }>

render?ReactElement | ((props: object, state: object) => ReactElement)

className?string

AttributeType

data-slot"scroll-area"

data-scope"scroll-area"

data-part"root"

data-overflow-x?string

data-overflow-y?string

role"presentation"

CSS variableType

--corner-heightstring

--corner-widthstring

--thumb-heightstring

--thumb-widthstring

ScrollAreaViewport

div

AttributeType

data-slot"scroll-area-viewport"

data-scope"scroll-area"

data-part"viewport"

data-at-bottom?string

data-at-left?string

data-at-right?string

data-at-top?string

data-overflow-x?string

data-overflow-y?string

data-ownedbystring

role"presentation"

ScrollBar

div

PropType

keepMounted?boolean

orientation?"vertical" | "horizontal"

render?ReactElement | ((props: object, state: object) => ReactElement)

className?string

AttributeType

data-slot"scroll-area-scrollbar"

data-scope"scroll-area"

data-part"scrollbar"

data-orientation?string

ScrollAreaThumb

div

AttributeType

data-slot"scroll-area-thumb"

data-scope"scroll-area"

data-part"thumb"

ScrollAreaCorner

div

AttributeType

data-scope"scroll-area"

data-part"corner"

data-hover?string

data-overflow-x?string

data-overflow-y?string

data-ownedbystring

data-statestring