/** * DevExtreme (ui/stepper.d.ts) * Version: 25.1.7 * Build date: Mon Nov 10 2025 * * Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED * Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/ */ import { DataSourceLike } from '../data/data_source'; import { EventInfo, NativeEventInfo, InitializedEventInfo, ChangedOptionInfo, ItemInfo, PointerInteractionEvent, } from '../events'; import CollectionWidget, { CollectionWidgetItem, CollectionWidgetOptions, SelectionChangeInfo, SelectionChangingEventBase, } from './collection/ui.collection_widget.base'; import { Orientation, } from '../common'; /** * @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution. */ type ItemLike = string | Item | any; /** * The argument type in the disposing event. */ export type DisposingEvent = EventInfo>; /** * The argument type in the initialized event. */ export type InitializedEvent = InitializedEventInfo>; /** * The argument type in the itemClick event. */ export type ItemClickEvent = NativeEventInfo, MouseEvent | PointerEvent> & ItemInfo; /** * The argument type in the itemContextMenu event. */ export type ItemContextMenuEvent = NativeEventInfo, PointerInteractionEvent> & ItemInfo; /** * The argument type in the itemRendered event. */ export type ItemRenderedEvent = EventInfo> & ItemInfo; /** * The argument type in the optionChanged event. */ export type OptionChangedEvent = EventInfo> & ChangedOptionInfo; /** * The argument type in the selectionChanging event. */ export type SelectionChangingEvent = SelectionChangingEventBase>; /** * The argument type in the selectionChanged event. */ export type SelectionChangedEvent = EventInfo> & SelectionChangeInfo; /** * * @deprecated */ export interface dxStepperOptions< TItem extends ItemLike = any, TKey = any, > extends CollectionWidgetOptions, TItem, TKey> { /** * Specifies whether Stepper changes its appearance when in the active state (when an end user interacts with it). */ activeStateEnabled?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its appearance when a user hovers over it. */ hoverStateEnabled?: boolean; /** * Specifies if items are selected automatically when focused by keyboard. */ selectOnFocus?: boolean; /** * Binds the UI component to data. */ dataSource?: DataSourceLike | null; /** * Specifies the Stepper orientation. */ orientation?: Orientation; /** * Specifies a navigation mode (linear/non-linear). */ linear?: boolean; /** * An array of items (steps) displayed by the Stepper component. */ items?: Array; } /** * A Stepper is a UI component that displays progress as a user moves through a sequence of steps. */ export default class dxStepper< TItem extends ItemLike = any, TKey = any, > extends CollectionWidget, TItem, TKey> { } export type Item = dxStepperItem; /** * @deprecated Use Item instead * @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution. */ export interface dxStepperItem extends CollectionWidgetItem { /** * Specifies the indicator icon. */ icon?: string; /** * Specifies the caption displayed next to the step. */ label?: string; /** * Specifies the hint text that appears when an item (step) is hovered over or long-pressed. */ hint?: string; /** * Marks the step as optional. */ optional?: boolean; /** * Specifies a visual indicator for validation. */ isValid?: boolean; } export type ExplicitTypes< TItem extends ItemLike, TKey, > = { Properties: Properties; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; SelectionChangedEvent: SelectionChangedEvent; SelectionChangingEvent: SelectionChangingEvent; }; export type Properties< TItem extends ItemLike = any, TKey = any, > = dxStepperOptions;