Component
Walkthrough and storyboard
Numbered steps beside the interface they describe, and a strip of screens that tells a flow frame by frame.
Plain-text source, for agents and clipboard use: /components/source/walkthrough.txt
When to use it
Explains how a task is done. The walkthrough pairs each step’s text with a frame holding the real components involved, and stacks the two when its container is narrow. The storyboard is the overview: one small screen per moment, numbered, with a caption, for a flow people should understand before they read the detail.
Examples
Walkthrough
Three steps to confirm an on-request booking. Each frame holds the components the step talks about.
-
Check what is still on request
Open the booking. Anything a supplier has not yet confirmed is marked On request, and the booking cannot be confirmed until it is resolved.
- Hotel Borg, 2 rooms
- Confirmed
- Glacier walk, 12 places
- On request
The services list on the booking. -
Chase the supplier
The note tells you who to contact and by when. Record their answer on the service, and the badge changes to match.
Reply due by 9 October
Iceland Guides holds the places until then.
-
Confirm the booking
When every service is confirmed, Confirm booking becomes available. The agent receives the confirmation straight away.
<ol class="flux-walkthrough">
<li class="flux-walkthrough__step">
<div class="flux-walkthrough__text">
<h3 class="flux-walkthrough__title">Check what is still on request</h3>
<p>Open the booking. Anything a supplier has not yet confirmed is marked On request, and the booking cannot be confirmed until it is resolved.</p>
</div>
<figure class="flux-walkthrough__media">
<div class="flux-walkthrough__frame">
<dl class="flux-dl">
<div class="flux-dl__pair"><dt class="flux-dl__term">Hotel Borg, 2 rooms</dt><dd class="flux-dl__detail"><span class="flux-badge flux-badge--confirmed">Confirmed</span></dd></div>
<div class="flux-dl__pair"><dt class="flux-dl__term">Glacier walk, 12 places</dt><dd class="flux-dl__detail"><span class="flux-badge flux-badge--pending">On request</span></dd></div>
</dl>
</div>
<figcaption>The services list on the booking.</figcaption>
</figure>
</li>
<li class="flux-walkthrough__step">
<div class="flux-walkthrough__text">
<h3 class="flux-walkthrough__title">Chase the supplier</h3>
<p>The note tells you who to contact and by when. Record their answer on the service, and the badge changes to match.</p>
</div>
<figure class="flux-walkthrough__media">
<div class="flux-walkthrough__frame">
<div class="flux-note flux-note--warning">
<div>
<p class="flux-note__title">Reply due by 9 October</p>
<p class="flux-note__body">Iceland Guides holds the places until then.</p>
</div>
</div>
</div>
</figure>
</li>
<li class="flux-walkthrough__step">
<div class="flux-walkthrough__text">
<h3 class="flux-walkthrough__title">Confirm the booking</h3>
<p>When every service is confirmed, Confirm booking becomes available. The agent receives the confirmation straight away.</p>
</div>
<figure class="flux-walkthrough__media">
<div class="flux-walkthrough__frame">
<button class="flux-button" type="button">Confirm booking</button>
</div>
</figure>
</li>
</ol>Storyboard
The same flow as four frames, for an overview before the detail.
-
KB-104931
The agent opens the booking.
-
Glacier walk
On requestThey find the service still waiting.
-
Glacier walk
ConfirmedThe supplier’s answer is recorded.
-
Ready to confirm
The booking is confirmed to the agent.
<ol class="flux-storyboard">
<li class="flux-storyboard__frame">
<div class="flux-storyboard__screen">
<p class="flux-storyboard__screen-title">KB-104931</p>
<p class="flux-storyboard__screen-meta">1 service on request</p>
</div>
<p class="flux-storyboard__caption">The agent opens the booking.</p>
</li>
<li class="flux-storyboard__frame">
<div class="flux-storyboard__screen">
<p class="flux-storyboard__screen-title">Glacier walk</p>
<span class="flux-badge flux-badge--pending">On request</span>
</div>
<p class="flux-storyboard__caption">They find the service still waiting.</p>
</li>
<li class="flux-storyboard__frame">
<div class="flux-storyboard__screen">
<p class="flux-storyboard__screen-title">Glacier walk</p>
<span class="flux-badge flux-badge--confirmed">Confirmed</span>
</div>
<p class="flux-storyboard__caption">The supplier’s answer is recorded.</p>
</li>
<li class="flux-storyboard__frame">
<div class="flux-storyboard__screen">
<p class="flux-storyboard__screen-title">Ready to confirm</p>
<button class="flux-button flux-button--sm" type="button" tabindex="-1">Confirm booking</button>
</div>
<p class="flux-storyboard__caption">The booking is confirmed to the agent.</p>
</li>
</ol>Anatomy
| Part | Description |
|---|---|
| Walkthrough | An ordered list. Its container query stacks text over media below 44rem. |
| Step marker | A CSS counter in a surface-brand square, so the number comes from the list order. |
| Step text | A heading and a paragraph at the reading measure. |
| Media | A figure with a layer-02 frame holding real Flux components or a screenshot, and an optional caption. |
| Storyboard | An ordered grid of frames, each a bordered 4:3 screen and a caption numbered in brand mono. |
API
| Name | Kind | Description |
|---|---|---|
flux-walkthrough | class | On the ol of steps. It is the container for the narrow layout. |
flux-walkthrough__step | class | An li holding the text and the media. Its number comes from the list order. |
flux-walkthrough__text | __title | class | The step heading and its paragraphs. |
flux-walkthrough__media | __frame | class | The figure and the layer-02 frame that holds components or an image. |
flux-storyboard | class | On the ol of frames. Frames fill the row at 16rem minimum. |
flux-storyboard__frame | __screen | __caption | class | A frame, its 4:3 screen and its numbered caption. |
flux-storyboard__screen-title | __screen-meta | class | Text inside a schematic screen. |
States
| State | Treatment |
|---|---|
| Wide | Walkthrough text and media side by side, two to three. |
| Narrow | Below a 44rem container, media stacks under the text. |
Keyboard
| Keys | Action |
|---|---|
Tab | Reaches links in the text. Components in a frame are illustrations; give their controls tabindex="-1" or use a screenshot. |
Accessibility
- Both are ordered lists, so the step count and position are announced.
- Each step has a real heading, so the walkthrough can be navigated by headings.
- A screenshot in a frame needs alt text saying what it shows, not what it is.
Tokens
The tier-3 and tier-2 tokens this component binds to. Change the token, not the component.
- --flux-walkthrough-gap | -marker-size | -marker-bg | -marker-text
- --flux-walkthrough-media-bg | -media-padding
- --flux-storyboard-frame-width | -gap | -number
- --flux-storyboard-screen-bg | -screen-border | -screen-padding
Do and don’t
Do
- Show the real components in the frame, so the walkthrough stays true when they change.
- Keep one idea per step.
Don’t
- Do not number content where order is not the meaning; this is for sequences.
- Do not let a storyboard replace the walkthrough for people doing the task; it is the overview.