@progress/kendo-vue-layout
Version:
92 lines (91 loc) • 2.71 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
import { SVGIcon } from '@progress/kendo-vue-common';
/**
* Represents the props of the [Kendo UI for Vue Step component]({% slug overview_stepper %}).
*/
export interface StepProps {
/**
* Specifies a list of CSS classes that will be added to the Step element.
*/
className?: string;
/**
* Represents the content that will be rendered inside each Step.
*
* @hidden
*/
content?: any;
/**
* Specifies the current Step.
*/
current?: boolean;
/**
* Sets a custom property.
*/
[customProp: string]: any;
/**
* Specifies if the Step is disabled
* ([see example]({% slug display_modes_stepper %})).
*/
disabled?: boolean;
/**
* Defines the name for an existing icon in a Kendo UI for Vue theme.
* The icon is rendered inside the Step indicator by a `span.k-icon` element
* ([see example]({% slug display_modes_stepper %})).
*/
icon?: string;
/**
* Defines an SVGIcon to be rendered within the Step.
*/
svgIcon?: SVGIcon;
/**
* Defines the name for an success icon in a Kendo UI for Vue theme.
*/
successIcon?: String;
/**
* Defines an success SVGIcon to be rendered within the Step.
*/
successSvgIcon?: Object;
/**
* Defines the name for an error icon in a Kendo UI for Vue theme.
*/
errorIcon?: String;
/**
* Defines an error SVGIcon to be rendered within the Step.
*/
errorSvgIcon?: Object;
/**
* Sets the index of the Step that is used to identify it.
*/
index?: number;
/**
* Specifies the validity of the step
* ([see example]({% slug display_modes_stepper %})).
*/
isValid?: boolean;
/**
* Specifies the label of the Step
* ([see example]({% slug display_modes_stepper %})).
*/
label?: string;
/**
* Specifies if the step is optional. The validation is not applied to these steps
* ([see example]({% slug display_modes_stepper %})).
*/
optional?: boolean;
/**
* Sets the `tabIndex` property of the Step.
* Defaults to `0`.
*/
tabIndex?: number;
/**
* Specifies the text content of the Step indicator
* ([see example]({% slug display_modes_stepper %})).
*/
text?: string;
}