Backend API
import React, { useState } from 'react';
import { type ButtonGroupTypes } from 'devextreme-react/button-group';
import { type CheckBoxTypes } from 'devextreme-react/check-box';
import { type Orientation } from 'devextreme-react/common';
import { navigationModes, orientations } from './data.ts';
import Steppers from './Steppers.tsx';
import Options from './Options.tsx';
export default function App() {
const [orientation, setOrientation] = useState<Orientation>(orientations[0].value);
const [navigationMode, setNavigationMode] = useState<boolean>(navigationModes[0].value);
const [selectOnFocus, setSelectOnFocus] = useState<boolean>(true);
const [rtlMode, setRtlMode] = useState<boolean>(false);
const onOrientationClick = (e: ButtonGroupTypes.ItemClickEvent) => {
setOrientation(e.itemData.value);
};
const onNavigationModeClick = (e: ButtonGroupTypes.ItemClickEvent) => {
setNavigationMode(e.itemData.value);
};
const onSelectOnFocusChanged = (e: CheckBoxTypes.ValueChangedEvent) => {
setSelectOnFocus(e.value)
};
const onRtlModeChanged = (e: CheckBoxTypes.ValueChangedEvent) => {
setRtlMode(e.value)
};
const widgetWrapperOrientationClass: string = 'widget-wrapper-' + orientation;
return (
<div className="stepper-demo">
<div className="widget-container">
<div className={"widget-wrapper " + widgetWrapperOrientationClass}>
<Steppers
orientation={orientation}
navigationMode={navigationMode}
selectOnFocus={selectOnFocus}
rtlMode={rtlMode}
/>
</div>
</div>
<div className="options">
<Options
orientation={orientation}
navigationMode={navigationMode}
selectOnFocus={selectOnFocus}
rtlMode={rtlMode}
onOrientationClick={onOrientationClick}
onNavigationModeClick={onNavigationModeClick}
onSelectOnFocusChanged={onSelectOnFocusChanged}
onRtlModeChanged={onRtlModeChanged}
/>
</div>
</div>
);
}
import React, { useState } from 'react';
import { navigationModes, orientations } from './data.js';
import Steppers from './Steppers.js';
import Options from './Options.js';
export default function App() {
const [orientation, setOrientation] = useState(orientations[0].value);
const [navigationMode, setNavigationMode] = useState(navigationModes[0].value);
const [selectOnFocus, setSelectOnFocus] = useState(true);
const [rtlMode, setRtlMode] = useState(false);
const onOrientationClick = (e) => {
setOrientation(e.itemData.value);
};
const onNavigationModeClick = (e) => {
setNavigationMode(e.itemData.value);
};
const onSelectOnFocusChanged = (e) => {
setSelectOnFocus(e.value);
};
const onRtlModeChanged = (e) => {
setRtlMode(e.value);
};
const widgetWrapperOrientationClass = `widget-wrapper-${orientation}`;
return (
<div className="stepper-demo">
<div className="widget-container">
<div className={`widget-wrapper ${widgetWrapperOrientationClass}`}>
<Steppers
orientation={orientation}
navigationMode={navigationMode}
selectOnFocus={selectOnFocus}
rtlMode={rtlMode}
/>
</div>
</div>
<div className="options">
<Options
orientation={orientation}
navigationMode={navigationMode}
selectOnFocus={selectOnFocus}
rtlMode={rtlMode}
onOrientationClick={onOrientationClick}
onNavigationModeClick={onNavigationModeClick}
onSelectOnFocusChanged={onSelectOnFocusChanged}
onRtlModeChanged={onRtlModeChanged}
/>
</div>
</div>
);
}
import React from 'react';
import { ButtonGroup, type ButtonGroupTypes } from 'devextreme-react/button-group';
import { CheckBox, type CheckBoxTypes } from 'devextreme-react/check-box';
import { type Orientation } from 'devextreme-react/common';
import { navigationModes, orientations } from './data.ts';
interface OptionsProps {
orientation: Orientation,
navigationMode: boolean,
selectOnFocus: boolean,
rtlMode: boolean,
onOrientationClick(e: ButtonGroupTypes.ItemClickEvent): void;
onNavigationModeClick(e: ButtonGroupTypes.ItemClickEvent): void;
onSelectOnFocusChanged(e: CheckBoxTypes.ValueChangedEvent): void;
onRtlModeChanged(e: CheckBoxTypes.ValueChangedEvent): void;
}
export default function Options({
orientation,
navigationMode,
selectOnFocus,
rtlMode,
onOrientationClick,
onNavigationModeClick,
onSelectOnFocusChanged,
onRtlModeChanged,
}: OptionsProps) {
return (
<>
<div className="caption">Options</div>
<div className="option">
<div>Orientation</div>
<ButtonGroup
id="orientation"
keyExpr="value"
items={orientations}
selectedItemKeys={[orientation]}
onItemClick={onOrientationClick}
/>
</div>
<div className="option">
<div>Navigation Mode</div>
<ButtonGroup
id="navigationMode"
keyExpr="value"
items={navigationModes}
selectedItemKeys={[navigationMode]}
onItemClick={onNavigationModeClick}
/>
</div>
<div className="option-separator"></div>
<div className="option">
<CheckBox
id="selectOnFocus"
text="Select step on focus"
value={selectOnFocus}
onValueChanged={onSelectOnFocusChanged}
/>
</div>
<div className="option">
<CheckBox
id="rtlMode"
text="Right-to-left mode"
value={rtlMode}
onValueChanged={onRtlModeChanged}
/>
</div>
</>
);
}
import React from 'react';
import { Stepper, Item } from 'devextreme-react/stepper';
import { type Orientation } from 'devextreme-react/common';
import { steps } from './data.ts';
interface SteppersProps {
orientation: Orientation;
navigationMode: boolean;
selectOnFocus: boolean;
rtlMode: boolean;
}
const stepperConfigs = [
{
id: 'icons',
labelId: 'iconsLabel',
title: 'Icons and Labels',
fields: ['label', 'icon', 'optional'] as const,
},
{
id: 'numbers',
labelId: 'numbersLabel',
title: 'Numbers and Labels',
fields: ['label', 'optional'] as const,
},
{
id: 'customText',
labelId: 'customTextLabel',
title: 'Custom Text',
fields: ['text'] as const,
},
];
export default function Steppers({
orientation,
navigationMode,
selectOnFocus,
rtlMode,
}: SteppersProps): JSX.Element {
return (
<>
{stepperConfigs.map(({ id, labelId, title, fields }) => (
<div key={id} className="stepper-wrapper">
<div id={labelId} className="stepper-label">{title}</div>
<Stepper
id={id}
elementAttr={{ 'aria-labelledby': labelId }}
defaultSelectedIndex={2}
orientation={orientation}
linear={navigationMode}
selectOnFocus={selectOnFocus}
rtlEnabled={rtlMode}
>
{steps.map((step, index) => {
const itemProps = fields.reduce((acc, field) => {
acc[field] = step[field];
return acc;
}, {} as Record<string, unknown>);
return <Item key={index} {...itemProps} />;
})}
</Stepper>
</div>
))}
</>
);
}
import React from 'react';
import ReactDOM from 'react-dom';
import themes from 'devextreme/ui/themes';
import App from './App.tsx';
themes.initialized(() => {
ReactDOM.render(
<App />,
document.getElementById('app'),
);
});
import { type Orientation } from 'devextreme-react/common';
export const 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',
},
];
export const orientations: Array<{ text: string; value: Orientation }> = [
{ text: 'Horizontal', value: 'horizontal' },
{ text: 'Vertical', value: 'vertical' },
];
export const navigationModes = [
{ text: 'Non-linear', value: false },
{ text: 'Linear', value: true },
];
window.exports = window.exports || {};
window.config = {
transpiler: 'ts',
typescriptOptions: {
module: 'system',
emitDecoratorMetadata: true,
experimentalDecorators: true,
jsx: 'react',
},
meta: {
'react': {
'esModule': true,
},
'typescript': {
'exports': 'ts',
},
'devextreme/time_zone_utils.js': {
'esModule': true,
},
'devextreme/localization.js': {
'esModule': true,
},
'devextreme/viz/palette.js': {
'esModule': true,
},
'openai': {
'esModule': true,
},
},
paths: {
'npm:': 'https://cdn.jsdelivr.net/npm/',
'bundles:': '../../../../bundles/',
'externals:': '../../../../bundles/externals/',
},
defaultExtension: 'js',
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',
'react': 'npm:react@17.0.2/umd/react.development.js',
'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js',
'prop-types': 'npm:prop-types/prop-types.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',
'devextreme': 'npm:devextreme@link:../../packages/devextreme/artifacts/npm/devextreme/cjs',
'devextreme-react': 'npm:devextreme-react@link:../../packages/devextreme-react/npm/cjs',
'devextreme-quill': 'npm:devextreme-quill@1.7.6/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.2.24/dist/dx-diagram.js',
'devexpress-gantt': 'npm:devexpress-gantt@4.1.64/dist/dx-gantt.js',
'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',
'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3',
// SystemJS plugins
'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js',
'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js',
// Prettier
'prettier/standalone': 'npm:prettier@2.8.8/standalone.js',
'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js',
},
packages: {
'devextreme': {
defaultExtension: 'js',
},
'devextreme-react': {
main: 'index.js',
},
'devextreme-react/common': {
main: 'index.js',
},
'devextreme/events/utils': {
main: 'index',
},
'devextreme/common/core/events/utils': {
main: 'index',
},
'devextreme/localization/messages': {
format: 'json',
defaultExtension: 'json',
},
'devextreme/events': {
main: 'index',
},
'es6-object-assign': {
main: './index.js',
defaultExtension: 'js',
},
},
packageConfigPaths: [
'npm:@devextreme/*/package.json',
],
babelOptions: {
sourceMaps: false,
stage0: true,
react: true,
},
};
System.config(window.config);
// eslint-disable-next-line
const useTgzInCSB = ['openai'];
import React from 'react';
import { ButtonGroup } from 'devextreme-react/button-group';
import { CheckBox } from 'devextreme-react/check-box';
import { navigationModes, orientations } from './data.js';
export default function Options({
orientation,
navigationMode,
selectOnFocus,
rtlMode,
onOrientationClick,
onNavigationModeClick,
onSelectOnFocusChanged,
onRtlModeChanged,
}) {
return (
<React.Fragment>
<div className="caption">Options</div>
<div className="option">
<div>Orientation</div>
<ButtonGroup
id="orientation"
keyExpr="value"
items={orientations}
selectedItemKeys={[orientation]}
onItemClick={onOrientationClick}
/>
</div>
<div className="option">
<div>Navigation Mode</div>
<ButtonGroup
id="navigationMode"
keyExpr="value"
items={navigationModes}
selectedItemKeys={[navigationMode]}
onItemClick={onNavigationModeClick}
/>
</div>
<div className="option-separator"></div>
<div className="option">
<CheckBox
id="selectOnFocus"
text="Select step on focus"
value={selectOnFocus}
onValueChanged={onSelectOnFocusChanged}
/>
</div>
<div className="option">
<CheckBox
id="rtlMode"
text="Right-to-left mode"
value={rtlMode}
onValueChanged={onRtlModeChanged}
/>
</div>
</React.Fragment>
);
}
import React from 'react';
import { Stepper, Item } from 'devextreme-react/stepper';
import { steps } from './data.js';
const stepperConfigs = [
{
id: 'icons',
labelId: 'iconsLabel',
title: 'Icons and Labels',
fields: ['label', 'icon', 'optional'],
},
{
id: 'numbers',
labelId: 'numbersLabel',
title: 'Numbers and Labels',
fields: ['label', 'optional'],
},
{
id: 'customText',
labelId: 'customTextLabel',
title: 'Custom Text',
fields: ['text'],
},
];
export default function Steppers({
orientation, navigationMode, selectOnFocus, rtlMode,
}) {
return (
<React.Fragment>
{stepperConfigs.map(({
id, labelId, title, fields,
}) => (
<div
key={id}
className="stepper-wrapper"
>
<div
id={labelId}
className="stepper-label"
>
{title}
</div>
<Stepper
id={id}
elementAttr={{ 'aria-labelledby': labelId }}
defaultSelectedIndex={2}
orientation={orientation}
linear={navigationMode}
selectOnFocus={selectOnFocus}
rtlEnabled={rtlMode}
>
{steps.map((step, index) => {
const itemProps = fields.reduce((acc, field) => {
acc[field] = step[field];
return acc;
}, {});
return (
<Item
key={index}
{...itemProps}
/>
);
})}
</Stepper>
</div>
))}
</React.Fragment>
);
}
import React from 'react';
import ReactDOM from 'react-dom';
import themes from 'devextreme/ui/themes';
import App from './App.js';
themes.initialized(() => {
ReactDOM.render(<App />, document.getElementById('app'));
});
export const 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',
},
];
export const orientations = [
{ text: 'Horizontal', value: 'horizontal' },
{ text: 'Vertical', value: 'vertical' },
];
export const navigationModes = [
{ text: 'Non-linear', value: false },
{ text: 'Linear', value: true },
];
<!DOCTYPE html>
<html 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.6/css/dx.light.css" />
<link rel="stylesheet" type="text/css" href="styles.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/systemjs@0.21.3/dist/system.js"></script>
<script type="text/javascript" src="config.js"></script>
<script type="text/javascript">
System.import("./index.tsx");
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="app"></div>
</div>
</body>
</html>
#app {
display: flex;
flex-direction: column;
}
.stepper-demo {
display: flex;
height: 580px;
gap: 20px;
}
.widget-container {
display: flex;
align-items: center;
justify-content: center;
width: calc(100% - 280px);
min-width: 320px;
overflow: clip;
gap: 20px;
}
.widget-wrapper {
display: inline-flex;
flex-direction: column;
align-items: center;
justify-content: center;
row-gap: 80px;
width: 100%;
height: 100%;
}
.widget-wrapper-vertical {
display: flex;
flex-direction: row;
justify-content: space-around;
}
.widget-wrapper-vertical .stepper-wrapper {
width: auto;
max-width: 33%;
}
.widget-wrapper-vertical .stepper-label {
text-align: center;
white-space: nowrap;
}
.widget-wrapper-vertical #customText {
width: auto;
}
.dx-stepper-vertical {
height: 400px;
width: 100%;
}
.stepper-wrapper {
width: 100%;
display: flex;
flex-direction: column;
align-items: center;
gap: 16px;
}
.stepper-label {
font-weight: 600;
}
.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%;
}
.caption {
font-weight: 500;
font-size: 18px;
}
.option {
display: flex;
flex-direction: column;
row-gap: 4px;
}
.option-separator {
border-bottom: 1px solid var(--dx-color-border);
}
.dx-buttongroup .dx-button {
width: 50%;
}
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. -
render/component
Allow you to customize step-related appearance. These properties override all other step settings.