Back to components
Components

Step indicator

Represents a single step within a multi-step process or timeline.

Component

1

Props

Props Default Type
typeStepIndicatorType.NUMBERStepIndicatorType
statusStepStatus.INACTIVEStepStatus
sizeStepIndicatorSize.XLStepIndicatorSize
step1number
stepIcon — string
completedIcon'mdi:check'string
isHoveredfalseboolean

Usage

type

Sets the type of the step indicators. Uses the StepIndicatorType enum.

 <template>
    <CircleStepper :type="StepIndicatorType.NUMBER" />
</template>
 
  • Type: StepIndicatorType
  • Default: StepIndicatorType.NUMBER

Options

Value Description
NUMBER

Uses numbered steps

EMPTY

Shows an empty space in the step indicator

ICON

Displays a custom icon in the step indicator (except if the step is completed).

status

Sets the status of the step indicators. Uses the StepStatus enum.

 <template>
    <CircleStepper :status="StepStatus.CURRENT" />
</template>
 

Options

Value Description
none

The step does not use state and renders a default style

inactive

The step is inactive

current

The step is the current step

completed

The step is completed

size

Sets the size of the step indicators. Uses the StepIndicatorSize enum.

 <template>
    <CircleStepper :size="StepIndicatorSize.XL" />
</template>
 

Options

Value Description
XL

Large size

LG

Large size

MD

Medium size

SM

Small size

XS

Extra small size

step

Sets the current step.

 <template>
    <CircleStepper :step="3" />
</template>
 
  • Type: number
  • Default: 1

stepIcon

Sets the icon to be displayed when the step is not completed.

 <template>
    <CircleStepper stepIcon="mdi:home-outline" />
</template>
 
  • Type: string
  • Default: mdi:home-outline

completedIcon

Sets the icon to be displayed when the step is completed.

 <template>
    <CircleStepper completedIcon="mdi:check" />
</template>
 
  • Type: string
  • Default: mdi:check

isHovered

Sets if the step indicator is interactive.

 <template>
    <CircleStepper isHovered />
</template>
 
  • Type: boolean
  • Default: false