# Voice Orb · Pro

A liquid voice orb: a glowing blob whose edge breathes with the voice level, two pigments swirling inside and a drifting highlight. Feed it a level or let it simulate idle, listening and speaking.

This is a Charcoal UI Pro component. Its source and examples are available with a Pro seat: https://charcoalui.com/pricing

## With a Pro seat

1. Add the registry to components.json:

```json
{
  "registries": {
    "@charcoal": {
      "url": "https://charcoalui.com/r/{name}.json",
      "headers": {
        "Authorization": "Bearer ${CHARCOAL_LICENSE_KEY}"
      }
    }
  }
}
```

2. Copy your licence key from https://charcoalui.com/dashboard and put it in .env.local as CHARCOAL_LICENSE_KEY, then:

```bash
npx shadcn@latest add @charcoal/voice-orb
```

To read Pro source through this MCP server, reconnect it with the header "Authorization: Bearer <licence key>".

## API — Voice Orb
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `state` | `"idle" \| "listening" \| "speaking"` | `"listening"` |  |
| `level` | `number` | — | 0 to 1; simulated when left out. |
| `size` | `number` | `180` |  |
| `color` | `string` | `"var(--ember)"` |  |
| `accent` | `string` | `"#a78bfa"` |  |

See it live: https://charcoalui.com/docs/components/voice-orb