Skip to content

Status Glyph

A 10px shape per status (circle, bullseye for live, triangle, cross, half ring, square).

1.5 kB gzipSource Registry JSON

StatusGlyph playground

Props

status

Installation

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

The CLI writes components/ikada/status-glyph.tsx and merges the ikada theme into your CSS. Or take it from the package: import { StatusGlyph } from "@sproutboat/ikada";

Usage

import { StatusGlyph } from "@/components/ikada/status-glyph";

<StatusGlyph status="success" />

Examples

Shapes

Circle, triangle, cross, half ring and square. Decorative: always pair a glyph with a label.

Live

A bullseye for success that is serving traffic.

Pulse

While in progress. The half ring spins when motion is allowed.

Sprout

Grows up from its base and sends one ring out. Under reduced motion it fades in place.

Props

StatusGlyphProps
PropTypeDescription
toneStatusWhich status: sets the shape and the colour. Default neutral.
statusStatus@deprecated Use `tone`; removed in 0.3.0.
livebooleanSuccess that is serving traffic ("Live"): a bullseye instead of the solid "Ready" circle. Default `false`.
pulsebooleanPulses (a fade) while in progress; the building ring and its wedge spin when motion is allowed. Default `false`.
sproutbooleanSuccess or creation just happened: on mount the shape grows up from its base and sends one ring out. Only applies to success. Under reduced motion it fades in place. Default `false`.

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

Source: src/components/status-glyph.tsx