Stepper
A set of steps that are used to indicate progress through a multi-step process.
Examples
Basic
Prop | Default | Type | Description |
---|---|---|---|
items | [] | T | The array of steps that is passed to the stepper. |
defaultValue | 1 | number | The value of the step that should be active when initially rendered. |
dir | - | ltr | rtl | Sets the reading direction of the stepper. |
linear | true | boolean | Whether or not the steps must be completed in order. |
modelValue | - | number | The controlled value of the step to activate. Can be bound as v-model . |
orientation | horizontal | horizontal | vertical | The orientation the steps are laid out. Mainly so arrow navigation is done accordingly (left & right vs. up & down). |
disabled | false | boolean | When true, prevents the user from interacting with the stepper. |
The T
generic extends the Partial<NStepperItemProps>
, which means that you can use all the props from the NStepperItemProps
.
Address
Add your address here
Shipping
Set your preferred shipping method
Checkout
Confirm your order
Orientation
Prop | Default | Type | Description |
---|---|---|---|
orientation | horizontal | horizontal | vertical | Set the orientation of the stepper. |
Address
Add your address here
Shipping
Set your preferred shipping method
Checkout
Confirm your order
Variant and Color
Prop | Default | Type | Description |
---|---|---|---|
stepper | solid-primary | {variant}-{color} | Set the stepper variant and color. |
_stepperIndicator.stepper | solid-primary | {variant}-{color} | Set the stepper indicator variant and color via _stepperIndicator . |
Address
Add your address here
Shipping
Set your preferred shipping method
Checkout
Confirm your order
Address
Add your address here
Shipping
Set your preferred shipping method
Checkout
Confirm your order
Size
Adjust the stepper size without limits. Use breakpoints
(e.g., sm:sm
, xs:lg
) for responsive sizes or states
(e.g., hover:lg
, focus:3xl
) for state-based sizes.
Prop | Default | Type | Description |
---|---|---|---|
size | md | string | Adjusts the overall size of the stepper component. |
item.size | md | string | applies only if not specified size |
_stepperTrigger.size | md | string | Modifies the size of the stepper trigger element. |
_stepperTitle.size | md | string | Adjusts the size of the stepper title. |
_stepperDescription.size | md | string | Adjusts the size of the stepper description. |
Address
Shipping
Checkout
Exposed
Name | Type | Description |
---|---|---|
goToStep | (step: number) => void | Navigates to the specified step by its index. |
nextStep | () => void | Moves to the next step (if available). |
prevStep | () => void | Moves to the previous step (if available). |
hasNext | () => boolean | Checks if there is a next step available. |
hasPrev | () => boolean | Checks if there is a previous step available. |
Slots
It is important that you can also use dynamic slots to customize individual parts of Stepper
. You also have the option for item
to use the slot field in the object itself for further dynamic binding.
Name | Props | Description |
---|---|---|
default | modelValue , totalSteps , isNextDisabled , isPrevDisabled , isFirstStep , isLastStep , goToStep , nextStep , prevStep , hasNext , hasPrev , currentStep | Default slot that overrides entire stepper content |
wrapper | items | Wraps all stepper items for custom layouts |
item | item , step | Customizes each individual step |
trigger | item | Overrides clickable trigger area of each step |
indicator | item , step | Customizes step indicator |
header | item | Customizes header section of each step |
title | item | Overrides step title text |
description | item | Overrides step description text |
content | item | Dynamically renders content for active step |
#{{item.slot}} | item | Dynamic named slot when item.slot is defined |
Your details
Provide your name and email
Company details
A few details about your company
Invite your team
Start collaborating with your team
Your details
Custom Rendering
Use the default
slot for full control over the steppers's structure. This allows you to compose the stepper using its individual sub-components (like NStepperItem
, NStepperTrigger
, etc., listed in the Components section), similar to libraries like shadcn/ui
.
Address
Add your address here
Shipping
Set your preferred shipping method
Checkout
Confirm your order