@tsparticles/preset-squares

tsParticles Squares Preset

tsParticles preset creating a squares effect with falling particles.

Sample

Quick checklist

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

How to use it

CDN / Vanilla JS / jQuery

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

Usage

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

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

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

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: "circle", // starting from v2, this require the circle shape script
      },
    },
    preset: "squares",
  },
});

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 loadSquaresPreset 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 loadSquaresPreset(tsParticles)
• The square shape is part of the bundle; when using engine-only builds, load the shape package separately
• The preset uses a transparent background by default; set background.color if you need a solid backdrop

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 Engine]
end

subgraph pl [Plugins]
ple[Emitters]
pli[Interactivity]
end

bb --> pl

subgraph s [Shapes]
ssq[Square]
end

bb --> s

subgraph u [Updaters]
urot[Rotate]
usi[Size]
usc[Stroke Color]
end

bb --> u

subgraph pr [Presets]
prsn[Squares]
end

bb & ple & pli & ssq & urot & usi & usc --> prsn