tsParticles - v4.0.0-beta.12
    Preparing search index...

    Module tsParticles Fireworks Preset - v4.0.0-beta.16

    banner

    tsParticles Fireworks Preset

    jsDelivr npmjs npmjs GitHub Sponsors

    tsParticles preset for fireworks effect.

    Discord Telegram

    tsParticles Product Hunt

    demo

    1. Install @tsparticles/engine (or use the CDN bundle below)
    2. Call loadFireworksPreset(tsParticles) before tsParticles.load(...)
    3. Set preset: "fireworks" in options
    <script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-fireworks@3/tsparticles.preset.fireworks.bundle.min.js"></script>
    

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

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

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

    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.

    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.

    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/effect-trail Adds a fading trail effect behind particles https://www.npmjs.com/package/@tsparticles/effect-trail
    @tsparticles/engine tsParticles engine and preset registration https://www.npmjs.com/package/@tsparticles/engine
    @tsparticles/plugin-emitters Spawns particles from configurable emitters https://www.npmjs.com/package/@tsparticles/plugin-emitters
    @tsparticles/plugin-emitters-shape-square Adds square emitter areas for launches/bursts https://www.npmjs.com/package/@tsparticles/plugin-emitters-shape-square
    @tsparticles/plugin-sounds Adds synchronized sound playback https://www.npmjs.com/package/@tsparticles/plugin-sounds
    @tsparticles/shape-line Adds line/spark particle shape https://www.npmjs.com/package/@tsparticles/shape-line
    @tsparticles/updater-destroy Removes particles when their stage ends https://www.npmjs.com/package/@tsparticles/updater-destroy
    @tsparticles/updater-life Controls particle life-cycle stages https://www.npmjs.com/package/@tsparticles/updater-life
    @tsparticles/updater-rotate Adds rotation animation https://www.npmjs.com/package/@tsparticles/updater-rotate

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

    • 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

    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
    

    Modules

    browser
    bundle
    index
    index.lazy
    options