Progress Stepper

以紧凑形式显示多步骤流程的进度。

Account
Profile
Complete

导入

import {
  ProgressStepper,
  ProgressStepperList,
  ProgressStepperItem,
  ProgressStepperMarker,
  ProgressStepperLabel,
} from "@pelagornis/page/components";

示例

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

import { useState } from "react";
import {
  ProgressStepper,
  ProgressStepperItem,
  ProgressStepperLabel,
  ProgressStepperList,
  ProgressStepperMarker,
} from "@pelagornis/page/components";

const steps = ["Account", "Profile", "Complete"];

export default function ProgressStepperDemo() {
  const [step, setStep] = useState(2);

  return (
    <ProgressStepper value={step} onValueChange={setStep} className="w-full">
      <ProgressStepperList>
        {steps.map((label, index) => (
          <ProgressStepperItem key={label} value={index + 1}>
            <ProgressStepperMarker />
            <ProgressStepperLabel>{label}</ProgressStepperLabel>
          </ProgressStepperItem>
        ))}
      </ProgressStepperList>
    </ProgressStepper>
  );
}

在 MDX 中使用

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

---
title: Example
---

import ProgressStepperExample from "../../components/ProgressStepperExample";

<ProgressStepperExample client:load />

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

在 Markdoc 中使用

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

---
import ProgressStepperExample from "../ProgressStepperExample";
---

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

{% progress-stepper-example /%}

结构

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

部件	角色
`root`	progress-stepper
`fill`	progress-stepper-fill
`item`	progress-stepper-item
`label`	progress-stepper-label
`list`	progress-stepper-list
`list_wrap`	progress-stepper-list-wrap
`marker`	progress-stepper-marker
`track`	progress-stepper-track

状态

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

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

参考

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