tsParticles Particles Effect

tsParticles additional particles effect.

How to use it

CDN / Vanilla JS / jQuery

The CDN/Vanilla version JS has one required file in vanilla configuration:

Including the tsparticles.effect.particles.min.js file will export the function to load the effect:

loadParticlesEffect

Usage

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

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

  await tsParticles.load({
    id: "tsparticles",
    options: {
      /* options */
      /* here you can use particles.effect.type: "particles" */
    },
  });
})();

ESM / CommonJS

This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:

$ npm install @tsparticles/effect-particles

$ yarn add @tsparticles/effect-particles

Then you need to import it in the app, like this:

const { tsParticles } = require("@tsparticles/engine");
const { loadParticlesEffect } = require("@tsparticles/effect-particles");

(async () => {
  await loadParticlesEffect(tsParticles);
})();

import { tsParticles } from "@tsparticles/engine";
import { loadParticlesEffect } from "@tsparticles/effect-particles";

(async () => {
  await loadParticlesEffect(tsParticles);
})();