Badge, Icon, Frame and Check
Small inline labels and icons, framed screenshots and check-marked lines.
Four small components for the details of a page: a coloured label in a line of text, an inline icon, a framed screenshot with a caption, and a line with a check mark.
Badge
A small coloured pill inside a sentence or a heading — Beta, Deprecated, Stable:
| Prop | Type | Default | Description |
|---|---|---|---|
tone | neutral | accent | ok | warn | bad | info | neutral | The pill's colour: ok green, warn amber, bad red, info blue. An unknown tone draws neutral |
color | green | red | orange | yellow | blue | gray | grey | — | A colour name instead of tone: green is ok, red is bad, orange and yellow are warn, blue is info, gray is neutral. tone wins when both are set |
The label is plain text: links or emphasis inside it are flattened.
Doc engine v2 only. A v1 site shows the label as plain text.
Icon
One icon inside a line of text:
| Prop | Type | Default | Description |
|---|---|---|---|
icon | string | — | A name from the icon set. name is another spelling; icon wins when both are set |
size | number | 15 | Size in pixels |
An unknown name draws nothing.
Doc engine v2 only. A v1 site draws nothing.
Frame
A bordered frame around a screenshot, with an optional caption underneath:
| Prop | Type | Description |
|---|---|---|
caption | string | Text shown under the frame |
The published site shows the image inside the frame, with the caption below.
Check
A line with a check mark beside it — to confirm what the reader should see once a step worked:
<Check> has no props; its body is Markdown.
<Frame> and <Check> are styled on doc engine v2. A v1 site shows their
content unstyled.