@tsparticles/preset-squares
TypeScript icon, indicating that this package has built-in type declarations

3.1.0 • Public • Published

banner

tsParticles Squares Preset

jsDelivr npmjs npmjs GitHub Sponsors

tsParticles preset creating a squares effect with falling particles.

Slack Discord Telegram

tsParticles Product Hunt

Sample

demo

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

Package Sidebar

Install

npm i @tsparticles/preset-squares

Weekly Downloads

2

Version

3.1.0

License

MIT

Unpacked Size

690 kB

Total Files

25

Last publish

Collaborators

  • matteobruni
  • ar3s