Skip to content

Timeline

A process as numbered steps down a line that fills as it scrolls into view.

<ol class="cap-timeline" id="tl-default" data-cap="timeline">
  <li class="cap-timeline-step">
    <span class="cap-timeline-node" aria-hidden="true">01</span>
    <div class="cap-timeline-body">
      <h3 class="cap-timeline-title">Send the draft</h3>
      <div class="cap-timeline-text"><p>Upload the document and pick a turnaround.</p></div>
    </div>
  </li>
  <li class="cap-timeline-step">
    <span class="cap-timeline-node" aria-hidden="true">02</span>
    <div class="cap-timeline-body">
      <h3 class="cap-timeline-title">Matched with an editor</h3>
      <div class="cap-timeline-text"><p>An editor in your field confirms a finish date.</p></div>
    </div>
  </li>
  <li class="cap-timeline-step">
    <span class="cap-timeline-node" aria-hidden="true">03</span>
    <div class="cap-timeline-body">
      <h3 class="cap-timeline-title">Two copies back</h3>
      <div class="cap-timeline-text"><p>One with every change shown, one clean.</p></div>
    </div>
  </li>
</ol>

Installation

// package.json: "capsomer": "github:DrDustinEdwards/capsomer#v0.152.2"
import "capsomer/tokens.css";
import "capsomer/base.css";
import "capsomer/timeline.css";
import { enhance } from "capsomer/behavior/timeline";

enhance();

Usage

<ol class="cap-timeline" data-cap="timeline">
  <li class="cap-timeline-step">
    <span class="cap-timeline-node" aria-hidden="true">01</span>
    <div class="cap-timeline-body">
      <span class="cap-timeline-icon" aria-hidden="true"><svg>...</svg></span>   <!-- optional -->
      <h3 class="cap-timeline-title">Send the draft</h3>
      <div class="cap-timeline-text"><p>Upload the document and pick a turnaround.</p></div>
    </div>
  </li>
</ol>

Examples

A site's own look: larger nodes and a gradient fill

<ol class="cap-timeline timeline-specimen-site" data-cap="timeline">
  <li class="cap-timeline-step">
    <span class="cap-timeline-node" aria-hidden="true">01</span>
    <div class="cap-timeline-body">
      <h3 class="cap-timeline-title">Field notes</h3>
      <div class="cap-timeline-text"><p>Gather what the team saw.</p></div>
    </div>
  </li>
  <li class="cap-timeline-step">
    <span class="cap-timeline-node" aria-hidden="true">02</span>
    <div class="cap-timeline-body">
      <h3 class="cap-timeline-title">Annual report</h3>
      <div class="cap-timeline-text"><p>Write it up once a year.</p></div>
    </div>
  </li>
</ol>

API reference

Timeline

PropTypeRequiredDoes
stepsTimelineStep[]Yes
level"h2" | "h3" | "h4"The steps' heading level on the page.
classNamestring

Functions

FunctionSignatureDoes
attach(el: HTMLElement): () => voidThe timeline's behavior: the line between the steps fills from the first to the last once the timeline scrolls into view (200px early). With no script, and with reduced motion, it is drawn full. The fill is a transform, so nothing is measured and a resize needs no work. One timeline: fills its line once it nears the view. Returns a function that undoes it.
enhance(root?: ParentNode): () => void

CSS variables

VariableDefault
--cap-timeline-durationcalc(var(--dur-slow) * 3)
--cap-timeline-fillvar(--primary)
--cap-timeline-gapvar(--space-7)
--cap-timeline-node64px
--cap-timeline-node-bgvar(--surface)
--cap-timeline-node-linevar(--line-strong)
--cap-timeline-trackvar(--line)

Parts and data attributes

ClassIs
.cap-timelinethe root
.cap-timeline-bodya part
.cap-timeline-icona part
.cap-timeline-nodea part
.cap-timeline-stepa part
.cap-timeline-texta part
.cap-timeline-titlea part
AttributeValues
data-cap-readypresent or absent
data-shownpresent or absent

Accessibility

None: it holds no control (links in a step's words are in the normal order).

  • ol and li, each step's title a heading at the page's level.
  • The node numbers and icons are aria-hidden.
  • In forced colors the line is drawn in system colors.