Skip to Content
šŸŽ‰Introducing Pumki UI
ComponentsStepper

Stepper

A multi-step form component with a progress indicator.

Pumki UIPumki UI
2
3
4

Welcome to the Pumki's React Bits inspired stepper!

Check out the next step!

Installation

Usage


import Stepper, { Step } from '@/components/pumki-ui/stepper.tsx';

<Stepper />

Props

PropTypeDefaultDescription
childrenReact.ReactNoderequiredStep content. Each child is a step.
initialStepnumber1Initial step index (1-based).
onStepChange(step: number) => void() => Callback when the step changes.
onFinalStepCompleted() => void() => Callback when the last step is completed.
stepCircleContainerClassNamestring""Custom class for the step indicator container.
stepContainerClassNamestring""Custom class for the step indicator row.
contentClassNamestring""Custom class for the step content area.
footerClassNamestring""Custom class for the footer area.
backButtonPropsReact.ButtonHTMLAttributes<HTMLButtonElement>Props for the back button.
nextButtonPropsReact.ButtonHTMLAttributes<HTMLButtonElement>Props for the next/complete button.
backButtonTextstringā€Backā€Text for the back button.
nextButtonTextstringā€Continueā€Text for the next button.
disableStepIndicatorsbooleanfalseIf true, disables clicking step indicators.
renderStepIndicator(props: { step: number; currentStep: number; onStepClick: (clicked: number) =&gt; void; }) => React.ReactNodeundefinedCustom render function for step indicators.
Last updated on