tsParticles Confetti Preset

tsParticles preset for white and red confetti launched from the screen center on a transparent background.

Sample

Quick checklist

1. Load @tsparticles/engine
2. Call loadConfettiPreset(tsParticles) (or use the confetti bundle)
3. Set preset: "confetti" in options

How to use it

CDN / Vanilla JS / jQuery

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

Usage

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

tsParticles.load({
  id: "tsparticles",
  options: {
    preset: "confetti",
  },
});
Copy

Customization

tsParticles.load({
  id: "tsparticles",
  options: {
    particles: {
      color: {
        value: ["#ff0000", "#0000ff", "#00ff00", "#ffffff"],
      },
    },
    preset: "confetti",
  },
});
Copy

Like in the sample above, the default colors will be replaced by red, blue, lime and white.

Explosion

The preset has a single life explosion, with a short duration. The effect is immediate and ends few seconds after, but this can be customized too.

The confetti explosion is made using the Emitter plugin, which is already documented here.

These are the default explosion (emitter) options:

The default emitter options are these:

{
  "startCount": 50,
  "position": {
    "x": 50,
    "y": 50
  },
  "size": {
    "width": 0,
    "height": 0
  },
  "rate": {
    "delay": 0,
    "quantity": 0
  },
  "life": {
    "duration": 0.1,
    "count": 1
  }
}
Copy

Let's see how to create the most common types of explosion animations:

Long-lasting Explosion

To create a long-lasting explosion, the emitter life options need some changes.

The life.duration needs to be increased, the value is in seconds, so actually it lasts one tenth of a second.

If life.duration is set to 0, the explosion will last forever.

The life.count parameter instead can be changed as well, but the animation will last for the specified duration, life.count times, if the life.duration is set to 0, the life.count is ignored since its first life will last forever.

Sample

tsParticles.load({
  id: "tsparticles",
  options: {
    emitters: {
      life: {
        duration: 0,
      },
    },
    preset: "confetti",
  },
});
Copy

This will create an infinite explosion shooting confetti from the center of the canvas.

Immortal Explosion - Fireworks

To create a fireworks effect, or an immortal explosion, the emitter life options, again, need some changes.

The life.duration can be kept to the default short value, but the life.count is what we need to change.

For an immortal explosion we can change life.count to 0 and the emitter will continue respawning every life.delay seconds. Actually is not specified, if you want some delay between "explosions", set this value to something greater than 0.

For an improved effect, the position as well can be customized. For randomizing it, it can be set to {}, and it'll have a random position every "explosion". If a coordinate is set, that will be used everytime, as a percentage of the canvas size.

tsParticles.load({
  id: "tsparticles",
  options: {
    emitters: {
      life: {
        count: 0,
      },
      position: {
        // uncomment only one of these lines,
        // to have explosions on the x or y axis
        // centered on the other one
        // if everything is kept commented,
        // random positions will be used everytime the explosion fires
        // x: 50,
        // y: 50
      },
    },
    preset: "confetti",
  },
});
Copy

Multiple Explosions

Now that we have played with a single explosion, what about multiple ones?

This needs more customization since the explosions array will overwrite the existing options.

First let's start overriding the emitters (explosions) options placing an array instead of an object.

Like this:

tsParticles.load({
  id: "tsparticles",
  options: {
    emitters: [],
    preset: "confetti",
  },
});
Copy

If you test this, you won't see anything, because the emitters are set to an empty array, so there's nothing to show.

Now you can add emitters to the array, using the standard tsParticles emitters options.

Sample

tsParticles.load({
  id: "tsparticles",
  options: {
    emitters: [
      {
        life: {
          duration: 5,
          count: 1,
        },
        position: {
          x: 0,
          y: 30,
        },
        particles: {
          move: {
            direction: "top-right",
          },
        },
      },
      {
        life: {
          duration: 5,
          count: 1,
        },
        position: {
          x: 100,
          y: 30,
        },
        particles: {
          move: {
            direction: "top-left",
          },
        },
      },
    ],
    preset: "confetti",
  },
});
Copy

This samples creates two explosions, one on the left and one on the right of the canvas, at 30% of canvas height, shooting in opposite directions.

Frameworks with a tsParticles component library

Checkout the documentation in the component library repository and call the loadConfettiPreset 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

• Forgetting to load the preset before using preset: "confetti"
• Overriding emitters with an empty array and expecting default explosion behavior
• Combining many emitter changes at once without validating one step at a time

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]
pli[Interactivity]
plm[Motion]
end

bb --> pl

subgraph s [Shapes]
ssq[Square]
end

bb --> s

subgraph u [Updaters]
ul[Life]
urol[Roll]
urot[Rotate]
uti[Tilt]
uw[Wobble]
end

bb --> u

subgraph pr [Presets]
prc[Confetti]
end

bb & ple & pli & plm & ssq & ul & urol & urot & uti & uw --> prc
Copy