Horizontal (default)

Create account

Enter your email and password

2

Verify email

Check your inbox for a link

3

Set up profile

Add your name and avatar

4

Done

You are all set!

<Stepper
  active={1}
  steps={[
    { label: 'Create account', description: 'Enter your email and password' },
    { label: 'Verify email', description: 'Check your inbox' },
    { label: 'Set up profile', description: 'Add your name and avatar' },
    { label: 'Done', description: 'You are all set!' },
  ]}
/>

Different active steps

1

Create account

Enter your email and password

2

Verify email

Check your inbox for a link

3

Set up profile

Add your name and avatar

4

Done

You are all set!

Create account

Enter your email and password

Verify email

Check your inbox for a link

3

Set up profile

Add your name and avatar

4

Done

You are all set!

Create account

Enter your email and password

Verify email

Check your inbox for a link

Set up profile

Add your name and avatar

Done

You are all set!

<Stepper active={0} steps={steps} />
<Stepper active={2} steps={steps} />
<Stepper active={4} steps={steps} />

Vertical

Create account

Enter your email and password

2

Verify email

Check your inbox for a link

3

Set up profile

Add your name and avatar

4

Done

You are all set!

<Stepper active={1} steps={steps} orientation="vertical" />

With color

Create account

Enter your email and password

Verify email

Check your inbox for a link

3

Set up profile

Add your name and avatar

4

Done

You are all set!

<Stepper active={2} steps={steps} color="violet" />

Custom icons

Cart

๐Ÿ“ฆ

Shipping

๐Ÿ’ณ

Payment

โœ…

Confirm

<Stepper
  active={1}
  steps={[
    { label: 'Cart', icon: '๐Ÿ›’' },
    { label: 'Shipping', icon: '๐Ÿ“ฆ' },
    { label: 'Payment', icon: '๐Ÿ’ณ' },
  ]}
/>

Props

PropTypeDefaultDescription
activenumberโ€”0-based index of the currently active step (required)
stepsStepDef[]โ€”Ordered list of step definitions (required)
orientation'horizontal'|'vertical''horizontal'Direction of the stepper layout
size'xs'|'sm'|'md'|'lg'|'xl'โ€”Font size and icon size
radius'xs'|'sm'|'md'|'lg'|'xl'|stringโ€”Border radius of each step's icon circle
colorstringโ€”Default accent color for all step icons
iconPosition'left'|'right''left'Side where the icon circle is placed
classstringโ€”Additional CSS class names
styleobjectโ€”Inline styles