Report, steps


Install
npx shadcn add https://ui.klarhimmel.com/r/report-steps.jsonDetailsAbout, usage, props and more
Steps for the reader to do, in order: the next one open and loud with a button to where it happens, what it unlocks and its time; done steps fold to one line, later…
Import
Import
- report/steps
- About
- Steps for the reader to do, in order: the next one open and loud with a button to where it happens, what it unlocks and its time; done steps fold to one line, later ones are small.
- Category
- A document for a reader: key figures, decisions with a recommended default, long-cell tables, timelines, callouts, sources and prose. Rendered to one HTML file by kh-report. New project? Set it up once: /get-started/installation.
Notes
When to use it
Things for the reader to do, in order: one action per card with where it happens, what it unlocks and its time. The next step is open and loud, done steps fold to one line, later ones stay small. Use report-decisions when the reader has to choose between options, and report-timeline for what already happened.
Writing for it
- Start each step with one imperative sentence (240 characters). It is the card's heading and the only line a later step shows, so it must say the whole action. - Put an https address in href so the card gets a button that opens it (where is for a place said in words), and write says as the exact words the owning seat waits for: Done sends them as they are. - Give each step its own seat when different seats own them; that seat receives the answer, not the page's author.
Watch out for
A step without an id is only shown, with no Done and no findings field. Keep the list short and ordered by what unlocks the most; a page with twelve equal steps reads as a backlog, not a next move.
Pairs well with
Usage
The block in a page, with its default content (long lists shortened). Every prop is in the table below.
Props
The type, default and text limit of every prop. On a real page, over-limit text is kept and checkSections flags it (Installation, Check a page before you ship); this live preview shows the default until it fits. The panel above edits all props.
| Prop | Type | Default | Description |
|---|---|---|---|
title | string | 'Name the sequence' | Text, up to 100 characters. |
lead | string | '' | Text, up to 400 characters. |
items | { action, href, where, unlocks, time, says, id, version, seat, repo, session, as | 2 items | List of 1 to 12. Each item: action, href, where, unlocks, time, says, id, version, seat, repo, session, askedAt. |
headingLevel | '1' | '2' | - | One of '1', '2'. Optional; empty is not rendered. |