devextreme-react
Version:
DevExtreme React UI and Visualization Components
94 lines (92 loc) • 4.43 kB
TypeScript
/*!
* devextreme-react
* Version: 25.1.5
* Build date: Wed Sep 03 2025
*
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file in the root of the project for details.
*
* https://github.com/DevExpress/devextreme-react
*/
export { ExplicitTypes } from "devextreme/ui/stepper";
import * as React from "react";
import { Ref, ReactElement } from "react";
import dxStepper, { Properties } from "devextreme/ui/stepper";
import { IHtmlOptions, NestedComponentMeta } from "./core/component";
import type { dxStepperItem, DisposingEvent, InitializedEvent, ItemClickEvent, ItemContextMenuEvent, ItemRenderedEvent, SelectionChangingEvent } from "devextreme/ui/stepper";
import type { CollectionWidgetItem } from "devextreme/ui/collection/ui.collection_widget.base";
import type { template } from "devextreme/common";
type ReplaceFieldTypes<TSource, TReplacement> = {
[P in keyof TSource]: P extends keyof TReplacement ? TReplacement[P] : TSource[P];
};
type IStepperOptionsNarrowedEvents<TItem = any, TKey = any> = {
onDisposing?: ((e: DisposingEvent<TItem, TKey>) => void);
onInitialized?: ((e: InitializedEvent<TItem, TKey>) => void);
onItemClick?: ((e: ItemClickEvent<TItem, TKey>) => void);
onItemContextMenu?: ((e: ItemContextMenuEvent<TItem, TKey>) => void);
onItemRendered?: ((e: ItemRenderedEvent<TItem, TKey>) => void);
onSelectionChanging?: ((e: SelectionChangingEvent<TItem, TKey>) => void);
};
type IStepperOptions<TItem = any, TKey = any> = React.PropsWithChildren<ReplaceFieldTypes<Properties<TItem, TKey>, IStepperOptionsNarrowedEvents<TItem, TKey>> & IHtmlOptions & {
dataSource?: Properties<TItem, TKey>["dataSource"];
itemRender?: (...params: any) => React.ReactNode;
itemComponent?: React.ComponentType<any>;
defaultItems?: Array<dxStepperItem>;
defaultSelectedIndex?: number;
defaultSelectedItem?: any;
onItemsChange?: (value: Array<dxStepperItem>) => void;
onSelectedIndexChange?: (value: number) => void;
onSelectedItemChange?: (value: any) => void;
}>;
interface StepperRef<TItem = any, TKey = any> {
instance: () => dxStepper<TItem, TKey>;
}
declare const Stepper: <TItem = any, TKey = any>(props: ReplaceFieldTypes<Properties<TItem, TKey>, IStepperOptionsNarrowedEvents<TItem, TKey>> & IHtmlOptions & {
dataSource?: import("devextreme/data/data_source").DataSourceLike<TItem, TKey> | null | undefined;
itemRender?: ((...params: any) => React.ReactNode) | undefined;
itemComponent?: React.ComponentType<any> | undefined;
defaultItems?: dxStepperItem[] | undefined;
defaultSelectedIndex?: number | undefined;
defaultSelectedItem?: any;
onItemsChange?: ((value: Array<dxStepperItem>) => void) | undefined;
onSelectedIndexChange?: ((value: number) => void) | undefined;
onSelectedItemChange?: ((value: any) => void) | undefined;
} & {
children?: React.ReactNode;
} & {
ref?: React.Ref<StepperRef<TItem, TKey>> | undefined;
}) => ReactElement | null;
type IItemProps = React.PropsWithChildren<{
disabled?: boolean;
hint?: string;
icon?: string;
isValid?: boolean;
label?: string;
optional?: boolean;
template?: ((itemData: CollectionWidgetItem, itemIndex: number, itemElement: any) => string | any) | template;
text?: string;
render?: (...params: any) => React.ReactNode;
component?: React.ComponentType<any>;
}>;
declare const Item: ((props: IItemProps) => React.FunctionComponentElement<React.PropsWithChildren<{
disabled?: boolean | undefined;
hint?: string | undefined;
icon?: string | undefined;
isValid?: boolean | undefined;
label?: string | undefined;
optional?: boolean | undefined;
template?: template | ((itemData: CollectionWidgetItem, itemIndex: number, itemElement: any) => string | any) | undefined;
text?: string | undefined;
render?: ((...params: any) => React.ReactNode) | undefined;
component?: React.ComponentType<any> | undefined;
} & {
children?: React.ReactNode;
} & {
elementDescriptor: import("./core/configuration/react/element").IElementDescriptor;
}>>) & NestedComponentMeta;
export default Stepper;
export { Stepper, IStepperOptions, StepperRef, Item, IItemProps };
import type * as StepperTypes from 'devextreme/ui/stepper_types';
export { StepperTypes };