# Status Badge

Status badge with multiple states (success, pending, processing, error, shipped, delivered).

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).



<ComponentPreview name="status-badge" src="examples/status-badge-demo.tsx" />

## Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @mcpcn/status-badge
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps className="mb-0 pt-2">
      <Step>
        Install the component dependencies:
      </Step>

      ```bash
      npm install lucide-react
      ```

      <Step>
        Copy and paste the component into your project.
      </Step>

      <ComponentSource name="status-badge" title="components/ui/status-badge.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

## Usage [#usage]

```tsx
import {
  StatusBadge,
  StatusBadgeIcon,
  StatusBadgeLabel,
} from "@/components/ui/status-badge";
```

```tsx
<StatusBadge>
  <StatusBadgeIcon />
  <StatusBadgeLabel />
</StatusBadge>
```

## Composition [#composition]

Use the following composition to build an `StatusBadge`:

```text
StatusBadge
├── StatusBadgeIcon
└── StatusBadgeLabel
```

## OpenUI Integration [#openui-integration]

Install the OpenUI React packages.

```bash
pnpm add @openuidev/react-lang zod
```

Add `StatusBadge` to a component library and map it to the installed component.

```tsx showLineNumbers
import { createLibrary, defineComponent } from "@openuidev/react-lang";
import { z } from "zod/v4";

import {
  StatusBadge,
  StatusBadgeIcon,
  StatusBadgeLabel,
} from "@/components/ui/status-badge";

const OpenUIStatusBadge = defineComponent({
  name: "StatusBadge",
  description:
    "Status badge with multiple states (success, pending, processing, error, shipped, delivered).",
  props: z.object({}),
  component: () => (
    <StatusBadge>
      <StatusBadgeIcon />
      <StatusBadgeLabel />
    </StatusBadge>
  ),
});

export const status_badgeLibrary = createLibrary({
  root: "StatusBadge",
  components: [OpenUIStatusBadge],
});
```

For richer generated compositions, define the child primitives separately and connect them with `.ref` fields. See [Defining Components](https://www.openui.com/docs/openui-lang/defining-components) in the OpenUI documentation.

## json-render Integration [#json-render-integration]

Install the json-render React packages.

```bash
pnpm add @json-render/core @json-render/react zod
```

Add `StatusBadge` to a component catalog and map it to the installed component.

```tsx
import { defineCatalog } from "@json-render/core";
import { defineRegistry } from "@json-render/react";
import { schema } from "@json-render/react/schema";
import { z } from "zod";

import {
  StatusBadge,
  StatusBadgeIcon,
  StatusBadgeLabel,
} from "@/components/ui/status-badge";

export const catalog = defineCatalog(schema, {
  components: {
    StatusBadge: {
      props: z.object({}),
      description:
        "Status badge with multiple states (success, pending, processing, error, shipped, delivered).",
    },
  },
});

export const { registry } = defineRegistry(catalog, {
  components: {
    StatusBadge: () => (
      <StatusBadge>
        <StatusBadgeIcon />
        <StatusBadgeLabel />
      </StatusBadge>
    ),
  },
});
```

Use `catalog.prompt()` to constrain model output, then render the generated spec with the json-render React `Renderer`. See the [json-render Quick Start](https://json-render.dev/docs/quick-start) for the provider and streaming setup.

## API Reference [#api-reference]

See the [Base UI](https://base-ui.com/react/overview/quick-start) documentation for more information.