Skip to Content
BBRICKSv0.7.4
KitPrimitives

StepTimeline

The v3 mock's steps(): an ordered list, a ✓ in green for each step reached ("Where the commission is", a gift order's delivery). Each step says "done" / "not yet" in words, so the state never rests on the tick or its colour. The steps come from the caller (MoneyBreakdown states, the store's order), never invented here.

import { StepTimeline } from '@ergasti/bricks';

Examples

Steps

A vertical list of what has and has not happened yet, with the date under a finished step.

Code
import { StepTimeline } from '@ergasti/bricks';

function Commission() {
  return (
    <div style={{ maxWidth: 320 }}>
      <StepTimeline
        label="Where the commission is"
        steps={[
          { label: 'Order placed with coupon', done: true, when: '3 Nov 2026' },
          { label: 'Delivered', done: true, when: '6 Nov 2026' },
          { label: '14-day return window over', done: false },
          { label: 'Approved for payout', done: false },
          { label: 'Paid to the creator', done: false },
        ]}
      />
    </div>
  );
}

A skipped step

skipped marks a step that was passed over, not missed: a dashed marker and muted words, read "skipped". Here the commission was approved early, so the return window never ran. Use done: false for a step that is still to come.

Code
import { StepTimeline } from '@ergasti/bricks';

function Skipped() {
  return (
    <div style={{ maxWidth: 320 }}>
      <StepTimeline
        label="Where the commission is"
        steps={[
          { label: 'Order placed with coupon', done: true, when: '3 Nov 2026' },
          { label: 'Delivered', done: true, when: '6 Nov 2026' },
          { label: '14-day return window over', done: false, skipped: true },
          { label: 'Approved for payout', done: true, when: '7 Nov 2026' },
          { label: 'Paid to the creator', done: false },
        ]}
      />
    </div>
  );
}

Props

Prop

Type

Labels

Every word this component draws, in both languages. Override one per component and language with BricksProvider labels under the key stepTimeline, or with the component's own prop where it has one. A {name} is a value the component fills in.

stepTimeline
KeyEnglishArabic
donedoneخلصت
todonot yetلسه
skippedskippedاتخطّى

Design guidance

How the BRICKS design system uses StepTimeline. Written in docs/content/components/StepTimeline.md; the props above are read from the code, which wins where the two disagree.

A vertical list of steps with a green tick on each one reached; use it to show where something is in a fixed sequence (a commission's path to payout, a gift's delivery).

StepTimeline is the v3 mock's steps(). Each step is a 22px round marker (✓ on green when done, dashed and muted when skipped, grey when not yet), a bold label and an optional "when" line. Each step also says "done", "not yet" or "skipped" in hidden words, so state never rests on the tick or its colour. The steps come from the caller (the commission's states, the store's order), never invented here.

Anatomy

  1. List (ol.kit-steps, aria-label).
  2. Step (li.kit-step + .done / .skipped): flex, 12px gap, 7px vertical padding.
  3. Marker (i, aria-hidden): 22px circle, --track / --ink-3; done --ok-bg / --ok with ✓; skipped dashed border with "–".
  4. Label (b) + hidden state word.
  5. When (.kit-sub, optional): the date.

Variants

None; the look follows each step's state.

States

Step stateFieldsLookSpoken
Donedone: trueGreen tick"(done)" / "(خلصت)"
Not yetdone: falseGrey empty circle"(not yet)" / "(لسه)"
Skippeddone: false, skipped: trueDashed circle, muted 600 label"(skipped)" / "(اتخطّى)"

Types

Step (steps): { label: ReactNode; done: boolean; skipped?: boolean; when?: ReactNode }.

Usage

The order drawer on Payments › Commissions:

<Drawer open title="Order #48211" onClose={close}>
  <DrawerHead tone="rasp" title="Order #48211" sub="13 Nov 2026" />
  <KeyValue items={[{ key: 'rule', label: 'Rule', value: '15% of the order value' }]} />
  <h3>Where the commission is</h3>
  <StepTimeline label="Where the commission is" steps={[
    { label: 'Order placed with coupon', done: true, when: '13 Nov 2026' },
    { label: 'Delivered', done: false },
    { label: '14-day return window over', done: false },
    { label: 'Approved for payout', done: false },
    { label: 'Paid to the creator', done: false },
  ]} />
</Drawer>

A gift order's delivery:

<StepTimeline label="Delivery" steps={[
  { label: 'Picked in the app', done: true, when: '9 Nov 2026' },
  { label: 'Shipped by your store', done: false },
  { label: 'Delivered', done: false },
]} />

Where it appears

  • Brand › Payments › Commissions › order drawer ("Where the commission is").
  • Brand › Motivation › gift order drawer (delivery steps).
  • Screens: Payments › Wallet, Motivation.

Guidelines

Do

  • Keep the full sequence visible, even steps not reached.
  • Use skipped for steps that did not apply (a return window on a non-returnable order).
  • Put dates in when, not in the label.

Don't

  • Don't use it for user-editable wizards; use Stepper.
  • Don't mark a later step done while an earlier one is not.

RTL and Arabic

  • Markers sit at the inline start (right in Arabic). Labels and dates are wrapped in Isolate, so mixed-script dates keep their order.

Tokens

--track, --ink-3, --ok-bg, --ok.

Accessibility

  • An ordered list named by label; each item reads "Delivered (not yet)".
  • Markers are hidden.

Found in the source

  • ARIA attributes set: aria-label, aria-hidden.
  • Its tests cover: “has nothing focusable (a record, not a control)”; “a skipped step: its own class and marker, the label reads normally, AT hears ”.

Read from the component's source and tests. See Accessibility for the patterns the library follows.

See also: Avatar · AvatarStack · Button · ButtonLink

Source

src/kit/primitives/StepTimeline.tsx (line 23) on GitHub.

On this page