eds-steps-v2

Explore the Interactive Component

Use the playground below to experiment with the component. Click the button to view the full Storybook deployment for additional examples and configurations.

eds-steps-v2 Open in Storybook

See It in Use with Code

Check out this practical implementation of component.

Plain HTML

Steps - Slot Content

The eds-steps-v2 component lets you override the content for each step and provide your own custom content—whether that’s another UI component or just plain text.

Two named slots are available per step, where N is the zero-based index of the step in steps:

  • step-N replaces the step’s content (the title still comes from steps).
  • actions-N adds extra elements (e.g. links or buttons) after the step’s navigation buttons.

Another example eds-steps in eds-steps-v2

Properties

PropertyAttributeDescriptionTypeDefault
backLabelback-labelstring'Back'
cardcardWhether the stepper draws its own bordered card. Default true. Set to false when the host already provides the card chrome (e.g. a multi-step form whose form-style border lives on an outer wrapper) to avoid a double border.booleantrue
disableNextdisable-nextDisable Next/Finish (boolean or per-step boolean[]). Also accepts a JSON array string.boolean | boolean[] | stringfalse
finishLabelfinish-labelstring'Finish'
finishingfinishingA submit in flight: the Finish button spins inline and can’t be pressed again.booleanfalse
headingLevelheading-levelHeading level for titles"h3" | "h4" | "h5"'h4'
imageSrcimage-srcOptional illustrationstringundefined
imageWidthimage-widthnumberundefined
messagemessagestringundefined
nextLabelnext-labelLabelsstring'Next'
orientationorientationOrientation (applies to linear visuals)"horizontal" | "vertical"'vertical'
showFinishshow-finishShow or hide the finish button on the last stepbooleantrue
stepsstepsJSON string or array of steps: { title, content? }Step[] | string[]
themethemeVisual theme for the steps component. - ‘default’: outlined circles; current step brand black, done dark green with a check - ‘brand’: as default, with the current step in neon green (black text) and a soft halo"brand" | "default"'default'
typetypeStepper mode"linear" | "static"'static'

Events

EventDescriptionType
backFired before going back, with the target step index.CustomEvent<number>
finishedFired when user clicks Finish on the last step.CustomEvent<void>
nextFired before advancing, with the target step index.CustomEvent<number>
stepFired whenever the active step changes. Payload: current step index.CustomEvent<number>

Methods

goToStep(index: number, force?: boolean) => Promise<void>

Programmatically move to a step — e.g. to resume a saved draft on the first incomplete step rather than always starting at step 1. The index is clamped to range and the step event is emitted so the host stays in sync.

In linear mode a forward jump normally won’t cross a step that is currently blocked (disable-next), mirroring title-click navigation. Pass force to bypass that guard: a host driving a validated target (e.g. the first incomplete step of a resumed draft — every earlier step is complete by construction) is safe, and the guard would otherwise read a stale disable-next prop that hasn’t propagated yet and wrongly block the jump.

Parameters

NameTypeDescription
indexnumber
forceboolean

Returns

Type: Promise<void>

Dependencies

Depends on

Graph

graph TD;
  eds-steps-v2 --> eds-icon-wrapper
  eds-steps-v2 --> eds-img
  eds-steps-v2 --> eds-button
  eds-button --> eds-icon-wrapper
  style eds-steps-v2 fill:#f9f,stroke:#333,stroke-width:4px

Built with StencilJS