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

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

    banner

    tsParticles Fountain Preset

    jsDelivr npmjs npmjs GitHub Sponsors

    tsParticles preset creating random positioned falling colored particles that break when hitting the ground.

    Discord Telegram

    tsParticles Product Hunt

    demo

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

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

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

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

    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: "fountain",
    },
    });

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

    Checkout the documentation in the component library repository and call the loadFountainPreset 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/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-trail Adds persistent canvas trail rendering https://www.npmjs.com/package/@tsparticles/plugin-trail
    @tsparticles/updater-destroy Removes particles when their stage ends https://www.npmjs.com/package/@tsparticles/updater-destroy

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

    • Calling tsParticles.load(...) before loadFountainPreset(tsParticles)
    • Changing particle shape without loading the corresponding shape package
    • The fountain effect uses emitters; overriding emitters will replace the default fountain behavior

    flowchart TD
    
    subgraph b [Bundles]
    bb[tsParticles Basic]
    end
    
    subgraph pl [Plugins]
    ple[Emitters]
    pli[Interactivity]
    plt[Trail]
    end
    
    bb --> pl
    
    subgraph u [Updaters]
    ud[Destroy]
    end
    
    bb --> u
    
    subgraph pr [Presets]
    prfo[Fountain]
    end
    
    bb & ple & pli & plt & ud --> prfo
    

    Modules

    browser
    bundle
    index
    index.lazy
    options