Preview

Controls

Theme

Surface

Direction

Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal

php artisan ui:add confetti

Behavior layer (Alpine)

This component installs a self-registering Alpine module to resources/js/ui/confetti.js. Import the behavior layer once from your bundle so it loads (it hooks alpine:init):

resources/js/ui/index.js JS

import './confetti.js';

Registry contract

Install confidence

php artisan ui:add confetti writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version: 1.0.0
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/confetti.blade.php
js	resources/js/ui/confetti.js

Registry dependencies

button

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Celebration effect

Celebrate a meaningful completion moment.

Use when

Use sparingly to celebrate significant completion or add a memorable moment. Do not inject celebration into routine high-frequency workflows or serious contexts.

Avoid when

Avoid using confetti as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.

Task length: micro
Interaction cost: low
Interruptiveness: medium
Input precision: none
Mobile / touch risk: medium
Accessibility risk: high
Needs background context: No
Comparison needed: No

Preferred alternatives

Concise success message

Anti-patterns

Celebration in routine, serious, or high-frequency workflows

Related: button

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
label	mixed\|null	null	Declared by @props in the registry Blade source.
count	int	90	Declared by @props in the registry Blade source.
spread	int	70	Declared by @props in the registry Blade source.
colors	string	primary,secondary,accent,success,warning	Declared by @props in the registry Blade source.

Slots

default — Primary Blade slot rendered by the component.

Data slots

confetti

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized reducedMotion

Behavior

Uses server-rendered Blade and semantic HTML.
Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized, reducedMotion.

Usage

previews.components.confetti.default.blade.php Blade

<div class="flex h-56 w-full max-w-md items-center justify-center rounded-lg border border-border bg-card">
    <x-ui.confetti label="Celebrate" />
</div>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels

Accessibility target: wcag-2.2-aa-target.
Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
Focus-visible rings use the ring token so keyboard focus is always visible.
Disabled and invalid states are conveyed to assistive tech, not by color alone.
Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.0.0. See the site changelog for the full release history.

Confetti