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 で使うを参照してください。