# Warp Text · Pro

A wave of skew and scale travels through the letters of a word, once per hover or continuously.

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/warp-text
```

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

## API — Warp Text
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `text` | `string` | — |  |
| `strength` | `number` | `1` | Size of the distortion, 0 to 2. |
| `speed` | `number` | `1` |  |
| `trigger` | `"hover" \| "always"` | `"hover"` |  |
| `width` | `number` | `2.2` | Width of the wave in letters. |
| `className` | `string` | — |  |

See it live: https://charcoalui.com/docs/components/warp-text