@tsparticles/preset-fireworks

tsParticles Fireworks Preset

tsParticles preset for fireworks effect.

Sample

Quick checklist

1. Install @tsparticles/engine (or use the CDN bundle below)
2. Call loadFireworksPreset(tsParticles) before tsParticles.load(...)
3. Set preset: "fireworks" in options

How to use it

CDN / Vanilla JS / jQuery

<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-fireworks@4/tsparticles.preset.fireworks.bundle.min.js"></script>

Usage

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

(async () => {
  await loadFireworksPreset(tsParticles);

  await tsParticles.load({
    id: "tsparticles",
    options: {
      preset: "fireworks",
    },
  });
})();

Customization

Important ⚠️ You can override all the options defining the properties like in any standard tsParticles installation.

tsParticles.load({
  id: "tsparticles",
  options: {
    particles: {
      shape: {
        type: "square", // starting from v2, this require the square shape script
      },
    },
    preset: "fireworks",
  },
});

Like in the sample above, the circles will be replaced by squares.

Frameworks with a tsParticles component library

Checkout the documentation in the component library repository and call the loadFireworksPreset function instead of loadFull, loadSlim or similar functions.

The options shown above are valid for all the component libraries.

Dependencies

This preset loads and combines the following packages:

If you want to customize one specific behavior, start from the related package README above.

Common pitfalls

• Calling tsParticles.load(...) before loadFireworksPreset(tsParticles)
• Changing particle shape to one not included in the bundle without importing the shape package
• Forgetting that the fireworks preset requires emitter, sounds, and trail packages — use the bundle to avoid missing dependencies

Related docs

• All presets catalog: https://github.com/tsparticles/presets
• Emitter options: https://particles.js.org/docs/classes/Plugins_Emitters_Options_Classes_Emitter.Emitter.html
• Main tsParticles docs: https://particles.js.org/docs/

flowchart TD

subgraph b [Bundles]
bb[tsParticles Basic]
end

subgraph pl [Plugins]
ple[Emitters]
plis[Emitters Shape Square]
plh[Hex Color]
plhs[HSL Color]
pli[Interactivity]
plr[RGB Color]
pls[Sounds]
end

bb --> pl

subgraph ef [Effects]
eft[Trail]
end

bb --> ef

subgraph s [Shapes]
sl[Line]
end

bb --> s

subgraph u [Updaters]
ud[Destroy]
ul[Life]
ur[Rotate]
ust[Stroke Color]
end

bb --> u

subgraph pr [Presets]
prfw[Fireworks]
end

bb & ple & plis & plh & plhs & pli & plr & pls & eft & sl & ud & ul & ur & ust --> prfw