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

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

    banner

    tsParticles Ambient Preset

    jsDelivr npmjs npmjs GitHub Sponsors

    tsParticles preset for ambient circles on a dark background.

    Discord Telegram

    tsParticles Product Hunt

    demo

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

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

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

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

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

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

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

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

    • Calling tsParticles.load(...) before loadAmbientPreset(tsParticles)
    • Changing particle shape without loading the corresponding shape package
    • The ambient preset uses soft slow-moving particles; high speed overrides will break the ambient feel

    flowchart TD
    
    subgraph b [Bundles]
    bb[tsParticles Basic]
    end
    
    subgraph u [Updaters]
    usc[Stroke Color]
    end
    
    bb --> u
    
    subgraph pr [Presets]
    prbi[Ambient]
    end
    
    bb & usc --> prbi
    

    Modules

    browser
    bundle
    index
    index.lazy
    options