tsParticles External Particle Interaction

tsParticles interaction plugin for particle effect around mouse or HTML elements.

Quick checklist

1. Install @tsparticles/engine (or use the CDN bundle below)
2. Call the package loader function(s) before tsParticles.load(...)
3. Apply the package options in your tsParticles.load(...) config

How to use it

CDN / Vanilla JS / jQuery

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

Including the tsparticles.interaction.external.particle.min.js file will export the function to load the interaction plugin:

loadExternalParticleInteraction;
Copy

Usage

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

(async () => {
  await loadInteractivityPlugin(tsParticles);
  await loadExternalParticleInteraction(tsParticles);

  await tsParticles.load({
    id: "tsparticles",
    options: {
      /* options */
    },
  });
})();
Copy

ESM / CommonJS

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

$ npm install @tsparticles/interaction-external-particle
Copy

or

$ yarn add @tsparticles/interaction-external-particle
Copy

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

const { tsParticles } = require("@tsparticles/engine");
const { loadInteractivityPlugin } = require("@tsparticles/plugin-interactivity");
const { loadExternalParticleInteraction } = require("@tsparticles/interaction-external-particle");

(async () => {
  await loadInteractivityPlugin(tsParticles);
  await loadExternalParticleInteraction(tsParticles);
})();
Copy

or

import { tsParticles } from "@tsparticles/engine";
import { loadInteractivityPlugin } from "@tsparticles/plugin-interactivity";
import { loadExternalParticleInteraction } from "@tsparticles/interaction-external-particle";

(async () => {
  await loadInteractivityPlugin(tsParticles);
  await loadExternalParticleInteraction(tsParticles);
})();
Copy

Option mapping

• Event mode key: interactivity.events.onHover.mode or interactivity.events.onClick.mode with value "particle"
• Mode options key: interactivity.modes.particle

{
  "interactivity": {
    "events": {
      "onHover": {
        "enable": true,
        "mode": "particle"
      }
    },
    "modes": {
      "particle": {}
    }
  }
}
Copy

Common pitfalls

• Calling tsParticles.load(...) before loadInteractivityPlugin(...)
• Verify required peer packages before enabling advanced options
• Change one option group at a time to isolate regressions quickly

Related docs

• All packages catalog: https://github.com/tsparticles/tsparticles
• Main docs: https://particles.js.org/docs/