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 中使用。