Skip to content

Step indicator

Where a person is in a flow of a few steps, with a bar per step and a Step N of M heading.

<div class="cap-steps" id="steps-current">
  <ol class="cap-steps-list" aria-label="Steps">
    <li class="cap-step" data-state="complete"><span class="cap-step-name">Address<span class="cap-sr-only">, done</span></span></li>
    <li class="cap-step" aria-current="step"><span class="cap-step-name">Checks</span></li>
    <li class="cap-step"><span class="cap-step-name">Who is told<span class="cap-sr-only">, not done</span></span></li>
    <li class="cap-step"><span class="cap-step-name">Review<span class="cap-sr-only">, not done</span></span></li>
  </ol>
  <h3 class="cap-steps-heading"><span class="cap-steps-counter">Step 2 of 4</span> Checks</h3>
</div>

Installation

// package.json: "capsomer": "github:DrDustinEdwards/capsomer#v0.152.2"
import "capsomer/tokens.css";
import "capsomer/base.css";
import "capsomer/step-indicator.css";

Usage

<div class="cap-steps">
  <ol class="cap-steps-list" aria-label="Steps">
    <li class="cap-step" data-state="complete"><span class="cap-step-name">Address<span class="cap-sr-only">, done</span></span></li>
    <li class="cap-step" aria-current="step"><span class="cap-step-name">Checks</span></li>
    <li class="cap-step"><span class="cap-step-name">Review<span class="cap-sr-only">, not done</span></span></li>
  </ol>
  <h2 class="cap-steps-heading"><span class="cap-steps-counter">Step 2 of 3</span> Checks</h2>
</div>

Examples

The first step, and the last one with every step before it done

<div class="cap-steps">
  <ol class="cap-steps-list" aria-label="Steps">
    <li class="cap-step" aria-current="step"><span class="cap-step-name">Account</span></li>
    <li class="cap-step"><span class="cap-step-name">Plan<span class="cap-sr-only">, not done</span></span></li>
    <li class="cap-step"><span class="cap-step-name">Pay<span class="cap-sr-only">, not done</span></span></li>
  </ol>
  <h3 class="cap-steps-heading"><span class="cap-steps-counter">Step 1 of 3</span> Account</h3>
</div>
<div class="cap-steps" id="steps-last">
  <ol class="cap-steps-list" aria-label="Steps">
    <li class="cap-step" data-state="complete"><span class="cap-step-name">Account<span class="cap-sr-only">, done</span></span></li>
    <li class="cap-step" data-state="complete"><span class="cap-step-name">Plan<span class="cap-sr-only">, done</span></span></li>
    <li class="cap-step" aria-current="step"><span class="cap-step-name">Pay</span></li>
  </ol>
  <h3 class="cap-steps-heading"><span class="cap-steps-counter">Step 3 of 3</span> Pay</h3>
</div>

Five steps in a narrow column: the names wrap

<div id="steps-narrow-wrap">
  <div class="cap-steps">
    <ol class="cap-steps-list" aria-label="Steps">
      <li class="cap-step" data-state="complete"><span class="cap-step-name">Draft<span class="cap-sr-only">, done</span></span></li>
      <li class="cap-step" data-state="complete"><span class="cap-step-name">Sections<span class="cap-sr-only">, done</span></span></li>
      <li class="cap-step" aria-current="step"><span class="cap-step-name">Cover</span></li>
      <li class="cap-step"><span class="cap-step-name">Share<span class="cap-sr-only">, not done</span></span></li>
      <li class="cap-step"><span class="cap-step-name">Publish<span class="cap-sr-only">, not done</span></span></li>
    </ol>
    <h3 class="cap-steps-heading"><span class="cap-steps-counter">Step 3 of 5</span> Cover</h3>
  </div>
</div>

Stations: the stages of a process, filled where a stage has something

<div class="cap-steps" data-variant="stations" id="steps-stations">
  <ol class="cap-steps-list" aria-label="Stages of a release">
    <li class="cap-step" data-state="complete"><span class="cap-step-dot" aria-hidden="true">1</span><a class="cap-step-name" href="#plan">Plan</a><span class="cap-step-meta">4 guides</span></li>
    <li class="cap-step" data-state="complete"><span class="cap-step-dot" aria-hidden="true">2</span><a class="cap-step-name" href="#build">Build</a><span class="cap-step-meta">7 guides</span></li>
    <li class="cap-step"><span class="cap-step-dot" aria-hidden="true">3</span><span class="cap-step-name">Review</span><span class="cap-step-meta">No guide yet</span></li>
    <li class="cap-step" data-state="complete"><span class="cap-step-dot" aria-hidden="true">4</span><a class="cap-step-name" href="#ship">Ship</a><span class="cap-step-meta">2 guides</span></li>
  </ol>
</div>

Inline: a sequence as chips that wrap

<div class="cap-steps" data-variant="inline" id="steps-inline">
  <ol class="cap-steps-list" aria-label="Reminder sequence, 5 steps">
    <li class="cap-step"><span class="cap-pill" data-tone="info">Email, day 0</span></li>
    <li class="cap-step"><span class="cap-pill" data-tone="info">Email, day 3</span></li>
    <li class="cap-step"><span class="cap-pill" data-variant="outline">Retry, day 5</span></li>
    <li class="cap-step"><span class="cap-pill" data-tone="info">Email, day 7</span></li>
    <li class="cap-step"><span class="cap-pill" data-tone="info">Email, day 14</span></li>
  </ol>
</div>

Ordered: one row per step with what it says beside it

<div class="cap-steps" data-variant="ordered" id="steps-ordered">
  <ol class="cap-steps-list" aria-label="What happens to a failed payment">
    <li class="cap-step"><span class="cap-step-number" aria-hidden="true">01</span><span class="cap-step-name">The payment fails and the first reminder goes out</span><span class="cap-step-meta">Day 0</span></li>
    <li class="cap-step"><span class="cap-step-number" aria-hidden="true">02</span><span class="cap-step-name">The card is tried again</span><span class="cap-step-meta">Day 3</span></li>
    <li class="cap-step"><span class="cap-step-number" aria-hidden="true">03</span><span class="cap-step-name">A last reminder, with a link to update the card</span><span class="cap-step-meta">Day 7</span></li>
  </ol>
</div>

API reference

Parts and data attributes

ClassIs
.cap-stepits own class
.cap-step-dotits own class
.cap-step-metaits own class
.cap-step-nameits own class
.cap-step-numberits own class
.cap-stepsthe root
.cap-steps-countera part
.cap-steps-headinga part
.cap-steps-lista part
AttributeValues
data-statecomplete
data-variantinline ordered stations
StateRead from
[aria-current="step"]an attribute

Accessibility

Nothing to operate: it is text. Tab passes it by.

  • ol with aria-label="Steps"; each step's state in words as well as in the bar.
  • Forced colors: the done and current bars are drawn in Highlight, and the tick in CanvasText.