DevExtreme v25.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

Angular Stepper - Overview

The DevExtreme Stepper allows you to indicate progress within a multi-step process and allows users to navigate between individual steps. Use our Stepper UI component to implement multi-page navigation in lengthy forms such as store/cart checkout.

To get started with DevExtreme Stepper, refer to the following step-by-step tutorial: Getting Started with Stepper.

Backend API
<div class="stepper-demo"> <div class="widget-container"> <div class="widget-wrapper" [ngClass]="'widget-wrapper-' + orientation"> <div class="stepper-wrapper"> <div id="iconsLabel" class="stepper-label">Icons and Labels</div> <dx-stepper id="icons" [elementAttr]="{ 'aria-labelledby': 'iconsLabel' }" [selectedIndex]="2" [orientation]="orientation" [linear]="navigationMode" [selectOnFocus]="selectOnFocus" [rtlEnabled]="rtlMode" > <dxi-stepper-item *ngFor="let step of steps" [label]="step.label" [icon]="step.icon" [optional]="step.optional" ></dxi-stepper-item> </dx-stepper> </div> <div class="stepper-wrapper"> <div id="numbersLabel" class="stepper-label">Numbers and Labels</div> <dx-stepper id="numbers" [elementAttr]="{ 'aria-labelledby': 'numbersLabel' }" [selectedIndex]="2" [orientation]="orientation" [linear]="navigationMode" [selectOnFocus]="selectOnFocus" [rtlEnabled]="rtlMode" > <dxi-stepper-item *ngFor="let step of steps" [label]="step.label" [optional]="step.optional" ></dxi-stepper-item> </dx-stepper> </div> <div class="stepper-wrapper"> <div id="customTextLabel" class="stepper-label">Custom Text</div> <dx-stepper id="customText" [elementAttr]="{ 'aria-labelledby': 'customTextLabel' }" [selectedIndex]="2" [orientation]="orientation" [linear]="navigationMode" [selectOnFocus]="selectOnFocus" [rtlEnabled]="rtlMode" > <dxi-stepper-item *ngFor="let step of steps" [text]="step.text" ></dxi-stepper-item> </dx-stepper> </div> </div> </div> <div class="options"> <div class="caption">Options</div> <div class="option"> <div>Orientation</div> <dx-button-group id="orientation" keyExpr="value" [items]="orientations" [selectedItemKeys]="[orientation]" (onItemClick)="onOrientationClick($event)" /> </div> <div class="option"> <div>Navigation Mode</div> <dx-button-group id="navigationMode" keyExpr="value" [items]="navigationModes" [selectedItemKeys]="[navigationMode]" (onItemClick)="onNavigationModeClick($event)" /> </div> <div class="option-separator"></div> <div class="option"> <dx-check-box id="selectOnFocus" text="Select step on focus" [value]="selectOnFocus" (onValueChanged)="onSelectOnFocusChanged($event)" /> </div> <div class="option"> <dx-check-box id="rtlMode" text="Right-to-left mode" [value]="rtlMode" (onValueChanged)="onRtlModeChanged($event)" /> </div> </div> </div>
import { NgModule, Component, enableProdMode } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; import { DxButtonGroupModule, type DxButtonGroupTypes } from 'devextreme-angular/ui/button-group'; import { DxCheckBoxModule, type DxCheckBoxTypes } from 'devextreme-angular/ui/check-box'; import { DxStepperModule, type DxStepperTypes } from 'devextreme-angular/ui/stepper'; import { AppService } from './app.service'; if (!/localhost/.test(document.location.host)) { enableProdMode(); } let modulePrefix = ''; // @ts-ignore if (window && window.config?.packageConfigPaths) { modulePrefix = '/app'; } @Component({ selector: 'demo-app', templateUrl: `app/app.component.html`, styleUrls: [`app/app.component.css`], }) export class AppComponent { steps: DxStepperTypes.Item[]; orientations: any[]; navigationModes: any[]; orientation: string; navigationMode: boolean; selectOnFocus: boolean = true; rtlMode: boolean = false; constructor(private readonly appService: AppService) { this.steps = this.appService.getSteps(); this.orientations = this.appService.getOrientations(); this.navigationModes = this.appService.getNavigationModes(); this.orientation = this.orientations[0].value; this.navigationMode = this.navigationModes[0].value; } onOrientationClick(e: DxButtonGroupTypes.ItemClickEvent) { this.orientation = e.itemData.value; } onNavigationModeClick(e: DxButtonGroupTypes.ItemClickEvent) { this.navigationMode = e.itemData.value; } onSelectOnFocusChanged(e: DxCheckBoxTypes.ValueChangedEvent) { this.selectOnFocus = e.value; } onRtlModeChanged(e: DxCheckBoxTypes.ValueChangedEvent) { this.rtlMode = e.value; } } @NgModule({ imports: [ BrowserModule, DxStepperModule, DxButtonGroupModule, DxCheckBoxModule, ], declarations: [AppComponent], bootstrap: [AppComponent], providers: [AppService], }) export class AppModule { } platformBrowserDynamic().bootstrapModule(AppModule);
::ng-deep demo-app { display: flex; flex-direction: column; } ::ng-deep .stepper-demo { display: flex; height: 580px; gap: 20px; } ::ng-deep .widget-container { display: flex; align-items: center; justify-content: center; width: calc(100% - 280px); min-width: 320px; overflow: clip; gap: 20px; } ::ng-deep .widget-wrapper { display: inline-flex; flex-direction: column; align-items: center; justify-content: center; row-gap: 80px; width: 100%; height: 100%; } ::ng-deep .widget-wrapper-vertical { display: flex; flex-direction: row; justify-content: space-around; } ::ng-deep .widget-wrapper-vertical .stepper-wrapper { width: auto; max-width: 33%; } ::ng-deep .widget-wrapper-vertical .stepper-label { text-align: center; white-space: nowrap; } ::ng-deep .widget-wrapper-vertical #customText { width: auto; } ::ng-deep .dx-stepper-vertical { height: 400px; width: 100%; } ::ng-deep .stepper-wrapper { width: 100%; display: flex; flex-direction: column; align-items: center; gap: 16px; } ::ng-deep .stepper-label { font-weight: 600; } ::ng-deep .options { display: flex; flex-direction: column; flex-shrink: 0; width: 300px; box-sizing: border-box; padding: 20px; background-color: rgba(191, 191, 191, 0.15); gap: 16px; height: 100%; } ::ng-deep .caption { font-weight: 500; font-size: 18px; } ::ng-deep .option { display: flex; flex-direction: column; row-gap: 4px; } ::ng-deep .option-separator { border-bottom: 1px solid var(--dx-color-border); } ::ng-deep .dx-buttongroup .dx-button { width: 50%; }
import { Injectable } from "@angular/core"; import { type DxStepperTypes } from 'devextreme-angular/ui/stepper'; @Injectable({ providedIn: "root" }) export class AppService { steps: DxStepperTypes.Item[] = []; orientations = []; navigationModes = []; constructor() { this.steps = [ { text: "A", label: "Cart", icon: "cart" }, { text: "B", label: "Shipping Info", icon: "clipboardtasklist" }, { text: "C", label: "Promo Code", icon: "gift", optional: true }, { text: "D", label: "Checkout", icon: "packagebox" }, { text: "E", label: "Ordered", icon: "checkmarkcircle" } ]; this.orientations = [ { text: "Horizontal", value: "horizontal" }, { text: "Vertical", value: "vertical" } ]; this.navigationModes = [ { text: 'Non-linear', value: false }, { text: 'Linear', value: true }, ] } getSteps(): DxStepperTypes.Item[] { return this.steps; } getOrientations() { return this.orientations; } getNavigationModes() { return this.navigationModes; } }
// In real applications, you should not transpile code in the browser. // You can see how to create your own application with Angular and DevExtreme here: // https://js.devexpress.com/Documentation/Guide/Angular_Components/Getting_Started/Create_a_DevExtreme_Application/ const componentNames = [ 'accordion', 'action-sheet', 'autocomplete', 'bar-gauge', 'box', 'bullet', 'button-group', 'button', 'calendar', 'card-view', 'chart', 'chat', 'check-box', 'circular-gauge', 'color-box', 'context-menu', 'data-grid', 'date-box', 'date-range-box', 'defer-rendering', 'diagram', 'draggable', 'drawer', 'drop-down-box', 'drop-down-button', 'file-manager', 'file-uploader', 'filter-builder', 'form', 'funnel', 'gallery', 'gantt', 'html-editor', 'linear-gauge', 'list', 'load-indicator', 'load-panel', 'lookup', 'map', 'menu', 'multi-view', 'nested', 'number-box', 'pagination', 'pie-chart', 'pivot-grid-field-chooser', 'pivot-grid', 'polar-chart', 'popover', 'popup', 'progress-bar', 'radio-group', 'range-selector', 'range-slider', 'recurrence-editor', 'resizable', 'responsive-box', 'sankey', 'scheduler', 'scroll-view', 'select-box', 'slider', 'sortable', 'sparkline', 'speed-dial-action', 'splitter', 'stepper', 'switch', 'tab-panel', 'tabs', 'tag-box', 'text-area', 'text-box', 'tile-view', 'toast', 'toolbar', 'tooltip', 'tree-list', 'tree-map', 'tree-view', 'validation-group', 'validation-summary', 'validator', 'vector-map', ]; window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, }, meta: { 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, '@angular/platform-browser-dynamic': { 'esModule': true, }, '@angular/platform-browser': { 'esModule': true, }, '@angular/core': { 'esModule': true, }, '@angular/common': { 'esModule': true, }, '@angular/common/http': { 'esModule': true, }, '@angular/animations': { 'esModule': true, }, '@angular/forms': { 'esModule': true, }, 'openai': { 'esModule': true, }, }, paths: { 'npm:': 'https://cdn.jsdelivr.net/npm/', 'bundles:': '../../../../bundles/', 'externals:': '../../../../bundles/externals/', }, map: { 'ts': 'npm:plugin-typescript@8.0.0/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', /* @angular */ '@angular/compiler': 'bundles:@angular/compiler.umd.js', '@angular/platform-browser-dynamic': 'bundles:@angular/platform-browser-dynamic.umd.js', '@angular/core': 'bundles:@angular/core.umd.js', '@angular/core/primitives/signals': 'bundles:@angular/core.primitives.signals.umd.js', '@angular/common': 'bundles:@angular/common.umd.js', '@angular/common/http': 'bundles:@angular/common-http.umd.js', '@angular/platform-browser': 'bundles:@angular/platform-browser.umd.js', '@angular/platform-browser/animations': 'bundles:@angular/platform-browser.umd.js', '@angular/forms': 'bundles:@angular/forms.umd.js', /* devextreme */ 'devextreme': 'npm:devextreme@25.1.3/cjs', 'devextreme-quill': 'npm:devextreme-quill@1.7.3/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.19', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.62', /* devextreme-angular umd maps */ 'devextreme-angular': 'bundles:devextreme-angular/devextreme-angular.umd.js', 'devextreme-angular/common/ai-integration': 'bundles:devextreme-angular/devextreme-angular-common-ai-integration.umd.js', 'devextreme-angular/core': 'bundles:devextreme-angular/devextreme-angular-core.umd.js', 'devextreme-angular/common/charts': 'bundles:devextreme-angular/devextreme-angular-common-charts.umd.js', 'devextreme-angular/common/core/animation': 'bundles:devextreme-angular/devextreme-angular-common-core-animation.umd.js', 'devextreme-angular/common/core/environment': 'bundles:devextreme-angular/devextreme-angular-common-core-environment.umd.js', 'devextreme-angular/common/core/events': 'bundles:devextreme-angular/devextreme-angular-common-core-events.umd.js', 'devextreme-angular/common/core/localization': 'bundles:devextreme-angular/devextreme-angular-common-core-localization.umd.js', 'devextreme-angular/common/core': 'bundles:devextreme-angular/devextreme-angular-common-core.umd.js', 'devextreme-angular/common/data/custom-store': 'bundles:devextreme-angular/devextreme-angular-common-data-custom-store.umd.js', 'devextreme-angular/common/data': 'bundles:devextreme-angular/devextreme-angular-common-data.umd.js', 'devextreme-angular/common/export/excel': 'bundles:devextreme-angular/devextreme-angular-common-export-excel.umd.js', 'devextreme-angular/common/export/pdf': 'bundles:devextreme-angular/devextreme-angular-common-export-pdf.umd.js', 'devextreme-angular/common/export': 'bundles:devextreme-angular/devextreme-angular-common-export.umd.js', 'devextreme-angular/common/grids': 'bundles:devextreme-angular/devextreme-angular-common-grids.umd.js', 'devextreme-angular/common': 'bundles:devextreme-angular/devextreme-angular-common.umd.js', 'devextreme-angular/http': 'bundles:devextreme-angular/devextreme-angular-http.umd.js', ...componentNames.reduce((acc, name) => { acc[`devextreme-angular/ui/${name}`] = `bundles:devextreme-angular/devextreme-angular-ui-${name}.umd.js`; acc[`devextreme-angular/ui/${name}/nested`] = `bundles:devextreme-angular/devextreme-angular-ui-${name}-nested.umd.js`; return acc; }, {}), 'tslib': 'npm:tslib/tslib.js', 'rxjs': 'npm:rxjs@7.5.3/dist/bundles/rxjs.umd.js', 'rxjs/operators': 'npm:rxjs@7.5.3/dist/cjs/operators/index.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@3.4.4/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign', 'inferno': 'npm:inferno@8.2.3/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@8.2.3/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', '@preact/signals-core': 'npm:@preact/signals-core@1.8.0/dist/signals-core.min.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.8/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js', }, packages: { 'app': { main: './app.component.ts', defaultExtension: 'ts', }, 'devextreme': { defaultExtension: 'js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/common/core/events/utils': { main: 'index', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, 'rxjs': { defaultExtension: 'js', }, 'rxjs/operators': { defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:rxjs@7.5.3/package.json', 'npm:rxjs@7.5.3/operators/package.json', 'npm:devexpress-diagram@2.2.19/package.json', 'npm:devexpress-gantt@4.1.62/package.json', ], }; System.config(window.config); // System.import('@angular/compiler').catch(console.error.bind(console));
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/25.1.3/css/dx.light.css" /> <script src="https://cdn.jsdelivr.net/npm/core-js@2.6.12/client/shim.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/zone.js@0.14.10/bundles/zone.umd.js"></script> <script src="https://cdn.jsdelivr.net/npm/reflect-metadata@0.1.13/Reflect.js"></script> <script src="https://cdn.jsdelivr.net/npm/systemjs@0.21.3/dist/system.js"></script> <script src="config.js"></script> <script> System.import("app").catch(console.error.bind(console)); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <demo-app>Loading...</demo-app> </div> </body> </html>

Component Configuration

The following settings are available to you:

  • orientation (default: horizontal)
    Stepper orientation (horizontal or vertical).

  • linear (default: true)
    Specifies whether users must navigate the Stepper sequentially or can skip steps.

  • selectOnFocus (default: true)
    Specifies whether steps focused with keyboard navigation are selected automatically.

  • rtlEnabled (default: false)
    Switches the Stepper to Right-to-Left mode.

Step Settings

To add steps, populate the items collection or specify a dataSource.

Use the following properties to customize steps:

  • text
    Indicator text. If you do not define this option, Stepper numbers steps sequentially.

  • icon
    Indicator icon. Stepper prioritizes icons over the text property.

  • label
    Step caption displayed next to the indicator.

  • optional
    Adds an (Optional) label to the step.

  • isValid
    Allows you to indicate step-related validation errors.

  • disabled
    Deactivates the step.

  • hint
    Tooltip text for the step.

  • template
    Allows you to customize step-related appearance. This property overrides all other step settings.