pepeloper/ uipepeloper.dev

Layout

Scroll Area

Contained scrolling.

Scroll Area

Contained scrolling.

Layout
View component

Install

Install
npx shadcn@latest add http://localhost:3000/r/scroll-area.json

Usage

scroll-area-example.tsx
"use client"

import { ScrollArea } from "@/components/ui/scroll-area"
import { Separator } from "@/components/ui/separator"

export function Example() {
  return (
    <ScrollArea className="h-24 w-full max-w-xs rounded-lg border p-3">
      <div className="space-y-3 text-xs text-muted-foreground">
        <p>Scroll Area keeps long content inside a deliberate surface.</p>
        <Separator />
        <p>It works for lists, side panels and dense settings.</p>
        <Separator />
        <p>The scrollbar stays part of the component contract.</p>
      </div>
    </ScrollArea>
  )
}

API

ScrollAreaScrollBar
TypeScript
function ScrollArea(props: ScrollAreaPrimitive.Root.Props)

function ScrollBar(props: ScrollAreaPrimitive.Scrollbar.Props)
Source code +
components/ui/scroll-area.tsx
"use client"

import * as React from "react"
import { ScrollArea as ScrollAreaPrimitive } from "@base-ui/react/scroll-area"
import { cn } from "cn"

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

function ScrollBar({
  className,
  orientation = "vertical",
  ...props
}: ScrollAreaPrimitive.Scrollbar.Props) {
  return (
    <ScrollAreaPrimitive.Scrollbar
      data-slot="scroll-area-scrollbar"
      data-orientation={orientation}
      orientation={orientation}
      className={cn(
        "flex touch-none p-px transition-colors select-none data-horizontal:h-2.5 data-horizontal:flex-col data-horizontal:border-t data-horizontal:border-t-transparent data-vertical:h-full data-vertical:w-2.5 data-vertical:border-l data-vertical:border-l-transparent",
        className
      )}
      {...props}
    >
      <ScrollAreaPrimitive.Thumb
        data-slot="scroll-area-thumb"
        className="relative flex-1 rounded-full bg-border"
      />
    </ScrollAreaPrimitive.Scrollbar>
  )
}

export { ScrollArea, ScrollBar }

Registry JSON ↗

← ResizableSelect →