Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

Reset

Reset: () => void

Type declaration

    • (): void
    • Stops the animation and clears all confetti, as well as immediately resolves any outstanding promises.

      Returns void

Shape

Shape: "circle" | "square" | "star"

Variables

Promise

Promise: PromiseLike<undefined> | null | undefined

You can polyfill promises using any of the popular polyfills. You can also provide a promise implementation to confetti through this property.

Functions

create

  • This method creates an instance of the confetti function that uses a custom canvas.

    Parameters

    • Optional canvas: HTMLCanvasElement
    • Optional options: GlobalOptions

    Returns CreateTypes

reset

  • Returns Reset

Generated using TypeDoc