Ballmac UI home

ConfettiPRO

Confetti in your theme colors: fireConfetti(), a useConfetti() hook that fires from an element, and a ConfettiButton. Presets for burst, side cannons, stars and fireworks; nothing fires under reduced motion.

acme-web

main · 8f3c2a1

Ready to ship 3 commits to production.

Installation

  1. Get a Pro licence key.

    The source is part of Ballmac UI Pro.

    Log in with your licence key to read and copy it here, or install it through the shadcn CLI or the MCP server. You own the code once it is in your project.

    $49 once regular price $99for this and every other Pro item. Tax included.Money back if it does not work.

  2. Once per project: add the Pro registry and your licence key.

    components.json
    {
      "registries": {
        "@ballmac": "https://ui.ballmac.com/r/{name}.json",
        "@ballmac-pro": {
          "url": "https://ui.ballmac.com/r/pro/{name}.json",
          "headers": { "Authorization": "Bearer ${BALLMAC_LICENSE_KEY}" }
        }
      }
    }
    .env.local
    BALLMAC_LICENSE_KEY=your-licence-key
  3. Add it.

    $ pnpm dlx shadcn@latest add @ballmac-pro/confetti

Usage

import { ConfettiButton, fireConfetti, useConfetti } from "@/components/ballmac/confetti"

The full example is in the Code tab above.

Examples

Presets

API reference

PropTypeDefault
options

Confetti options; the burst starts from the button unless `origin` is set.

Omit<FireConfettiOptions, "element">—

Also accepts the standard attributes of its root element.

Quality scorecard

7/7

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.

How we measure
  • Passed: Accessibility scan

    No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).

  • Passed: Small screens

    No sideways scrolling at 360, 390 or 1280 px wide.

  • Passed: Reduced motion

    No endless animation to begin with.

  • Passed: Right to left

    Mirrors correctly in Arabic, Hebrew, Persian and Urdu layouts (0% of elements off the mirror, limit 15%).

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Passed: Keyboard

    5 tab stops, each showing a visible change when it takes focus.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • Passed: Automated tests

    Covered by confetti.test.tsx.

  • For information: Footprint

    2.0 KB of source (gzip) in 1 file. Installs canvas-confetti, class-variance-authority.

Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.

Use with AI

Call fireConfetti({ preset, colors, element }) from an event handler, or useConfetti().fireFrom(buttonRef.current) after an async success. <ConfettiButton options={{ preset: "stars" }}> is a Ballmac button that bursts from itself on click. Colors default to --chart-1…5. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI Confetti (@ballmac-pro/confetti) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • Rewarding a finished milestone: first deploy, upgrade, completed onboarding
  • Success states after a long async action
  • Playful marketing buttons (sparingly)

Not for

  • Routine actions such as saving a form (use a toast or inline check)
  • As the only success signal; always show a text confirmation too

Registry JSON (needs your licence key): https://ui.ballmac.com/r/pro/confetti.json

Credits

Covered by the Ballmac UI Pro license.