Package Exports

@tsparticles/preset-squares
@tsparticles/preset-squares/cjs/index.js
@tsparticles/preset-squares/esm/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@tsparticles/preset-squares) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

tsParticles Squares Preset

tsParticles preset creating a squares effect with falling particles.

Sample

How to use it

CDN / Vanilla JS / jQuery

<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-squares@3/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.

flowchart TD

e[tsParticles Engine]

subgraph pl [Plugins]
ple[Emitters]
end

e --> pl

subgraph s [Shapes]
ssq[Square]
end

e --> s

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

e --> u

subgraph pr [Presets]
prsn[Squares]
end

e & ple & ssq & urot & usi & usc --> prsn