CheckList
The Raise-limit modal's rows: a lime ✓ pill and a sentence, on the soft .rowi. The tick is decoration.
import { CheckList } from '@ergasti/bricks';Examples
Check list
A list of what a change does; label names the list for screen readers.
Code
import { CheckList } from '@ergasti/bricks';
function Changes() {
return <div style={{ maxWidth: 420 }}><CheckList label="What changes" items={['You get 100 more seats right away', 'The new limit shows on the Creators page', 'Your plan price is updated at the next renewal']} /></div>;
}Nothing to list
With no items the list draws nothing, so say so yourself when a change has no effects to show.
Code
import { CheckList } from '@ergasti/bricks';
function Empty() {
const items: string[] = [];
return <div style={{ maxWidth: 420 }}>{items.length ? <CheckList label="What changes" items={items} /> : <p className="kit-muted">Nothing changes for your creators.</p>}</div>;
}Props
Prop
Type
Design guidance
How the BRICKS design system uses CheckList. Written in docs/content/components/CheckList.md; the props above are read from the code, which wins where the two disagree.
A short ticked list: a lime check chip and a sentence per row on soft tiles; use it to say what changes or what is included, typically inside a modal.
It is the Raise-limit modal's "What changes" list (the mock's openLimit()), under the two plan tiles. The tick is decoration; the list is named by label for assistive tech.
Anatomy
- List (
<ul class="kit-blk-rows kit-blk-check">,aria-label). - Row (
.kit-blk-rowi, the soft.rowitile, 12px block padding). - Tick (
kit-chip kit-chip--lime, "✓",aria-hidden). - Sentence: any node.
Variants
None: one look. For a list with values on the end, use RowItems.
States
| State | How |
|---|---|
| Default | items with sentences. |
| Empty | items=[]: an empty <ul> (renders nothing visible). Do not render it without items. |
| Long sentence | Wraps inside the tile; the tick stays at the start. |
Usage
<CheckList
label="What changes"
items={[
'Keep inviting without waiting for a seat to free up',
'Accept more join requests at once',
'Run bigger challenges with more creators',
'Your coupons, commission and wallet stay the same',
]}
/>// Creators › Raise your creator limit modal
<Modal open={open} onClose={close} title="Raise your creator limit" hint="What changes when you move to more seats"
footer={<Button variant="rasp" onClick={askTrndr}>Ask TRNDR about more seats</Button>}>
<div className="scr-grid scr-grid--2 scr-grid--keep">
<Tile size="short" tone="sky" label="Today" value="400 seats" delta="321 used · 79 left" />
<Tile size="short" tone="lime" label="Next plan" value="Ask TRNDR" delta="More seats, same rules" />
</div>
<CheckList label="What changes" items={changes} />
</Modal>Where it appears
- Brand › Creators › Raise your creator limit modal (
openLimit()), under the Today / Next plan tiles (gallery/screens/BrandSubScreens.tsx,raise-limit). Screen: Creators · A creator of yours.
Guidelines
Do
- Keep 3–5 short sentences, each a benefit or a fact.
- Write a visible heading or a modal hint near it that matches
label.
Don't
- Don't use it for tasks the user must tick: it is not interactive (use checkboxes).
- Don't mix in negatives with the same tick; say "stay the same" positively.
RTL and Arabic
- The tick moves to the right; sentences align right.
- Arabic items: "تفضل تدعي من غير ما تستنى مكان يفضى", "الكوبونات والعمولة والمحفظة زي ما هي".
Tokens
.kit-blk-rowi (--soft fill, --ink, radius 16, 12px 16px padding), kit-chip--lime (--lime fill, --olive ink).
Accessibility
<ul aria-label>; screen readers announce "What changes, list, 4 items".- The ✓ chip is
aria-hidden; the sentence carries the meaning.
Found in the source
- ARIA attributes set:
aria-label,aria-hidden.
Read from the component's source and tests. See Accessibility for the patterns the library follows.
Related
RowItems: soft rows with a value at the end.ModalandTile: its usual neighbours.AudiencePicker: a selectable checklist.
See also: CalloutCard · CopyLinkField · DrawerHead · ProgressRow
Source
src/blocks/shared/CheckList.tsx (line 5) on GitHub.