API reference
Properties
Property | Attribute | Description | Type | Default |
---|---|---|---|---|
complete | complete | When true , the step has been completed. | boolean | false |
description | description | A description for the component. Displays below the header text. | string | |
disabled | disabled | When true , interaction is prevented and the component is displayed with lower opacity. | boolean | false |
error | error | When true , the component contains an error that requires resolution from the user. | boolean | false |
heading | heading | The component header text. | string | |
iconFlipRtl | icon-flip-rtl | When true , the icon will be flipped when the element direction is right-to-left ("rtl" ). | boolean | false |
messageOverrides | Use this property to override individual strings used by the component. | {
complete?: string;
previousStep?: string;
nextStep?: string;
} | ||
selected | selected | When true , the component is selected. | boolean | false |
Slots
Name | Description |
---|---|
default (unnamed) | A slot for adding custom content. |
Events
Name | Description | Behavior |
---|---|---|
calciteStepperItemSelect | Fires when the active calcite-stepper-item changes. |
Methods
Name | Description | Signature |
---|---|---|
componentOnReady | Create a promise that resolves once component is fully loaded. | componentOnReady(): Promise<void> |
setFocus | Sets focus on the component. | setFocus(): Promise<void> |