JGuang
EN

滚动区域

Scroll Area · Chakra UI

交互预览
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

滚动区域

在有限尺寸内滚动内容并自定义滚动条。必须有合理的尺寸约束，检查横向、纵向与键盘访问；虚拟化、吸底和滚动阴影各有独立状态。

随附图标许可

源码查看器包含 ICON_ATTRIBUTION.md，以及本组示例实际使用的图标集合原始许可。再分发示例时请保留；react-icons 封装包的许可证不能替代各图标集合自身的条款。

  • Lucide: ISC

安装与初始化

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

渲染前配置 ChakraProvider、defaultSystem 和 Emotion。保留宿主项目的 React 版本并检查 peer 兼容。官方 npm 安装提供组件包，不会复制以下示例源码。locale、next-themes 和框架专属 SSR 配置见资源安装指南；npm 安装之外还需单独复制所选示例源码。

完整原生使用示例

这是固定版本的真实示例，不是通用 API 伪代码。复制完整源码依赖并保留命名导出；附加依赖逐例列在下方。

import { ScrollArea } from "@chakra-ui/react"
import LoremIpsum from "react-lorem-ipsum"

export const ScrollAreaBasic = () => (
  <ScrollArea.Root height="8.5rem" maxW="lg">
    <ScrollArea.Viewport>
      <ScrollArea.Content spaceY="4" textStyle="sm">
        <LoremIpsum p={3} />
      </ScrollArea.Content>
    </ScrollArea.Viewport>
    <ScrollArea.Scrollbar>
      <ScrollArea.Thumb />
    </ScrollArea.Scrollbar>
    <ScrollArea.Corner />
  </ScrollArea.Root>
)

全部示例与复现要求

示例名称用于选择演示，不是组件通用 variant 属性。复制所选示例全部 sourceFiles；compositions 别名表示本地文件，不是 npm 包。保留相对导入或映射到宿主真实目录。React peer 单独检查；编辑器示例保留一致的固定 Tiptap 扩展版本。

基础用法

scroll-area-basic · 命名导出 ScrollAreaBasic · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/scroll-area-basic.tsx

不同变体

scroll-area-with-variants · 命名导出 ScrollAreaWithVariants · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/scroll-area-with-variants.tsx

不同尺寸

scroll-area-with-sizes · 命名导出 ScrollAreaWithSizes · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/scroll-area-with-sizes.tsx

水平

scroll-area-horizontal · 命名导出 ScrollAreaHorizontal · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/scroll-area-horizontal.tsx
  • vendor/apps/compositions/src/lib/decorative-box.tsx

双向方向

scroll-area-both-directions · 命名导出 ScrollAreaBothDirections · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/scroll-area-both-directions.tsx

滚动阴影

scroll-area-with-scroll-shadow · 命名导出 ScrollAreaWithScrollShadow · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/scroll-area-with-scroll-shadow.tsx
  • vendor/apps/compositions/src/lib/decorative-box.tsx

拇指样式

scroll-area-with-thumb-styling · 命名导出 ScrollAreaWithThumbStyling · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/scroll-area-with-thumb-styling.tsx

吸附到底部

scroll-area-stick-to-bottom · 命名导出 ScrollAreaStickToBottom · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 react-icons@5.6.0 use-stick-to-bottom@1.1.6
  • vendor/apps/compositions/src/examples/scroll-area-stick-to-bottom.tsx
  • vendor/apps/compositions/src/lib/decorative-box.tsx

虚拟化

scroll-area-virtualization · 命名导出 ScrollAreaVirtualization · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 @tanstack/react-virtual@3.14.2
  • vendor/apps/compositions/src/examples/scroll-area-virtualization.tsx
  • vendor/apps/compositions/src/lib/decorative-box.tsx

外部状态仓库

scroll-area-with-store · 命名导出 ScrollAreaWithStore · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/scroll-area-with-store.tsx

滚动到侧边

scroll-area-scroll-to-side · 命名导出 ScrollAreaScrollToSide · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/scroll-area-scroll-to-side.tsx

滚动到位置

scroll-area-scroll-to-position · 命名导出 ScrollAreaScrollToPosition · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 prop-types@15.8.1 react-lorem-ipsum@1.4.10
  • vendor/apps/compositions/src/examples/scroll-area-scroll-to-position.tsx

从右向左布局

scroll-area-with-rtl · 命名导出 ScrollAreaWithRtl · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/scroll-area-with-rtl.tsx

菜单

scroll-area-with-menu · 命名导出 ScrollAreaWithMenu · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/scroll-area-with-menu.tsx

原生 API 与源码参考

源码查看器保留原始声明、import 与继承关系。Ark UI 事件契约、Chakra 样式属性和 recipe 类型仍以原生包为准；本指南不平铺或编造默认值。代码注释保留原文，不冒充正文翻译。

  • npm/@chakra-ui/react@3.37.0/dist/types/components/scroll-area/index.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/scroll-area/namespace.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/scroll-area/scroll-area.d.ts

Vite 8 定向导出兼容

本组部分示例导入 react-lorem-ipsum@1.4.10。已验证的 Vite 8 消费项目在 plugins 中使用随附 authored/native-package-interop.mjs 的 chakraNativePackageInterop(process.cwd())。将该辅助模块放入宿主构建配置并调整导入路径。它只解包原生 CommonJS 默认导出，不替换组件实现；仅在复现相同导出差异时使用，其他构建器可能不需要。

状态与安装后检查

执行严格类型检查、目标项目生产构建和实际操作。检查名称／焦点／键盘、深浅色、窄屏、原生支持的空／加载／错误状态以及卸载清理。预览限制远程接口、上传与下载，业务服务需自行配置。复制命令或预览就绪不代表安装完成或后端成功。

来源与许可边界

https://github.com/chakra-ui/chakra-ui/tree/2e7517745cff2fcde0b8012f136cf99611ff262a

本页是 JGuang 双语实用说明，不声称全文翻译上游 MDX。原始文档与示例字节保留在 vendor。保留仓库 MIT、compositions 的 ISC 元数据和独立依赖声明；原始许可元数据差异与缺失完整声明仍作为显式审查事项，不包含 Chakra Pro 付费内容。