# Confetti · Pro

Tumbling ember confetti from any point, drawn on a throwaway canvas. It does nothing under reduced motion.

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/confetti
```

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

## API — Confetti
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `fireConfetti(options)` | `{ x?, y?, count?, colors?, spread? }` | — |  |
| `<ConfettiButton options>` | `ComponentProps<"button">` | — | Bursts from the button's centre. |

See it live: https://charcoalui.com/docs/components/confetti