Skip to content

Setup checklist

A new account's first steps, each Done or To do, with how many are done beside the heading.

<div id="sc-started"><div data-mount="started"></div></div>

Installation

// package.json: "capsomer": "github:DrDustinEdwards/capsomer#v0.152.2"
import "capsomer/tokens.css";
import "capsomer/base.css";

Usage

import { SetupChecklist } from "capsomer/react/setup-checklist";
<SetupChecklist steps={[{ id: "connect", title: "Connect", done: false, action: <a href="/connect">Connect</a> }]}
  ready={{ title: "You're ready" }} />

Examples

All done

<div id="sc-done"><div data-mount="done"></div></div>

API reference

SetupChecklist

PropTypeRequiredDoes
titleReactNodeThe panel's heading. Default "Getting started".
stepsreadonly SetupStep[]Yes
ready{ title: ReactNode; detail?: ReactNode }The last row, done once every step is: "You're ready", and what happens now.
level2 | 3

Accessibility

KeyDoes
TabEach step's action, in order

The list is named by the panel's heading; each row's status is a word with a glyph.