New to Kendo UI for Vue? Start a free 30-day trial

Stepper

Component

Represents the Kendo UI for Vue Stepper component. Accepts properties of type StepperProps.

Definition

Package:@progress/kendo-vue-layout

Properties Interface:StepperProps

Syntax:

vue
<Stepper
    :value="value"
    :items="[
        { label: 'Cart', icon: 'cart' },
        { label: 'Delivery Address', icon: 'marker-pin-target' },
        { label: 'Payment Method', icon: 'dollar' },
        { label: 'Preview', icon: 'preview', optional: true },
        { label: 'Finish Order', icon: 'track-changes-accept' }
    ]"
    :orientation="'horizontal'"
    :mode="'steps'"
    :linear="false"
    @change="onChange"
/>

Properties

animationDuration?

number | boolean

Sets the duration of the Stepper animation in milliseconds. Set it to false to turn off the animation.

Default:

400

Sets a list of CSS classes that the Stepper adds to its root element.

dir?

string

Sets the dir HTML attribute of the Stepper. Use it to switch between LTR and RTL.

disabled?

boolean

Disables the whole Stepper.

Sets a custom icon that the Stepper shows inside each invalid step.

Overrides the default component that renders a single step (see example).

The default component is: Step.

Sets the collection of steps that the Stepper renders (see example).

linear?

boolean

Turns on the linear flow of the Stepper. In linear mode, you can move only to the previous or the next step (see example).

mode?

string

Sets the display mode of the Stepper (see example).

The available options are:

  • steps—Renders the step indicator and an optional label.
  • labels—Renders only the labels.
Default:

steps

Fires when the user selects a different step and the value changes.

Parameters:eventStepperChangeEvent

onFocus?

(event: StepperFocusEvent) => void

Fires when a step receives the focus.

Parameters:eventStepperFocusEvent

Sets the orientation of the Stepper (see example).

The available options are:

  • horizontal
  • vertical
Default:

horizontal

progress?

number

Sets the current progress of the ProgressBar inside the Stepper. If you do not set it, the Stepper uses the current value.

Sets the maximum value of the ProgressBar inside the Stepper. If you do not set it, the Stepper uses the number of steps.

Sets a custom icon that the Stepper shows inside each valid step.

value

number

Sets the index of the selected step.

Default:

0

References

Represents the Stepper ref.