Step Ready
Step is a component used inside Stepper. A step consists of a numbered heading and content. For concrete usage examples, please see the Stepper component.
Properties #
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
heading (required) | heading | Set the heading for the step. | string | undefined |
headingLevel (required) | heading-level | Set the heading level used in the HTML markup. | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | undefined |
theme | theme | Theme of the component. | "" | "default" | "turva" | "" |
Events #
| Event | Description | Type |
|---|---|---|
duetStepClick | Event emitted when the step heading is clicked. | CustomEvent<{ originalEvent: KeyboardEvent | MouseEvent; component: "duet-step"; stepIndex: number; }> |
Methods #
setFocus(options?: FocusOptions) => Promise<void> #
Programmatically shift focus to the step's heading.
Parameters #
| Name | Type | Description |
|---|---|---|
options | FocusOptions |
Returns #
Type: Promise<void>
Slots #
| Slot | Description |
|---|---|
"heading-content" | Step heading content. Use this slot to show additional content next to step heading. |
"unnamed default slot" | The component’s primary content. All child nodes that do not have a slot attribute defined are inserted into this primary slot. |
Usage #
This section includes guidelines for designers and developers about the usage of this component in different contexts.
When to use #
- For use inside stepper component to generate steps that can be navigated.
When not to use #
- Outside of stepper component.
Accessibility #
This component has been validated to meet the WCAG 2.1 AA accessibility guidelines. You can find additional information regarding accessibility of this component below.
- Use the
headingproperty to create a text label for the step contents. headingLevelproperty can be used to set the heading level used in the HTML markup.- Step heading uses
role="button"to correctly convey its role to assistive technologies. - Step heading uses
tabindex="0"to make it possible to access it using tab key or programmatically moving focus to it. - Step heading additionally utilizes
aria-expandedandaria-controlsattributes to correctly convey its functionality to assistive technologies.
Integration
For integration, event and theming guidelines, please see Using Components. This documentation explains how to implement and use Duet’s components across different technologies like Angular, React or Vanilla JavaScript.
Tutorials
Follow these practical tutorials to learn how to build simple page layouts using Duet’s CSS Framework, Web Components and other features:
Building Layouts
TutorialsUsing CLI Tools
TutorialsCreating Custom Patterns
TutorialsServer Side Rendering
TutorialsSharing Prototypes
TutorialsUsage With Markdown
Troubleshooting
If you experience any issues while using a component, please head over to the Support page for more guidelines and help.