Skip to content

Status Dot

A status shape with its label, for lists and headers.

0.8 kB gzipSource Registry JSON

StatusDot playground

Ready

Props

status

Installation

npx shadcn@latest add https://sproutboat.com/ikada/r/status-dot.json

The CLI writes components/ikada/status-dot.tsx and merges the ikada theme into your CSS. It also installs the components it is built from: Status Glyph. Or take it from the package: import { StatusDot } from "@sproutboat/ikada";

Usage

import { StatusDot } from "@/components/ikada/status-dot";

<StatusDot status="success" label="Ready" />

Examples

Statuses

Each status has its own shape, so colour is never the only signal.
ReadyDNS pendingBuild failedBuildingPaused

Live

Success that is serving traffic gets its own bullseye, apart from the plain Ready circle.
Live 90%

Pulse

For in-progress states. The ring stops spinning when motion is reduced.
Building

Sprout

Success that just happened: the shape grows up and sends one ring out.
Deployed

Hidden label

Dense tables keep the label for screen readers and show only the shape.
Build failed

Props

StatusDotProps
PropTypeDescription
toneStatusWhich status: sets the shape and the colour. Default neutral.
statusStatus@deprecated Use `tone`; removed in 0.3.0.
labelrequiredstringRequired: a dot is never the only signal.
hideLabelbooleanKeeps the label for screen readers and hides it visually (dense tables). Default `false`.
livebooleanSuccess that is serving traffic ("Live 90%"): its own bullseye shape, not the "Ready" circle. Default `false`.
pulsebooleanPulses for in-progress states; the ring stops spinning when motion is reduced. Default `false`.
sproutbooleanSuccess that just happened: the shape sprouts on mount (grows up and sends one ring out). Default `false`.

Also takes every prop of Omit<ComponentProps<"span">, "children">.

Source: src/components/status-dot.tsx