# Light Rays · Pro

Volumetric rays fanning out from one edge, swaying on slow noise and leaning toward the pointer. Rendered at a fifth of the size and upscaled, so the softness is free.

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/light-rays
```

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

## API — Light Rays
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `origin` | `"top" \| "top-left" \| "top-right" \| "left" \| "right"` | `"top"` | Edge the light comes from. |
| `color` | `string` | `"var(--ember)"` | Any CSS colour. |
| `speed` | `number` | `1` | Sway speed multiplier. |
| `spread` | `number` | `0.5` | Fan angle as a fraction of a half turn. |
| `length` | `number` | `0.9` | Reach as a fraction of the box diagonal. |
| `rays` | `number` | `14` |  |
| `followPointer` | `boolean` | `true` | The source leans toward the pointer. Mouse only; off under reduced motion. |

See it live: https://charcoalui.com/docs/components/light-rays