跳到内容

滚动区域

一个带自定义跨浏览器滚动条的可滚动容器,适用于聊天面板、侧边栏和文件树——配有粗犷的新粗野主义风格滚动按钮。

import * as React from "react"

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

滚动区域把浏览器的默认滚动条换成由您定义样式的滚动条——原生滚动依然在底层工作,因此滚轮、触摸和惯性滑动的行为丝毫未变。它基于 Base UI Scroll Area 组件构建,并按新粗野主义的配方设计:与边框同色的实心粗滑块,以及视口上的硬质焦点环。

适合以下场景:

  • 聊天与日志面板——固定住高度,让消息在面板内滚动,而不是带着整个页面一起滚。
  • 侧边栏与文件树——独立于主内容滚动的长导航列表。
  • 横向条带——标签行、卡片画廊和宽表格,通过 orientation="horizontal" 实现。

安装

pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/scroll-area.json
npx shadcn@latest add https://neobrutalism.com/r/base/scroll-area.json
yarn dlx shadcn@latest add https://neobrutalism.com/r/base/scroll-area.json
bunx --bun shadcn@latest add https://neobrutalism.com/r/base/scroll-area.json

安装以下依赖:

pnpm add @base-ui/react
npm install @base-ui/react
yarn add @base-ui/react
bun add @base-ui/react

将以下代码复制并粘贴到您的项目中。

components/ui/scroll-area.tsx
"use client"

import * as React from "react"
import { ScrollArea as ScrollAreaPrimitive } from "radix-ui"

import { cn } from "@/lib/utils"

function ScrollArea({
  className,
  children,
  ...props
}: React.ComponentProps<typeof ScrollAreaPrimitive.Root>) {
  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:outline-2 focus-visible:outline-offset-2 focus-visible:outline-primary"
      >
        {children}
      </ScrollAreaPrimitive.Viewport>
      <ScrollBar />
      <ScrollAreaPrimitive.Corner />
    </ScrollAreaPrimitive.Root>
  )
}

function ScrollBar({
  className,
  orientation = "vertical",
  ...props
}: React.ComponentProps<typeof ScrollAreaPrimitive.ScrollAreaScrollbar>) {
  return (
    <ScrollAreaPrimitive.ScrollAreaScrollbar
      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.ScrollAreaThumb
        data-slot="scroll-area-thumb"
        className="relative flex-1 rounded bg-border"
      />
    </ScrollAreaPrimitive.ScrollAreaScrollbar>
  )
}

export { ScrollArea, ScrollBar }

更新导入路径以匹配您的项目结构。

用法

import { ScrollArea, ScrollBar } from "@/components/ui/scroll-area"
<ScrollArea className="h-[200px] w-[350px] rounded-md border p-4">
  Your scrollable content here.
</ScrollArea>

组合

使用以下组合来构建 ScrollArea

ScrollArea
└── ScrollBar

示例

水平

对于水平方向的滚动,为 ScrollBar 指定 orientation="horizontal"

import * as React from "react"
import Image from "next/image"

RTL

若要在 Neobrutalism 中启用 RTL 支持,请参阅 RTL 配置指南

"use client"

import * as React from "react"

无障碍

滚动区域没有对应的 WAI-ARIA 模式——也不需要,因为 Base UI 组件在底层保留了真正的原生滚动容器,滚轮、触摸和键盘滚动的表现与浏览器自带的完全一致。但并非每个浏览器都会自动让滚动容器可以获得键盘焦点:如果内容里没有任何可聚焦元素,请给视口加上 tabIndex={0}aria-label,键盘用户才能聚焦并滚动它——样式中已经为这种情况准备好了可见的焦点环。自定义滚动条和滑块只是为指针操作提供的可视辅助,绝不能成为唯一的滚动方式。

API 参考

更多信息请参阅 Base UI 文档。