# Progress Steps

Progress indicator with horizontal or vertical layout and step statuses.

> For the complete documentation index, see [llms.txt](/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](/.well-known/agent-skills/site-skill.md).



<ComponentPreview name="progress-steps" src="examples/progress-steps-demo.tsx" />

## Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @mcpcn/progress-steps
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps className="mb-0 pt-2">
      <Step>
        Install the component dependencies:
      </Step>

      ```bash
      npm install lucide-react
      ```

      <Step>
        Copy and paste the component into your project.
      </Step>

      <ComponentSource name="progress-steps" title="components/ui/progress-steps.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

## Usage [#usage]

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

```tsx
<ProgressSteps>
  <ProgressStepsList />
</ProgressSteps>
```

## Composition [#composition]

Use the following composition to build an `ProgressSteps`:

```text
ProgressSteps
├── ProgressStepsList
└── ProgressStep
```

## OpenUI Integration [#openui-integration]

Install the OpenUI React packages.

```bash
pnpm add @openuidev/react-lang zod
```

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

```tsx showLineNumbers
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](https://www.openui.com/docs/openui-lang/defining-components) in the OpenUI documentation.

## json-render Integration [#json-render-integration]

Install the json-render React packages.

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

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

```tsx
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](https://json-render.dev/docs/quick-start) for the provider and streaming setup.

## API Reference [#api-reference]

See the [Base UI](https://base-ui.com/react/overview/quick-start) documentation for more information.