tsParticles Background Mask Plugin

tsParticles plugin for handling background mask feature.

Quick checklist

1. Install @tsparticles/engine (or use the CDN bundle below)
2. Call the package loader function(s) before tsParticles.load(...)
3. Apply the package options in your tsParticles.load(...) config

How to use it

CDN / Vanilla JS / jQuery

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

Including the tsparticles.plugin.backgroundMask.min.js file will export the function to load the plugin:

loadBackgroundMaskPlugin;
Copy

Usage

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

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

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

ESM / CommonJS

This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:

$ npm install @tsparticles/plugin-background-mask
Copy

or

$ yarn add @tsparticles/plugin-background-mask
Copy

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

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

(async () => {
  await loadBackgroundMaskPlugin(tsParticles);
})();
Copy

or

import { tsParticles } from "@tsparticles/engine";
import { loadBackgroundMaskPlugin } from "@tsparticles/plugin-background-mask";

(async () => {
  await loadBackgroundMaskPlugin(tsParticles);
})();
Copy

Option mapping

• Primary options key: backgroundMask

{
  "backgroundMask": {}
}
Copy

Common pitfalls

• Calling tsParticles.load(...) before loadBackgroundMaskPlugin(...)
• Verify required peer packages before enabling advanced options
• Change one option group at a time to isolate regressions quickly

Related docs

• All packages catalog: https://github.com/tsparticles/tsparticles
• Main docs: https://particles.js.org/docs/