@tsparticles/interaction-external-pause

tsParticles External Pause Interaction

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);
})();

Changelog

3.7.0 (2024-11-24)

Bug Fixes

• fixed issue in Firefox that caused the canvas to expand each frame (628a05d)

Features

• added new named color plugin, and hex color in the engine (c4db774)