control · Canvas 2D
FireworkRating
A five-star rating that is a real radio group; each star you choose goes up as a firework.
Five-star rating as a real radio group; hover previews, and each chosen star bursts as a firework
- Canvas 2D
- Reduced motion: static
- 3.59 KB gzip
- Layout shift 0
Install
pnpm dlx shadcn@4.21.1 add @frictionborn/firework-rating
Playground
import { FireworkRating } from "@/components/ui/firework-rating";
<FireworkRating />In a full example
The full example loads as you scroll to it.
Accessibility
- role=radiogroup with a name and five native buttons with role=radio, aria-checked and names ("3 stars"); one tab stop. The word for the rating is aria-live=polite. Unlit stars keep 3:1 against the dark ground. The firework canvas is aria-hidden.
- Keyboard: A radio group with roving focus: arrows move and rate (Right/Up up, Left/Down down)
- Touch: Tap rates
- WCAG criteria it is built for: 1.3.1, 1.4.11, 2.1.1, 4.1.2, 4.1.3
Props
| Prop | Type | Default | What it does |
|---|---|---|---|
value | number | none | Controlled rating, 0 (not rated) to 5. |
defaultValue | number | 0 | Initial rating when uncontrolled. |
onValueChange | (value: number) => void | none | Called with the new rating. |
label | string | "Rating" | Accessible name of the radio group. |
words | [string, string, string, string, string, string] | null | "[\"Not rated\", \"Poor\", \"Fair\", \"Good\", \"Great\", \"Spectacular\"]" | Words for 0-5 stars, shown and announced; null hides them. |
palette | "fire" | "ice" | "neon" | "mono" | "custom" | "fire" | Colours of the effect (DESIGN.md A8). custom reads --fb-heat-0..4 from the page. |
paused | boolean | false | Universal pause prop: the effect stops drawing; the control keeps working. |
maxTier | number | 3 | Hard ceiling on the capability tier. |
nonce | string | none | CSP nonce for the component's <style> element. |
className | string | "" | Extra classes on the root. |
style | React.CSSProperties | none | Inline styles on the root, merged after the palette variables. |
ref | React.Ref<HTMLDivElement> | none | Receives the root element. |
Measured on the bench
Measured by the automated bench at commit 801163e on 2026-10-21. These numbers are written by the bench, never by hand.
| Measure | Result |
|---|---|
| Size, gzip | 3.59 KB at load, 0.02 KB loaded later |
| Layout shift | 0 |
| Frames when nothing should move | off screen 0, hidden tab 0, reduced motion 0 |
| axe accessibility scan | 0 serious, 0 critical |
Browsers it ran in
Automated Playwright runs, some with device emulation. Results from physical phones and tablets are still pending, so none are listed.
| Environment | Tier | Result | Date | Notes |
|---|---|---|---|---|
| Chromium Desktop (SwiftShader) | 3 | pass | 2026-10-21 | 16 passed, 0 failed |
| Chromium Mobile (Pixel 7 emulation) | 2 | pass | 2026-10-21 | 15 passed, 0 failed |
| Firefox Desktop | 3 | pass | 2026-10-21 | 14 passed, 0 failed |
| WebKit Desktop | 3 | pass | 2026-10-21 | 15 passed, 0 failed |
| WebKit Mobile (iPhone 14 emulation) | 2 | pass | 2026-10-21 | 15 passed, 0 failed |
On different devices
Reduced motion (static): The stars light up without bursts; no canvas.
| Tier | What it does |
|---|---|
| T3 Full | Effect on a canvas at DPR <= 2 with the full particle count |
| T2 Standard | Effect on a canvas at DPR <= 1.5 with half the particles |
| T1 Lite | Same as tier 2 |
| T0 Static | The control alone (server render, reduced motion, Save-Data, no WebGL2): no canvas |
Content Security Policy
- Works without
'unsafe-eval'. - Uses the reveal gate (
[data-motion="ok"]): render<MotionReadyScript />in<head>(with yournonce), or callinitMotionReady()in Vite. - Sets inline
styleattributes, so allowstyle-src-attr 'unsafe-inline'.