Confetti
Tumbling ember confetti from any point, drawn on a throwaway canvas. It does nothing under reduced motion.
- Category: Feedback
- Licence: Charcoal UI Pro
- Built with: React 19, Tailwind CSS 4, Motion
- Dependencies: motion, clsx, tailwind-merge
Examples
Confetti
API reference
| Prop | Type | Default | Description |
|---|---|---|---|
fireConfetti(options) | { x?, y?, count?, colors?, spread? } | — | |
<ConfettiButton options> | ComponentProps<"button"> | — | Bursts from the button's centre. |
About Confetti
Confetti fires tumbling accent confetti from any point, drawn on a canvas that is created for the burst and removed after, so it costs nothing at rest.
Confetti is a feedback component for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.
When to use Confetti
- Purchase and sign-up success.
- Completing onboarding or a course.
- Milestones and achievements.
- Celebrating a shipped feature.
How it works
fireConfetti takes an origin and options; particles have gravity, drag and spin. Under reduced motion it does nothing at all.
State changes are announced through live regions or the right ARIA roles, so screen-reader users hear what sighted users see. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.
Customizing Confetti
Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.
The Customize panel next to the preview lets you change label live, and the Code tab updates to match, so the snippet you copy already carries your values.
- fireConfetti(options).
- <ConfettiButton options> (ComponentProps<"button">): Bursts from the button's centre.
Goes well with Confetti
These feedback pieces share its tokens and motion language, so they sit together on one page without clashing.
- Typing Indicator: A React typing indicator: a bubble with rippling dots that tells screen readers who is typing
- Countdown: An animated React countdown timer whose digits roll as they tick
- Ripple: A React press ripple that spreads from the exact point you pressed
- Success Check: A React spinner that resolves into a drawn check or a shaking cross
- Story Progress: React story progress bars like Instagram: segmented, auto-advancing, pausable
Install Confetti
npx shadcn@latest add @charcoal/confettiConfetti is part of Charcoal UI Pro. One seat unlocks all 300 Pro components, 107 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies confetti.tsx into components/ui and installs clsx, tailwind-merge.
You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.
See Charcoal UI Pro pricing · Pro setup
Frequently asked questions
- How do I fire confetti from a button?
- Call fireConfetti with the button's position as the origin, usually in its onClick. Each burst creates and removes its own canvas.
- How do I install Confetti?
- Confetti is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/confetti. It copies confetti.tsx into components/ui and installs motion, clsx, tailwind-merge.
- Is Confetti free for commercial use?
- Confetti needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
- Does Confetti work with Next.js?
- Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
- Can an AI coding agent install Confetti?
- Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Confetti's props and get_install_command returns the exact command.