Skip to Content

Status Orb

Status indicator drawn as a small painted sphere: teal when ready, gold while building, ember red on error, gray while queued. Always carries a text label for screen readers; colors per status can be replaced.

Installation

pnpm dlx shadcn@latest add @01orbital/status-orb

Usage

import { StatusOrb } from "@/components/orbs/status-orb"

const STATUSES = [
  { status: "ready", label: "Ready" },
  { status: "building", label: "Building" },
  { status: "error", label: "Error" },
  { status: "queued", label: "Queued" },
] as const

export default function StatusOrbDemo() {
  return (
    <div className="grid min-h-full w-full flex-1 place-items-center bg-background p-8 text-foreground">
      <ul className="m-0 flex list-none flex-wrap items-center justify-center gap-x-8 gap-y-4 p-0">
        {STATUSES.map((item) => (
          <li key={item.status} className="flex items-center gap-2 text-sm/5">
            {/* The visible word carries the status, so the orb's own label stays silent. */}
            <StatusOrb status={item.status} label="" />
            {item.label}
          </li>
        ))}
      </ul>
    </div>
  )
}

This example installs with everything it uses:

pnpm dlx shadcn@latest add @01orbital/status-orb-demo

API reference

A status shown as a small painted sphere: teal when ready, gold while building, ember red on error, gray while queued. Color only ever means state here, and it never stands alone: the status is always in the text for screen readers (label), so pair the orb with a visible word where the reader needs one.

Prop

Type

It also accepts the HTML attributes of the element it renders.

Dependencies

npm: cn. The CLI installs it for you.

Requires these pieces. The CLI adds each one that is missing and won't replace a file you already have unless you choose to:

Used in blocks

2 blocks are built with Status Orb:

Last updated on