Docs
Scroll-area

Scroll-area

Augments native scroll functionality for custom, cross-browser styling.

Reference
Loading...

Installation

Install the following dependencies:

npm install @radix-ui/react-scroll-area

Copy and paste the following code into your project.

"use client";
 
import * as React from "react";
import * as ScrollAreaPrimitive from "@radix-ui/react-scroll-area";
 
import { autoRef, cn } from "@/lib/utils";
 
/* ---------------------------------- Area ---------------------------------- */
 
export type ScrollAreaProps = React.ComponentPropsWithRef<
  typeof ScrollAreaPrimitive.Root
>;
 
export const ScrollArea = autoRef(
  ({ className, children, ...props }: ScrollAreaProps) => {
    return (
      <ScrollAreaPrimitive.Root
        className={cn("relative overflow-hidden", className)}
        {...props}
      >
        <ScrollAreaPrimitive.Viewport className="h-full w-full rounded-[inherit]">
          {children}
        </ScrollAreaPrimitive.Viewport>
        <ScrollBar />
        <ScrollAreaPrimitive.Corner />
      </ScrollAreaPrimitive.Root>
    );
  },
);
 
/* ----------------------------------- Bar ---------------------------------- */
 
export type ScrollBarProps = React.ComponentPropsWithRef<
  typeof ScrollAreaPrimitive.ScrollAreaScrollbar
>;
 
const ScrollBar = autoRef(
  ({ className, orientation = "vertical", ...props }: ScrollBarProps) => {
    return (
      <ScrollAreaPrimitive.ScrollAreaScrollbar
        orientation={orientation}
        className={cn(
          "flex touch-none select-none transition-colors",
          orientation === "vertical" &&
            "h-full w-2.5 border-l border-l-transparent p-[1px]",
          orientation === "horizontal" &&
            "h-2.5 flex-col border-t border-t-transparent p-[1px]",
          className,
        )}
        {...props}
      >
        <ScrollAreaPrimitive.ScrollAreaThumb className="relative flex-1 rounded-full bg-border" />
      </ScrollAreaPrimitive.ScrollAreaScrollbar>
    );
  },
);

Update the import paths to match your project setup.

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 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>