This package has been deprecated

Author message:

starting from tsparticles v3 the packages are now moved to @tsparticles/package-name instead of tsparticles-package-name

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

2.12.0 • Public • Published

banner

tsParticles External Pause Interaction

jsDelivr npmjs npmjs GitHub Sponsors

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

loadExternalPauseInteraction;

Usage

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

(async () => {
  await loadExternalPauseInteraction(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-pause

or

$ yarn add tsparticles-interaction-external-pause

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

const { tsParticles } = require("tsparticles-engine");
const { loadExternalPauseInteraction } = require("tsparticles-interaction-external-pause");

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

or

import { tsParticles } from "tsparticles-engine";
import { loadExternalPauseInteraction } from "tsparticles-interaction-external-pause";

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

Dependents (3)

Package Sidebar

Install

npm i tsparticles-interaction-external-pause

Weekly Downloads

22,554

Version

2.12.0

License

MIT

Unpacked Size

296 kB

Total Files

17

Last publish

Collaborators

  • ar3s
  • matteobruni