HelixOverviewComponentsMapsGraphIntroductionInstallationDeriving a themeSandboxTheme builderVisual testingCortexDocsEngramActiveTraceActiveRecallActiveServicesInsightsGet in touchSource on GitHub
Loading the reference
ConfettiView sourceEdit in SandboxView MarkdownCopy MarkdownOpen in ClaudeOpen in CursorBursts confetti out of its content, such as a button, once an action has finished.Also called Celebration, Party popper, and Success burst.ExperimentalSince 0.246.0ContentImportimport'@fusion.dev/helix/confetti'Preview
GuidelinesWhen to use
The end of a milestone, such as publishing a page or finishing onboarding.ConfettiThis page
Call burst() once the action has finished.A press does not burst by itself, because an action can still fail after it.
Say that the action is done in words as well, such as in a status message.A burst is decoration: a screen reader hears nothing, and reduced motion draws nothing.
API referenceRoothelix-confettiBursts confetti out of its content, such as a button, once an action has finished.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The content the confetti bursts out of.
MethodTypeDescriptionburst() => Promise<void>Bursts confetti out of the content, and resolves once the last piece is
gone. Call it once the action is done.
CSS PropertyDescription--confetti-colorsThe colors of the pieces, as a comma-separated list of CSS colors. Defaults to --helix-color-series-1 to --helix-color-series-6.
Custom stateDescriptionsettledSet one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
Examples
NameDescriptionColorsConfetti in the brand's colors, set with --confetti-colors, for finishing onboarding.PreviewConfetti bursts out of the button once the page is published, and a status message says so in words.