@tsparticles/interaction-external-repulse
TypeScript icon, indicating that this package has built-in type declarations

3.3.0 • Public • Published

banner

tsParticles External Repulse Interaction

jsDelivr npmjs npmjs GitHub Sponsors

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

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.repulse.min.js file will export the function to load the interaction plugin:

loadExternalRepulseInteraction;

Usage

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

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

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

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-repulse

or

$ yarn add @tsparticles/interaction-external-repulse

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

const { tsParticles } = require("@tsparticles/engine");
const { loadExternalRepulseInteraction } = require("@tsparticles/interaction-external-repulse");

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

or

import { tsParticles } from "@tsparticles/engine";
import { loadExternalRepulseInteraction } from "@tsparticles/interaction-external-repulse";

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

Package Sidebar

Install

npm i @tsparticles/interaction-external-repulse

Weekly Downloads

21,003

Version

3.3.0

License

MIT

Unpacked Size

376 kB

Total Files

63

Last publish

Collaborators

  • matteobruni
  • ar3s