# Swarm Cursor · Pro

A flock of small dots chases the pointer with simple boid rules (chase, cohesion, separation) and idles in a slow orbit when the pointer leaves. Each dot trails a short streak along its velocity.

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/swarm-cursor
```

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

## API — Swarm Cursor
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `children` | `ReactNode` | — |  |
| `count` | `number` | `28` | Dots in the flock. |
| `speed` | `number` | `1` | Multiplier on acceleration and top speed. |
| `color` | `string` | `"var(--ember)"` | Any CSS colour. |
| `size` | `number` | `2.4` | Dot radius in px. |
| `className` | `string` | — |  |

See it live: https://charcoalui.com/docs/components/swarm-cursor