@tsparticles/plugin-canvas-mask

tsParticles Canvas Mask Plugin

tsParticles plugin for particles canvas mask effect.

How to use it

CDN / Vanilla JS / jQuery

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

Including the tsparticles.plugin.canvas-mask.min.js file will export the function to load the plugin:

loadCanvasMaskPlugin;

Usage

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

(async () => {
  await loadCanvasMaskPlugin(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/plugin-canvas-mask

or

$ yarn add @tsparticles/plugin-canvas-mask

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

const { tsParticles } = require("@tsparticles/engine");
const { loadCanvasMaskPlugin } = require("@tsparticles/plugin-canvas-mask");

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

or

import { tsParticles } from "@tsparticles/engine";
import { loadCanvasMaskPlugin } from "@tsparticles/plugin-canvas-mask";

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