# Ripple Distortion · Pro

Water over a photo: a height-field ripple simulation offsets every pixel by the local slope, so the pointer drags rings across the picture and a click drops a stone in. 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-distortion
```

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

## API — Ripple Distortion
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `src` | `string` | — |  |
| `alt` | `string` | — |  |
| `strength` | `number` | `0.6` |  |
| `damping` | `number` | `0.96` | How quickly ripples die out. |
| `radius` | `number` | `3` | Touch radius in simulation cells. |
| `resolution` | `number` | `160` | Simulation cells across; lower is faster. |
| `className` | `string` | — |  |

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