Function fireworks

fireworks(
idOrOptions?: string | RecursivePartial<IFireworkOptions>,
sourceOptions?: RecursivePartial<IFireworkOptions>,
): Promise<FireworksInstance | undefined>
Parameters
- OptionalidOrOptions: string | RecursivePartial<IFireworkOptions>
  the id used for displaying the animation, or the animation configuration if an id is not necessary
- OptionalsourceOptions: RecursivePartial<IFireworkOptions>
  the animation configuration if an id is provided
Returns Promise<FireworksInstance | undefined>
the loaded instance
- Defined in bundles/fireworks/src/fireworks.lazy.ts:99

Index

Properties

Methods

Properties

version

version: string

The fireworks bundle version

Methods

create

create(
canvas?: HTMLCanvasElement | null,
options?: RecursivePartial<IFireworkOptions>,
): Promise<FireworksInstance | undefined>
Creates a fireworks animation on the given canvas
Parameters
- Optionalcanvas: HTMLCanvasElement | null
  The canvas
- Optionaloptions: RecursivePartial<IFireworkOptions>
  The options to handle
Returns Promise<FireworksInstance | undefined>
A promise
- Defined in bundles/fireworks/src/fireworks.lazy.ts:124

init

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

Returns Promise<void>
- Defined in bundles/fireworks/src/fireworks.lazy.ts:136