StepperComponent

1 Oct 20256 minutes to read

StepperComponent represents the react Stepper Component.

<StepperComponent steps={stepItems} />

Properties

activeStep number

Defines the current step index of the Stepper.

import { render } from "react-dom";
import "./index.css";
import * as React from "react";
import { StepperComponent, StepModel } from '@syncfusion/ej2-react-navigations';
import { SampleBase } from "./sample-base";

export class Default extends SampleBase<{}, {}> {
    render() {
        return (
            <div>
                <StepperComponent id="stepper" steps={[{}, {}, {}, {}, {}]} activeStep={2}></StepperComponent>
            </div>
        );
    }
}

render(<Default />, document.getElementById("sample"));

Defaults to 0

animation StepperAnimationSettingsModel

Defines the step progress animation of the Stepper.

import { render } from "react-dom";
import "./index.css";
import * as React from "react";
import { StepperComponent, StepModel } from '@syncfusion/ej2-react-navigations';
import { SampleBase } from "./sample-base";

export class Default extends SampleBase<{}, {}> {
    render() {
        return (
            <div>
                <StepperComponent id="stepper" steps={[{}, {}, {}, {}, {}]} animation={{enable: true, duration: 2000, delay: 1000}}></StepperComponent>
            </div>
        );
    }
}

render(<Default />, document.getElementById("sample"));

cssClass string

Defines the CSS class to customize the Stepper appearance.

Defaults to ’’

enablePersistence boolean

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

Defaults to false

enableRtl boolean

Enable or disable rendering component in right to left direction.

Defaults to false

labelPosition string|StepLabelPosition

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

• Top
• Bottom
• Start
• End

import { render } from "react-dom";
import "./index.css";
import * as React from "react";
import { StepperComponent, StepModel } from '@syncfusion/ej2-react-navigations';
import { SampleBase } from "./sample-base";

export class Default extends SampleBase<{}, {}> {
    public steps: StepModel[] = [
        { icon: 'sf-icon-shopping-02', label: 'Ordered' },
        { icon: 'sf-icon-van-02-wf', label: 'Dispatched' },
        { icon: 'sf-icon-supplier1', label: 'Out for delivery' },
        { icon: 'sf-icon-supplier2', label: 'Arrived' }
    ];
    render() {
        return (
            <div>
                <StepperComponent id="stepper" steps={this.steps} labelPosition="bottom"></StepperComponent>
            </div>
        );
    }
}

render(<Default />, document.getElementById("sample"));

Defaults to StepLabelPosition.Bottom

linear boolean

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

import { render } from "react-dom";
import "./index.css";
import * as React from "react";
import { StepperComponent, StepModel } from '@syncfusion/ej2-react-navigations';
import { SampleBase } from "./sample-base";

export class Default extends SampleBase<{}, {}> {
    render() {
        return (
            <div>
                <StepperComponent id="stepper" steps={[{}, {}, {}, {}, {}]} linear={true}></StepperComponent>
            </div>
        );
    }
}

render(<Default />, document.getElementById("sample"));

Defaults to false

locale string

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

Defaults to ’’

orientation string|StepperOrientation

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

• Horizontal
• vertical

Defaults to StepperOrientation.Horizontal

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.

Defaults to false

showTooltip boolean

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

Defaults to false

stepType string|StepType

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

• Default
• Label
• Indicator

import { render } from "react-dom";
import "./index.css";
import * as React from "react";
import { StepperComponent, StepModel } from '@syncfusion/ej2-react-navigations';
import { SampleBase } from "./sample-base";

export class Default extends SampleBase<{}, {}> {
    public steps: StepModel[] = [
        { icon: 'sf-icon-shopping-02', label: 'Ordered' },
        { icon: 'sf-icon-van-02-wf', label: 'Dispatched' },
        { icon: 'sf-icon-supplier1', label: 'Out for delivery' },
        { icon: 'sf-icon-supplier2', label: 'Arrived' }
    ];
    render() {
        return (
            <div>
                <StepperComponent id="stepper" steps={this.steps} stepType="indicator"></StepperComponent>
            </div>
        );
    }
}

render(<Default />, document.getElementById("sample"));

Defaults to StepType.Default

steps StepModel[]

Defines the list of steps.

Defaults to []

template string|function|JSX.Element

Defines the template content for each step.

import { render } from "react-dom";
import "./index.css";
import * as React from "react";
import { StepperComponent, StepModel } from '@syncfusion/ej2-react-navigations';
import { SampleBase } from "./sample-base";

export class Default extends SampleBase<{}, {}> {
    render() {
        return (
            <div>
                <StepperComponent id="stepper" steps={[{}, {}, {}, {}, {}]} template='<span>${currentStep}</span>'></StepperComponent>
            </div>
        );
    }
}

render(<Default />, document.getElementById("sample"));

Defaults to ’’

tooltipTemplate string|function|JSX.Element

Defines the template content for the tooltip.

Defaults to ’’

Methods

destroy

Destroy the stepper control.

Returns void

nextStep

Move to next step from current step in Stepper.

Returns void

previousStep

Move to previous step from current step in Stepper.

Returns void

refreshProgressbar

Refreshes the position of the progress bar programmatically when the dimensions of the parent container are changed.

Returns void

reset

Reset the state of the Stepper and move to the first step.

Returns void

Events

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.