Skip to content
Kimenpre-v1documentation home
Color scheme

ki-stepper

Use a Stepper for onboarding, checkout or other tasks with named stages. Provide a localized label and put the steps in task order. Your application updates the current step and any completed or failed steps.

Theme for this example
Color scheme for this example
Account Invite team Review
<ki-stepper label="Setup progress">
<ki-step state="done" href="#account">Account</ki-step>
<ki-step state="current">Invite team</ki-step>
<ki-step>Review</ki-step>
</ki-stepper>

Horizontal layout adapts to the stepper’s available inline size. Below 22rem the current position appears in a disclosure that opens the ordered list. Use orientation="vertical" to keep the list stacked and expanded at every width. Each step can carry a short description.

Accessibility

The list uses native ordered-list semantics. The current item has aria-current="step", and the text equivalent of each state accompanies the label. Completed steps with an href use native links. Keep label content passive. Localize the state-label and summary properties for your page’s language.

API reference

When to use: Show the current place in onboarding, checkout or a wizard. Provide a label and direct ki-step children in task order.

When not to use: A percentage or indeterminate task, a carousel position, or navigation among peer views. The task owner updates step states.

Properties & attributes

AttributePropertyTypeDefaultDescription
count-labelcountLabelstring | undefined'Steps ({total})'Compact disclosure text without a current step. Include {total}.
current-labelcurrentLabelstring | undefined'Current'Localized text for the current step.
done-labeldoneLabelstring | undefined'Completed'Localized text for a completed step.
error-labelerrorLabelstring | undefined'Error'Localized text for a step that has an error.
labellabelstring–Accessible name of the list. Use a localized description of the task.
orientationorientation"horizontal" | "vertical"'horizontal'Use vertical for a stacked list. Horizontal layout compacts below 22rem.
summary-labelsummaryLabelstring | undefined'Step {current} of {total}'Compact disclosure text. Place {current} and {total} in the local order.
upcoming-labelupcomingLabelstring | undefined'Not started'Localized text for an upcoming step.

Slots

SlotDescription
(default)Direct ki-step children in task order. The stepper assigns each child to its row automatically.

CSS parts

PartDescription
connectorThe decorative line leading to the next step.
descriptionOptional supporting text below the label.
listThe ordered list.
markerThe decorative step number or state glyph.
stepA list item in the sequence.
summaryThe compact disclosure button.
titleThe label, rendered as a link when a completed step has a destination.

CSS custom properties

The public styling contract of ki-stepper: reassign these tokens at :root or on a subtree — never override internals.

TokenDescription
--ki-corner-activity-markRound corners for rings and typing dots.
--ki-density-target-minThe smallest pointer target any density may produce: 24 x 24 CSS px by default and in compact (WCAG 2.5.8 AA), 44 x 44 in touch (WCAG 2.5.5). It floors a shrinking control but never lifts what a control paints: a control painted smaller extends its target to it, invisibly; rows and tabs grow to it (spec 045 A1).
--ki-focus-ring-colorColour of the keyboard focus ring every focusable component draws: 3:1 or more against the page in every theme and scheme.
--ki-focus-ring-offsetGap between a focusable component and its keyboard focus ring.
--ki-focus-ring-widthThickness of the keyboard focus ring every focusable component draws (its outline). One token instead of one per component, so a mode or a theme changes every ring at once.
--ki-layout-spacing-7xlThe 7xl spacing step for a stack or grid gap.
--ki-layout-spacing-mdThe md spacing step for a stack or grid gap.
--ki-layout-spacing-smThe sm spacing step for a stack or grid gap.
--ki-layout-spacing-xlThe xl spacing step for a stack or grid gap.
--ki-layout-spacing-xsThe xs spacing step for a stack or grid gap.
--ki-layout-spacing-xxsThe xxs spacing step for a stack or grid gap.
--ki-step-description-bgBacking of a step description.
--ki-step-description-fgInk of a step description.
--ki-stepper-connectorDecorative connector from a step that is still incomplete.
--ki-stepper-connector-doneDecorative connector from a completed step.
--ki-stepper-current-bgFill of the current step marker.
--ki-stepper-current-borderOutline of the current step marker.
--ki-stepper-current-fgNumber ink on the current step marker.
--ki-stepper-done-bgFill of a completed step marker.
--ki-stepper-done-fgGlyph ink on the completed step marker.
--ki-stepper-dot-sizeDiameter of the step marker.
--ki-stepper-error-bgFill of the step error marker.
--ki-stepper-error-borderOutline of the step error marker.
--ki-stepper-error-fgGlyph ink of the step error marker.
--ki-stepper-glyph-sizeSize of the marker and disclosure glyphs.
--ki-stepper-label-bgDefault backing of a step label.
--ki-stepper-label-fgDefault ink of a step label.
--ki-stepper-strokeWidth of the marker outline and connector.
--ki-stepper-summary-bgBacking of the compact disclosure.
--ki-stepper-summary-fgInk of the compact disclosure.
--ki-stepper-upcoming-bgFill of an upcoming step marker.
--ki-stepper-upcoming-borderOutline of an upcoming step marker.
--ki-stepper-upcoming-fgNumber and label ink of an upcoming step.
--ki-typography-family-bodysemantic font family for typography family body.
--ki-typography-line-height-body-1semantic dimension for typography line height body 1.
--ki-typography-line-height-caption-2semantic dimension for typography line height caption 2.
--ki-typography-size-body-1semantic dimension for typography size body 1.
--ki-typography-size-caption-2semantic dimension for typography size caption 2.
--ki-typography-weight-body-semiboldsemantic font weight for typography weight body semibold.