React Stepper API
A Stepper is a UI component that displays progress as a user moves through a sequence of steps.
Props
| Name | Description |
|---|---|
| accessKey | Specifies the shortcut key that sets focus on the UI component. |
| activeStateEnabled | Specifies whether Stepper changes its appearance when in the active state (when an end user interacts with it). |
| dataSource | Binds the UI component to data. |
| disabled | Specifies whether the UI component responds to user interaction. |
| elementAttr | Specifies the global attributes to be attached to the UI component's container element. |
| focusStateEnabled | Specifies whether the UI component can be focused using keyboard navigation. |
| height | Specifies the UI component's height. |
| hint | Specifies text for a hint that appears when a user pauses on the UI component. |
| hoverStateEnabled | Specifies whether the UI component changes its appearance when a user hovers over it. |
| itemComponent | An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| itemRender | An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| items | An array of items (steps) displayed by the Stepper component. |
| itemTemplate | Specifies a custom template for items. |
| linear | Specifies a navigation mode (linear/non-linear). |
| onDisposing | A function that is executed before the UI component is disposed of. |
| onInitialized | A function that fires when the component finishes its initialization. |
| onItemClick | A function that is executed when an item (step) is clicked or tapped. |
| onItemContextMenu | A function that is executed when an item (step) is right-clicked or long-pressed. |
| onItemRendered | A function that is executed after an item (step) is rendered. |
| onOptionChanged | A function that is executed after a UI component property is changed. |
| onSelectionChanged | A function that is executed when an item (step) is selected or the selection is canceled. |
| onSelectionChanging | A function that is called before selection changes. |
| orientation | Specifies the Stepper orientation. |
| rtlEnabled | Switches the UI component to a right-to-left representation. |
| selectedIndex | The index of the currently selected UI component item. |
| selectedItem | The selected item object. |
| selectOnFocus | Specifies if items are selected automatically when focused by keyboard. |
| tabIndex | Specifies the number of the element when the Tab key is used for navigating. |
| visible | Specifies whether the UI component is visible. |
| width | Specifies the UI component's width. |
Methods
This section describes members used to manipulate the UI component.
| Name | Description |
|---|---|
| beginUpdate() | Postpones rendering that can negatively affect performance until the endUpdate() method is called. |
| defaultOptions(rule) | Specifies the device-dependent default configuration properties for this component. |
| dispose() | Disposes of all the resources allocated to the Stepper instance. |
| element() | Gets the root UI component element. |
| endUpdate() | Refreshes the UI component after a call of the beginUpdate() method. |
| focus() | Sets focus on the UI component. |
| getDataSource() | Gets the DataSource instance. |
| getInstance(element) | Gets the instance of a UI component found using its DOM node. |
| instance() | Gets the UI component's instance. Use it to access other methods of the UI component. |
| off(eventName) | Detaches all event handlers from a single event. |
| off(eventName, eventHandler) | Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) | Subscribes to an event. |
| on(events) | Subscribes to events. |
| option() | Gets all UI component properties. |
| option(optionName) | Gets the value of a single property. |
| option(optionName, optionValue) | Updates the value of a single property. |
| option(options) | Updates the values of several properties. |
| registerKeyHandler(key, handler) | Registers a handler to be executed when a user presses a specific key. |
| repaint() | Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. |
| resetOption(optionName) | Resets a property to its default value. |
Events
This section describes events fired by this UI component.
| Name | Description |
|---|---|
| disposing | Raised before the UI component is disposed of. |
| initialized | Raised only once, after the UI component is initialized. |
| itemClick | Raised when a collection item is clicked or tapped. |
| itemContextMenu | Raised when a collection item is right-clicked or pressed. |
| itemRendered | Raised after a collection item is rendered. |
| optionChanged | Raised after a UI component property is changed. |
| selectionChanged | Raised after selection changes. |
| selectionChanging | Raised before selection changes. |
See Also
Types
| Name | Description |
|---|---|
| DisposingEvent | The argument type in the disposing event. |
| InitializedEvent | The argument type in the initialized event. |
| ItemClickEvent | The argument type in the itemClick event. |
| ItemContextMenuEvent | The argument type in the itemContextMenu event. |
| ItemRenderedEvent | The argument type in the itemRendered event. |
| OptionChangedEvent | The argument type in the optionChanged event. |
| SelectionChangedEvent | The argument type in the selectionChanged event. |
| SelectionChangingEvent | The argument type in the selectionChanging event. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.