Carousel

前後のボタンとインジケーターを持つスライドです。

01Install

02Configure

03Write

04Publish

インポート

import {
  Carousel,
  CarouselContent,
  CarouselItem,
  CarouselControls,
  CarouselPrevious,
  CarouselNext,
  CarouselIndicators,
} from "@pelagornis/page/components";

例

上のプレビューはこのファイルを描画したものです。src/components/ にコピーして使い始めてください。

import {
  Box,
  Carousel,
  CarouselContent,
  CarouselControls,
  CarouselIndicators,
  CarouselItem,
  CarouselNext,
  CarouselPrevious,
  Stack,
  Text,
} from "@pelagornis/page/components";

const slides = [
  { eyebrow: "01", title: "Install" },
  { eyebrow: "02", title: "Configure" },
  { eyebrow: "03", title: "Write" },
  { eyebrow: "04", title: "Publish" },
];

export default function CarouselDemo() {
  return (
    <Carousel loop className="w-full">
      <CarouselContent>
        {slides.map((slide) => (
          <CarouselItem key={slide.title}>
            <Box
              padding="sizeXLarge"
              background="backgroundBrand"
              className="flex min-h-refineui-foundation-size-2000 flex-col justify-end"
            >
              <Stack gap="sizeXSmall">
                <Text variant="captionMd" className="m-0 text-refineui-alias-foreground-on-brand">
                  {slide.eyebrow}
                </Text>
                <Text as="strong" variant="titleMd" className="text-refineui-alias-foreground-on-brand">
                  {slide.title}
                </Text>
              </Stack>
            </Box>
          </CarouselItem>
        ))}
      </CarouselContent>
      <CarouselControls>
        <CarouselPrevious />
        <CarouselIndicators />
        <CarouselNext />
      </CarouselControls>
    </Carousel>
  );
}

MDX で使う

Carousel は React の状態を共有する複数のパーツで構成されます。MDX に書いた子要素はそれぞれ別のアイランドとして描画されるため、パーツ同士がつながりません。上の例のように .tsx ファイルで組み立て、そのファイルをインポートしてください。

---
title: Example
---

import CarouselExample from "../../components/CarouselExample";

<CarouselExample client:load />

client:load はページの読み込み時にアイランドをハイドレートします。ページの下の方にあるコンテンツには client:visible を使ってください。

Markdoc で使う

Markdoc のタグは Astro コンポーネントを描画しますが、このコンポーネントにはクライアントの状態が必要です。例をハイドレートする .astro ファイルで包み、そのファイルをタグとして登録してください。

---
import CarouselExample from "../CarouselExample";
---

<CarouselExample 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: {
    "carousel-example": {
      render: component("./src/components/markdoc/CarouselExample.astro"),
      selfClosing: true,
    },
  },
});

{% carousel-example /%}

構造

コンポーネントを構成するパーツと、それぞれが描画する data-refineui のロールです。

パーツ	ロール
`root`	carousel
`controls`	carousel-controls
`indicator`	carousel-indicator
`indicator_hits`	carousel-indicator-hits
`indicator_thumb`	carousel-indicator-thumb
`indicators`	carousel-indicators
`item`	carousel-item
`nav`	carousel-nav
`track`	carousel-track
`viewport`	carousel-viewport

状態

コンポーネントがスタイルを当てる状態です。コンポーネントの状態は data 属性として公開されます。

種類	状態
疑似クラス	`focus-visible`

キーボード

フォーカスがあるときにコンポーネントが処理するキーです。

キー	動作
`ArrowRight`	next-trigger
`ArrowLeft`	previous-trigger
`Home`	first-trigger
`End`	last-trigger

参考

デザインのガイドとトークンの詳細は RefineUI · Carousel を参照してください。
共通のルールは MDX で使うと Markdoc で使うを参照してください。