# Liquid Metal · Pro

A ring of moving liquid metal around buttons, icons and badges: a wandering halo, a pool of reflected light, and a highlight that swings towards the cursor. Chromatic, silver and gold, plus metal text.

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/liquid-metal
```

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

## API — Send button
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `preset` | `"chromatic" \| "silver" \| "gold"` | `"chromatic"` |  |
| `variant` | `"button" \| "circle" \| "badge"` | `"button"` |  |
| `strength` | `number` | `0.9` | 0 to 1: brightness and opacity of the metal. |
| `thickness` | `number` | — | Ring thickness in px. 2.5, or 1.5 for badges. |
| `radius` | `number` | `14` | Corner radius for the button variant. |
| `glow` | `boolean` | `true` |  |
| `reflection` | `boolean` | `true` |  |
| `bend` | `boolean` | `true` | The highlight follows a nearby pointer. |
| `speed` | `number` | `1` |  |

## API — Text and badge
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `preset` | `MetalPreset` | `"chromatic"` |  |
| `duration` | `number` | `6` | Seconds per sweep. |

See it live: https://charcoalui.com/docs/components/liquid-metal