3.7.1 • Published 10 months ago

@tsparticles/plugin-polygon-mask v3.7.1

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

banner

tsParticles Polygon Mask Plugin

jsDelivr npmjs npmjs GitHub Sponsors

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({
    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-polygon-mask

or

$ 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");

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

or

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

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