# Progress Steps

Multi-step pipeline visualization with line fill and pulsing dots.

> 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).

## Installation

<TabsTrigger value="cli">Command</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>

```bash
npx shadcn@latest add @framecn/progress-steps
```

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

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

## Usage

```tsx
import { ProgressSteps } from "@/components/framecn/progress-steps";
```

```tsx
<ProgressSteps />
```

## API Reference

### ProgressSteps

| Prop               | Type                         | Default                                                             |
| ------------------ | ---------------------------- | ------------------------------------------------------------------- |
| `steps`            | `{ label: string }[]`        | `[{ label: "Connect" }, { label: "Process" }, { label: "Deploy" }]` |
| `orientation`      | `"horizontal" \| "vertical"` | `"horizontal"`                                                      |
| `activeColor`      | `string`                     | `"#22c55e"`                                                         |
| `inactiveColor`    | `string`                     | `"#27272a"`                                                         |
| `background`       | `string`                     | `"#0a0a0a"`                                                         |
| `textColor`        | `string`                     | `"white"`                                                           |
| `stepDuration`     | `number`                     | `30`                                                                |
| `speed`            | `number`                     | `1`                                                                 |
| `fps`              | `number`                     | `30`                                                                |
| `durationInFrames` | `number`                     | `150`                                                               |
| `width`            | `number`                     | `1000`                                                              |
| `height`           | `number`                     | `500`                                                               |
| `className`        | `string`                     | `-`                                                                 |

## Notes

  Steps show as connected dots with a line fill to the current step. Great for
  wizard or pipeline UI.