@tsparticles/preset-ambient

tsParticles Ambient Preset

tsParticles preset for ambient circles on a dark background.

Sample

Quick checklist

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

How to use it

CDN / Vanilla JS / jQuery

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

Usage

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

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

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

Customization

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.

Frameworks with a tsParticles component library

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.

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

• 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

Related docs

• All presets catalog: https://github.com/tsparticles/presets
• Color formats: https://github.com/tsparticles/tsparticles/blob/main/markdown/Color.md
• Main tsParticles docs: https://particles.js.org/docs/

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