Function confetti

confetti(
idOrOptions: ConfettiFirstParam,
confettiOptions?: RecursivePartial<IConfettiOptions>,
): Promise<Container | undefined>
Parameters
- idOrOptions: ConfettiFirstParam
  the id used for the canvas, or if not using two parameters, the animation configuration object
- OptionalconfettiOptions: RecursivePartial<IConfettiOptions>
  the animation configuration object, this parameter is mandatory only if providing an id
Returns Promise<Container | undefined>
the container of the animation, or undefined if no canvas was found
- Defined in bundles/confetti/src/confetti.ts:91

Index

Properties

Methods

Properties

version

version: string

The confetti bundle version

Methods

create

create(
canvas?: HTMLCanvasElement | null,
options?: RecursivePartial<IConfettiOptions>,
): Promise<ConfettiFunc>
Parameters
- Optionalcanvas: HTMLCanvasElement | null
  The canvas
- options: RecursivePartial<IConfettiOptions> = {}
  The options to handle
Returns Promise<ConfettiFunc>
the confetti function to use for the given canvas animations
- Defined in bundles/confetti/src/confetti.ts:119

init

init(): Promise<void>
Initializes the confetti plugins without creating an animation

Returns Promise<void>
- Defined in bundles/confetti/src/confetti.ts:158