tsParticles External Parallax Interaction

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

loadExternalParallaxInteraction;

Usage

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

(async () => {
  await loadInteractivityPlugin(tsParticles);
  await loadExternalParallaxInteraction(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-parallax

$ yarn add @tsparticles/interaction-external-parallax

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

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

(async () => {
  await loadInteractivityPlugin(tsParticles);
  await loadExternalParallaxInteraction(tsParticles);
})();

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

(async () => {
  await loadInteractivityPlugin(tsParticles);
  await loadExternalParallaxInteraction(tsParticles);
})();