Stepper

带标题和说明的编号步骤。

InstallAdd the package
ConfigureRegister the plugin
WriteAdd pages

导入

import {
  Stepper,
  StepperList,
  StepperItem,
  StepperIndicator,
  StepperTitle,
  StepperDescription,
  StepperSeparator,
} from "@pelagornis/page/components";

示例

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

import { Fragment, useState } from "react";
import {
  Stepper,
  StepperDescription,
  StepperIndicator,
  StepperItem,
  StepperList,
  StepperSeparator,
  StepperTitle,
} from "@pelagornis/page/components";

const steps = [
  { title: "Install", description: "Add the package" },
  { title: "Configure", description: "Register the plugin" },
  { title: "Write", description: "Add pages" },
];

export default function StepperDemo() {
  const [step, setStep] = useState(1);

  return (
    <Stepper value={step} onValueChange={setStep} className="w-full">
      <StepperList>
        {steps.map((item, index) => (
          <Fragment key={item.title}>
            {index > 0 && <StepperSeparator />}
            <StepperItem value={index}>
              <StepperIndicator>{index + 1}</StepperIndicator>
              <StepperTitle>{item.title}</StepperTitle>
              <StepperDescription>{item.description}</StepperDescription>
            </StepperItem>
          </Fragment>
        ))}
      </StepperList>
    </Stepper>
  );
}

在 MDX 中使用

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

---
title: Example
---

import StepperExample from "../../components/StepperExample";

<StepperExample client:load />

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

在 Markdoc 中使用

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

---
import StepperExample from "../StepperExample";
---

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

{% stepper-example /%}

结构

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

部件	角色
`root`	stepper
`content`	stepper-content
`description`	stepper-description
`indicator`	stepper-indicator
`item`	stepper-item
`list`	stepper-list
`separator`	stepper-separator
`separator_fill`	stepper-separator-fill
`separator_rail`	stepper-separator-rail
`separator_track`	stepper-separator-track
`title`	stepper-title

状态

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

类型	状态
data-state	`complete` `current` `upcoming`

键盘

组件获得焦点时处理的按键。

按键	动作
`Enter`	activate
`Space`	activate

参考

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