For the complete documentation index, see llms.txt. Markdown variants are available by appending .md to any URL or sending an Accept: text/markdown header. An agent skill is available at /.well-known/agent-skills/site-skill.md.
30
Sponsor

Progress Steps

PreviousNext

Progress indicator with horizontal or vertical layout and step statuses.

Cart
Shipping
Payment
Confirm

Installation

$ pnpm dlx shadcn@latest add @mcpcn/progress-steps

Usage

import {
  ProgressSteps,
  ProgressStepsList,
} from "@/components/ui/progress-steps";
<ProgressSteps>
  <ProgressStepsList />
</ProgressSteps>

Composition

Use the following composition to build an ProgressSteps:

ProgressSteps
├── ProgressStepsList
└── ProgressStep

OpenUI Integration

Install the OpenUI React packages.

pnpm add @openuidev/react-lang zod

Add ProgressSteps to a component library and map it to the installed component.

import { createLibrary, defineComponent } from "@openuidev/react-lang";
import { z } from "zod/v4";
 
import {
  ProgressSteps,
  ProgressStepsList,
} from "@/components/ui/progress-steps";
 
const OpenUIProgressSteps = defineComponent({
  name: "ProgressSteps",
  description:
    "Progress indicator with horizontal or vertical layout and step statuses.",
  props: z.object({}),
  component: () => (
    <ProgressSteps>
      <ProgressStepsList />
    </ProgressSteps>
  ),
});
 
export const progress_stepsLibrary = createLibrary({
  root: "ProgressSteps",
  components: [OpenUIProgressSteps],
});

For richer generated compositions, define the child primitives separately and connect them with .ref fields. See Defining Components in the OpenUI documentation.

json-render Integration

Install the json-render React packages.

pnpm add @json-render/core @json-render/react zod

Add ProgressSteps to a component catalog and map it to the installed component.

import { defineCatalog } from "@json-render/core";
import { defineRegistry } from "@json-render/react";
import { schema } from "@json-render/react/schema";
import { z } from "zod";
 
import {
  ProgressSteps,
  ProgressStepsList,
} from "@/components/ui/progress-steps";
 
export const catalog = defineCatalog(schema, {
  components: {
    ProgressSteps: {
      props: z.object({}),
      description:
        "Progress indicator with horizontal or vertical layout and step statuses.",
    },
  },
});
 
export const { registry } = defineRegistry(catalog, {
  components: {
    ProgressSteps: () => (
      <ProgressSteps>
        <ProgressStepsList />
      </ProgressSteps>
    ),
  },
});

Use catalog.prompt() to constrain model output, then render the generated spec with the json-render React Renderer. See the json-render Quick Start for the provider and streaming setup.

API Reference

See the Base UI documentation for more information.