Skip to content
Statix Design System

Patterns · Dashboard

StatusChecklist

A card that lists the health checks of one website, each with a tick and a short result. It sits in the right column of the website page.

import { StatusChecklist } from '@statix/ui/status-checklist';

Examples

All good

Five checks, all passed.

How your website is doing

Last checked 4 minutes ago.

  • OK: Reachable No outages in the last 30 days
  • OK: Backed up Today, 03:10 · 30 backups
  • OK: Up to date WordPress and 6 plugins
  • OK: Virus protection No viruses, checked 02:40
  • OK: Encrypted Certificate renews on its own
<script lang="ts">
	import { StatusChecklist } from '@statix/ui/status-checklist';

	const checks = [
		{ label: 'Reachable', detail: 'No outages in the last 30 days' },
		{ label: 'Backed up', detail: 'Today, 03:10 · 30 backups' },
		{ label: 'Up to date', detail: 'WordPress and 6 plugins' },
		{ label: 'Virus protection', detail: 'No viruses, checked 02:40' },
		{ label: 'Encrypted', detail: 'Certificate renews on its own' }
	];
</script>

<div class="w-full max-w-[360px]">
	<StatusChecklist
		title="How your website is doing"
		description="Last checked 4 minutes ago."
		items={checks}
	/>
</div>

Something needs attention

Set status per item. warning and destructive swap the tick for an alert or a cross; pending shows a dashed circle. Add a footer for the next step.

How your website is doing

Last checked 4 minutes ago.

  • OK: Reachable No outages in the last 30 days
  • OK: Backed up Today, 03:10 · 30 backups
  • Needs attention: Up to date 1 plugin update needs your go-ahead
  • Pending: Virus protection Scan running, about 10 minutes
  • Problem: Encrypted Certificate expired yesterday
<script lang="ts">
	import { Button } from '@statix/ui/button';
	import { StatusChecklist, type StatusChecklistItem } from '@statix/ui/status-checklist';

	const checks: StatusChecklistItem[] = [
		{ label: 'Reachable', detail: 'No outages in the last 30 days' },
		{ label: 'Backed up', detail: 'Today, 03:10 · 30 backups' },
		{ label: 'Up to date', detail: '1 plugin update needs your go-ahead', status: 'warning' },
		{ label: 'Virus protection', detail: 'Scan running, about 10 minutes', status: 'pending' },
		{ label: 'Encrypted', detail: 'Certificate expired yesterday', status: 'destructive' }
	];
</script>

<div class="w-full max-w-[360px]">
	<StatusChecklist
		title="How your website is doing"
		description="Last checked 4 minutes ago."
		items={checks}
	>
		{#snippet footer()}
			<Button variant="outline" size="sm" href="#update">Review the update</Button>
		{/snippet}
	</StatusChecklist>
</div>

Guidelines

Do

  • Keep labels to one word where you can: "Reachable", "Backed up", "Up to date".
  • Put the proof in the detail: a time, a number or a date.
  • Say when the checks last ran in the description.

Don't

  • Don’t list more than six checks. Link to a details page instead.
  • Don’t hide failing checks at the bottom. Keep the order fixed so customers learn it.

Accessibility

  • The checks render as a <ul>, one <li> per check.
  • Each item starts with visually hidden status text ("OK:", "Needs attention:"). Override it with statusLabels, for example for German.
  • The title is an <h3> by default; set headingLevel to fit the page.

API reference

StatusChecklist

renders <div> (Card) and accepts its attributes
PropTypeDefault
title * string

Card heading.

–
description string

Line under the title.

–
items * { label: string; detail?: string; status?: StatusChecklistStatus }[]

The checks. status defaults to success.

–
headingLevel 2 | 3 | 4

Heading level of the title.

3
statusLabels Partial<Record<'success' | 'warning' | 'destructive' | 'pending', string>>

Screen reader text per status.

{ success: 'OK', warning: 'Needs attention', destructive: 'Problem', pending: 'Pending' }
footer Snippet

Content under the list, e.g. a Button.

–
ref bindHTMLDivElement | null

The root element.

–
class ClassValue

Merged with the card classes; yours win.

–
Data attributeMeaning
data-slot="status-checklist"Root. Parts use status-checklist-title, -description, -list, -item, -footer.
data-statusOn each item: its status.