@tsparticles/fireworks

tsParticles Fireworks Bundle

tsParticles fireworks bundle loads all the features necessary to create beautiful fireworks effects with ease.

Included Packages

• @tsparticles/engine
• @tsparticles/effect-trail
• @tsparticles/move-base
• @tsparticles/plugin-emitters
• @tsparticles/plugin-emitters-shape-square
• @tsparticles/plugin-sounds
• @tsparticles/shape-circle
• @tsparticles/shape-line
• @tsparticles/updater-color
• @tsparticles/updater-destroy
• @tsparticles/updater-life
• @tsparticles/updater-opacity
• @tsparticles/updater-out-modes
• @tsparticles/updater-rotate
• @tsparticles/updater-size
• @tsparticles/updater-stroke-color

How to use it

CDN / Vanilla JS / jQuery

The CDN/Vanilla version JS has two different files:

• One is a bundle file with all the scripts included in a single file
• One is a file including just the fireworks function to load the tsParticles fireworks bunddle, all dependencies must be included manually

Bundle

Including the tsparticles.fireworks.bundle.min.js file will out of the box.

This is the easiest usage, since it's a single file with all the features loaded.

You can still add additional packages, loading them like all the other packages.

Not Bundle

This installation requires more work since all dependencies must be included in the page. Some lines above are all specified in the Included Packages section.

Usage

Once the scripts are loaded you can set up tsParticles like the following examples:

** Easiest Way **

fireworks();

** Async Way, best practice **

(async () => {
  await fireworks();
})();

** Fireworks Options **

fireworks({
  colors: ["#ffffff", "#ff0000"],
});

Options

The fireworks has only a single options object parameter, with the following properties:

• background String: The background color of the canvas, it can be any valid CSS color, can be transparent as well.
• brightness Number or { min: number; max: number; }: The brightness offset applied to the particles color, from -100 to 100.
• colors String or Array<String>: An array of color strings, in the HEX format... you know, like #bada55.
• gravity Number or { min: number; max: number; }: The gravity applied to the fireworks particles.
• minHeight Number or { min: number; max: number; }: The minimum height for fireworks explosions (the lesser, the higher).
• rate Number or { min: number; max: number; }: The rate of the fireworks explosions.
• saturation Number or { min: number; max: number; }: The saturation offset applied to the particles color, from -100 to 100.
• sounds Boolean: Whether to play sounds or not.
• speed Number or { min: number; max: number; }: The speed of the fireworks particles.
• splitCount Number or { min: number; max: number; }: The number of particles to split the emitter in.