# Ripple Grid · Pro

A grid of lines that ripples outward from the pointer and from periodic pulses. Each ring pushes the vertices radially, and the lines nearest a crest take the accent colour. Canvas 2D.

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/ripple-grid
```

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

## API — Ripple Grid
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `cell` | `number` | `32` | Grid spacing in px. |
| `speed` | `number` | `1` | Wave travel speed and pulse rate multiplier. |
| `amplitude` | `number` | `10` | Peak displacement in px. |
| `color` | `string` | `"var(--ember)"` | Any CSS colour for the lit lines. |
| `glow` | `boolean` | `true` | Soft halo under the lit lines. |
| `className` | `string` | — |  |

See it live: https://charcoalui.com/docs/components/ripple-grid