Steps

Overview

Copy the source into your project, then import the parts you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without wrapping or replacing a package.

Installation

Run bunx @yopem-ui/cli init from your project root first. The CLI configures StyleX and installs shared files and dependencies.

bunx @yopem-ui/cli init

bunx @yopem-ui/cli add steps

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. Existing files are preserved. To refresh installed source, use update; locally edited files need an explicit --force to overwrite.

bunx @yopem-ui/cli update steps

Preview

"use client"

import { Steps, StepsItem } from "@registry/components/ui/steps"

export function Preview() {

Usage

Compose StepsItem inside Steps in process order. Set status=current for the active item; the current step is exposed with aria-current=step.

Import from the local file installed by the CLI.

"use client"

import { Steps, StepsItem } from "@/components/ui/steps"

export function Preview() {
  return <Steps><StepsItem status="completed">Account</StepsItem><StepsItem status="current">Preferences</StepsItem><StepsItem>Finish</StepsItem></Steps>
}

API reference

Generated from canonical TypeScript source. Only component and Base UI props appear below. Required marks a required property, not a required component.