Progress Stepper

1. Account
2. Profile
3. Complete

Import

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

Example

The preview above renders this file. Copy it into src/components/ to start from it.

src/components/ProgressStepperExample.tsx

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>
  );
}

Use in MDX

Progress Stepper is composed from parts that share React state. Children written in MDX are rendered as separate islands, so the parts can’t reach each other. Put the composition in a .tsx file, like the example above, and import that file instead.

src/content/docs/example.mdx

---
title: Example
---

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

<ProgressStepperExample client:load />

client:load hydrates the island on page load. Use client:visible for content far down the page.

Use in Markdoc

Markdoc tags render Astro components, and this one needs client state. Wrap the example in an .astro file that hydrates it, then register that file as a tag.

src/components/markdoc/ProgressStepperExample.astro

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

<ProgressStepperExample client:load />

markdoc.config.mjs

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,
    },
  },
});

src/content/docs/example.mdoc

{% progress-stepper-example /%}

Anatomy

Parts of the component and the data-refineui role each one renders.

Part	Role
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

States

States the component styles. Component states are exposed as data attributes.

Kind	States
data-state	complete current upcoming

Reference

• RefineUI · Progress Stepper for design guidance and token detail.
• Use in MDX and Use in Markdoc for the general rules.