Scroll Area

带令牌样式滚动条的滚动容器。

v2.20.0v2.19.0v2.18.0v2.17.0v2.16.0v2.15.0v2.14.0v2.13.0v2.12.0v2.11.0v2.10.0v2.9.0v2.8.0v2.7.0v2.6.0v2.5.0v2.4.0v2.3.0v2.2.0v2.1.0

导入

import {
  ScrollArea,
  ScrollAreaViewport,
  ScrollAreaScrollbar,
  ScrollAreaThumb,
} from "@pelagornis/page/components";

示例

上方预览渲染的就是这个文件。把它复制到 src/components/ 即可开始使用。

import {
  ScrollArea,
  ScrollAreaScrollbar,
  ScrollAreaThumb,
  ScrollAreaViewport,
  Stack,
  Text,
} from "@pelagornis/page/components";

const releases = Array.from({ length: 20 }, (_, index) => `v2.${20 - index}.0`);

export default function ScrollAreaDemo() {
  return (
    <ScrollArea type="hover" className="h-48 w-full max-w-xs">
      <ScrollAreaViewport>
        <Stack gap="sizeXSmall">
          {releases.map((release) => (
            <Text key={release} variant="bodyMd">
              {release}
            </Text>
          ))}
        </Stack>
      </ScrollAreaViewport>
      <ScrollAreaScrollbar orientation="vertical">
        <ScrollAreaThumb />
      </ScrollAreaScrollbar>
    </ScrollArea>
  );
}

在 MDX 中使用

Scroll Area 由共享 React 状态的多个部件组成。写在 MDX 中的子元素会各自渲染成独立的岛，部件之间无法互通。请像上面的示例一样在 .tsx 文件中组合，再导入该文件。

---
title: Example
---

import ScrollAreaExample from "../../components/ScrollAreaExample";

<ScrollAreaExample client:load />

client:load 会在页面加载时水合该岛。位于页面靠下位置的内容请使用 client:visible。

在 Markdoc 中使用

Markdoc 标签渲染的是 Astro 组件，而这个组件需要客户端状态。请把示例包进一个负责水合的 .astro 文件，再把该文件注册为标签。

---
import ScrollAreaExample from "../ScrollAreaExample";
---

<ScrollAreaExample client:load />

import { component, defineMarkdocConfig } from "@astrojs/markdoc/config";
import starlightMarkdoc from "@astrojs/starlight-markdoc";
import pageMarkdoc from "@pelagornis/page/markdoc";

export default defineMarkdocConfig({
  extends: [starlightMarkdoc(), pageMarkdoc()],
  tags: {
    "scroll-area-example": {
      render: component("./src/components/markdoc/ScrollAreaExample.astro"),
      selfClosing: true,
    },
  },
});

{% scroll-area-example /%}

变体

每个 variant prop 可接受的取值。

Prop	取值
`type`	`hover` `always`

结构

组件的组成部分，以及每个部分渲染的 data-refineui 角色。

部件	角色
`root`	scroll-area
`scrollbar`	scroll-area-scrollbar
`thumb`	scroll-area-thumb
`track`	scroll-area-track
`viewport`	scroll-area-viewport

状态

组件会设置样式的状态。组件状态通过 data 属性暴露。

类型	状态
data-state	`visible` `hidden`

参考

设计指南和令牌细节见 RefineUI · Scroll Area。
通用规则见在 MDX 中使用和在 Markdoc 中使用。