# Masked Heading · Pro

Letters are a window onto an image or gradient that pans slowly behind them, and the heading wipes in from the left. Without an image it falls back to a drifting ember and foreground gradient.

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/masked-heading
```

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

## API — Masked Heading
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `text` | `string` | — |  |
| `src` | `string` | — | Image URL seen through the letters. Omit for the gradient. |
| `speed` | `number` | `14` | Seconds for one full pan. |
| `direction` | `"left" \| "right" \| "up" \| "down"` | `"left"` |  |
| `wipe` | `boolean` | `true` | Wipe in from the left on mount. |
| `delay` | `number` | `0` | Seconds before the wipe. |
| `className` | `string` | — |  |

See it live: https://charcoalui.com/docs/components/masked-heading