StepperModel

23 Sep 20255 minutes to read

Interface for a class Stepper

Properties

beforeStepRender EmitType<StepperRenderingEventArgs>

Event triggers before rendering each step.

created EmitType<Event>

Event callback that is raised after rendering the stepper.

stepChanged EmitType<StepperChangedEventArgs>

Event triggers after active step changed.

stepChanging EmitType<StepperChangingEventArgs>

Event triggers before active step change.

stepClick EmitType<StepperClickEventArgs>

Event triggers when clicked on step.

activeStep number

Defines the current step index of the Stepper.

    <nav id="stepper"> </nav>

import { Stepper } from '@syncfusion/ej2-navigations';
let stepperObj: Stepper = new Stepper({
    steps : [{}, {}, {}, {}, {}],
    activeStep: 2
});
stepperObj.appendTo('#stepper');

animation StepperAnimationSettingsModel

Defines the step progress animation of the Stepper.

    <nav id="stepper"> </nav>

import { Stepper } from '@syncfusion/ej2-navigations';
let stepperObj: Stepper = new Stepper({
    steps : [{}, {}, {}, {}, {}],
    animation: {enable: true, duration: 2000, delay: 1000}
});
stepperObj.appendTo('#stepper');

cssClass string

Defines the CSS class to customize the Stepper appearance.

enablePersistence boolean

Enable or disable persisting component’s state between page reloads.

enableRtl boolean

Enable or disable rendering component in right to left direction.

labelPosition string|StepLabelPosition

Defines the label position in the Stepper.
The possible values are:

• Top
• Bottom
• Start
• End

    <nav id="stepper"> </nav>

import { Stepper, StepModel } from '@syncfusion/ej2-navigations';

const iconWithLabel: StepModel[] = [
    { label: 'Cart', icon: 'sf-icon-shopping-cart' },
    { label: 'Personal Info', icon: 'sf-icon-user-info' },
    { label: 'Delivery Address', icon: 'sf-icon-transport' },
    { label: 'Payment', icon: 'sf-icon-cash' },
    { label: 'Confirmation', icon: 'sf-icon-ordered' }
];

let stepperObj: Stepper = new Stepper({
    steps : iconWithLabel,
    labelPosition: 'bottom'
});
stepperObj.appendTo('#stepper');

linear boolean

Defines whether allows to complete one step in order to move to the next or not.

    <nav id="stepper"> </nav>

import { Stepper } from '@syncfusion/ej2-navigations';
let stepperObj: Stepper = new Stepper({
    steps : [{}, {}, {}, {}, {}],
    linear: true
});
stepperObj.appendTo('#stepper');

locale string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

orientation string|StepperOrientation

Defines the orientation type of the Stepper.
The possible values are:

• Horizontal
• vertical

readOnly boolean

Defines whether the read-only mode is enabled for a Stepper control, which means that the user will not be able to interact with it.

showTooltip boolean

Defines a value that defines whether to show tooltip or not on each step.

stepType string|StepType

Defines whether steps are display with only indicator, only labels or combination of both.
The possible values are:

• Default
• Label
• Indicator

    <nav id="stepper"> </nav>

import { Stepper, StepModel } from '@syncfusion/ej2-navigations';

const iconWithLabel: StepModel[] = [
    { label: 'Cart', icon: 'sf-icon-shopping-cart' },
    { label: 'Personal Info', icon: 'sf-icon-user-info' },
    { label: 'Delivery Address', icon: 'sf-icon-transport' },
    { label: 'Payment', icon: 'sf-icon-cash' },
    { label: 'Confirmation', icon: 'sf-icon-ordered' }
];

let stepperObj: Stepper = new Stepper({
    steps : iconWithLabel,
    stepType: 'indicator'
});
stepperObj.appendTo('#stepper');

steps StepModel[]

Defines the list of steps.

template string|Function

Defines the template content for each step.

    <nav id="stepper"></nav>

import { Stepper } from '@syncfusion/ej2-navigations';
let stepperObj: Stepper = new Stepper({
    steps : [{}, {}, {}, {}, {}],
    template: '<span>${currentStep}</span>'
});
stepperObj.appendTo('#stepper');

tooltipTemplate string|Function

Defines the template content for the tooltip.