# Getting started

> A first-use checklist: each row one link to the next step, done rows checked.

- Group: Feedback
- Status: stable
- Aliases: onboarding, checklist
- HTML page: https://design.ipmnx.com/components/getting-started/
- Spec: https://design.ipmnx.com/design/#nx-getting-started

## Preview

**First steps**

```html
<section class="nx-getting-started">
  <h2 class="nx-getting-started__title">First steps</h2>
  <ol class="nx-getting-started__list">
    <li class="nx-getting-started__item">
      <a class="nx-getting-started__row" href="#brand">
        <span class="nx-getting-started__status
            nx-getting-started__status--done" aria-hidden="true">
          <svg width="12" height="12" viewBox="0 0 24 24"
              fill="none" stroke="currentColor" stroke-width="3"
              stroke-linecap="round" stroke-linejoin="round"
              aria-hidden="true" focusable="false">
            <path d="M20 6 9 17l-5-5" />
          </svg>
        </span>
        <span class="nx-getting-started__label
            nx-getting-started__label--done">Create brand</span>
        <svg class="nx-getting-started__arrow" width="16"
            height="16" viewBox="0 0 24 24" fill="none"
            stroke="currentColor" stroke-width="2"
            stroke-linecap="round" stroke-linejoin="round"
            aria-hidden="true" focusable="false">
          <path d="M5 12h14" />
          <path d="m12 5 7 7-7 7" />
        </svg>
      </a>
    </li>
    <li class="nx-getting-started__item">
      <a class="nx-getting-started__row" href="#accounts">
        <span class="nx-getting-started__status"
            aria-hidden="true"></span>
        <span
            class="nx-getting-started__label">Connect account</span>
        <svg class="nx-getting-started__arrow" width="16"
            height="16" viewBox="0 0 24 24" fill="none"
            stroke="currentColor" stroke-width="2"
            stroke-linecap="round" stroke-linejoin="round"
            aria-hidden="true" focusable="false">
          <path d="M5 12h14" />
          <path d="m12 5 7 7-7 7" />
        </svg>
      </a>
    </li>
  </ol>
</section>
```

```tsx
<NxGettingStarted
  title="First steps"
  items={[
    {
      label: "Create brand",
      href: "/marketing/brands",
      done: true,
    },
    { label: "Connect account", href: "/marketing/accounts" },
  ]}
/>
```

## API

### React props (NxKit)

| Prop | Type | Default | Required | Description |
| --- | --- | --- | --- | --- |
| `title` | `ReactNode` |   | yes | Card title. |
| `items` | `{ label; href?; done?; onClick? }[]` |   | yes | One step per row. |

### Classes

| Class | Description |
| --- | --- |
| `.nx-getting-started` | Card + ordered list |
| `.nx-getting-started__row` | One step: link, button or static row |
| `.nx-getting-started__status--done` | Check marker |

## Accessibility

- An ordered list of links; done state is text + check, not colour.

## Do / Don't

- Do: Order by what unblocks the most.
- Don't list more than ~6 steps.

## Related

- [Empty state](https://design.ipmnx.com/components/empty-state.md)
- [Card](https://design.ipmnx.com/components/card.md)

---

Source: registry.js (NX Design System)
