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/aria/scroll-area.json

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

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

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

Copy and paste the following code into your project.

components/ui/scroll-area.tsx

"use client";

import type React from "react";
import { cn } from "@/lib/utils";

export const ScrollArea = (props: React.ComponentProps<"div">) => {
  const { className, children, ...rest } = props;

  return (
    <div
      className={cn(
        "cn-scroll-area relative overflow-auto outline-none [scrollbar-color:var(--color-border)_transparent] [scrollbar-width:thin] focus-visible:outline-1 focus-visible:ring-[3px] focus-visible:ring-ring/50",
        className
      )}
      data-slot="scroll-area"
      {...rest}
    >
      {children}

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

PropType

className?string

AttributeType

data-slot"scroll-area"

CSS variableType

--color-borderstring