# Orb · Pro

A glowing orb with a soft rim, a slowly turning inner swirl, a core that leans toward the pointer and a halo that brightens on hover.

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/orb
```

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

## API — Orb
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `size` | `number` | `0.7` | Fraction of the shorter side. |
| `hue` | `number` | `0` | Degrees away from ember. |
| `hoverIntensity` | `number` | `1` |  |
| `rotate` | `boolean` | `true` |  |
| `className` | `string` | — |  |

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