Package Exports

tsparticles-plugin-polygon-mask
tsparticles-plugin-polygon-mask/cjs/index.js
tsparticles-plugin-polygon-mask/esm/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tsparticles-plugin-polygon-mask) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

tsParticles Polygon Mask Plugin

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

loadPolygonMaskPlugin;

Usage

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

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

  await tsParticles.load("tsparticles", {
    /* 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-polygon-mask

$ yarn add tsparticles-plugin-polygon-mask

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

const { tsParticles } = require("tsparticles-engine");
const { loadPolygonMaskPlugin } = require("tsparticles-plugin-polygon-mask");

loadPolygonMaskPlugin(tsParticles); // awaitable

import { tsParticles } from "tsparticles-engine";
import { loadPolygonMaskPlugin } from "tsparticles-plugin-polygon-mask";

loadPolygonMaskPlugin(tsParticles); // awaitable