# Orbit Images · Pro

Images orbit a centre on concentric rings, each ring at its own speed and direction. Hovering a ring pauses it and lifts the image under the pointer.

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/orbit-images
```

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

## API — Orbit Images
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `images` | `string[]` | — |  |
| `rings` | `number` | `2` |  |
| `speed` | `number` | `20` | Seconds per revolution of the inner ring. |
| `radius` | `number` | `90` | Inner ring radius in px; each ring adds the same again. |
| `size` | `number` | `48` |  |
| `children` | `ReactNode` | — | Sits at the centre. |
| `className` | `string` | — |  |

See it live: https://charcoalui.com/docs/components/orbit-images