tsParticles Confetti Parade Preset

tsParticles preset for a draggable confetti parade, using the confetti palette.

Sample

Quick checklist

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

How to use it

CDN / Vanilla JS / jQuery

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

Usage

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

(async engine => {
  await loadConfettiParadePreset(engine);

  await engine.load({
    options: {
      preset: "confettiParade", // or "confetti-parade"
    },
  });
})(tsParticles);

Customization

tsParticles.load({
  id: "tsparticles",
  options: {
    particles: {
      color: {
        value: ["#0000ff", "#00ff00"],
      },
    },
    preset: "confettiParade", // or "confetti-parade"
  },
});

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

Frameworks with a tsParticles component library

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

| Package | Role in this preset | README | | ------------------------------- | --------------------------------------------- | ------------------------------------------------------------- | | @tsparticles/basic | Base runtime bundle used by the preset | https://www.npmjs.com/package/@tsparticles/basic | | @tsparticles/engine | tsParticles engine and preset registration | https://www.npmjs.com/package/@tsparticles/engine | | @tsparticles/palette-confetti | Default confetti color palette | https://www.npmjs.com/package/@tsparticles/palette-confetti | | @tsparticles/plugin-emitters | Spawns particles from configurable emitters | https://www.npmjs.com/package/@tsparticles/plugin-emitters | | @tsparticles/plugin-motion | Handles reduced-motion accessibility settings | https://www.npmjs.com/package/@tsparticles/plugin-motion | | @tsparticles/shape-square | Adds square particle shape | https://www.npmjs.com/package/@tsparticles/shape-square | | @tsparticles/updater-life | Controls particle life-cycle stages | https://www.npmjs.com/package/@tsparticles/updater-life | | @tsparticles/updater-roll | Adds rolling spin motion | https://www.npmjs.com/package/@tsparticles/updater-roll | | @tsparticles/updater-rotate | Adds rotation animation | https://www.npmjs.com/package/@tsparticles/updater-rotate | | @tsparticles/updater-tilt | Adds tilt animation | https://www.npmjs.com/package/@tsparticles/updater-tilt | | @tsparticles/updater-wobble | Adds side-to-side wobble motion | https://www.npmjs.com/package/@tsparticles/updater-wobble |

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

Common pitfalls

• Calling tsParticles.load(...) before loadConfettiParadePreset(engine)
• Overriding emitters with an empty array and expecting default parade behavior
• Mixing incompatible movement directions when extending the parade emitters

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]
    prcc[Confetti Parade]
  end

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