The ld-step
component is a subcomponent for ld-stepper
.
Please refer to the ld-stepper
documentation for usage examples.
Property | Attribute | Description | Type | Default |
---|---|---|---|---|
brandColor |
brand-color |
Switch colors for brand background | boolean |
false |
current |
current |
Step is the current step | boolean |
false |
description |
description |
Description text to display below the step name (vertical mode only) | string |
undefined |
disabled |
disabled |
Step is not clickable | boolean |
false |
done |
done |
Step is done | boolean |
false |
href |
href |
Link to the step (makes the step an anchor instead of a button) | string |
undefined |
icon |
icon |
Permanently show a custom icon inside the dot | HTMLLdIconElement |
undefined |
key |
key |
for tracking the node's identity when working with lists | string | number |
undefined |
labelCurrent |
label-current |
Label for current step (scree-reader only) | string |
'Current' |
labelDone |
label-done |
Label for step that is done (scree-reader only) | string |
'Done' |
labelOptional |
label-optional |
Label for step that is optional (scree-reader only) | string |
'Optional' |
labelSkipped |
label-skipped |
Label for step that was skipped (scree-reader only) | string |
'Skipped' |
labelWasOptional |
label-was-optional |
Additional hint in label for step that is done and was optional (scree-reader only) | string |
'was optional' |
lastActive |
last-active |
Indicates that the next step is not active | boolean |
false |
ldTabindex |
ld-tabindex |
Tab index of the step | number |
undefined |
next |
next |
Step can be processed next | boolean |
false |
optional |
optional |
Step may be skipped | boolean |
false |
ref |
ref |
reference to component | any |
undefined |
size |
size |
Step size | "lg" | "sm" |
undefined |
skipped |
skipped |
Step was skipped | boolean |
false |
vertical |
vertical |
Vertical layout | boolean |
false |
Event | Description | Type |
---|---|---|
ldstepselected |
Emitted when the focusable element is clicked and step is neither current nor disabled | CustomEvent<{ index: number; label: string; }> |
focusInner() => Promise<void>
#Sets focus on the step
Type: Promise<void>
Part | Description |
---|---|
"a" |
actual a element |
"button" |
actual button element |
"description" |
span element wrapping the description text |
"focusable" |
focusable a or button element, depending on href prop |
"li" |
actual li element |
graph TD;
ld-step --> ld-sr-only
ld-step --> ld-icon
style ld-step fill:#f9f,stroke:#333,stroke-width:4px
Built with StencilJS