tsParticles Polygon Shape

tsParticles additional polygon shape.

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.shape.polygon.min.js file will export the function to load the shape:

loadPolygonShape;

Usage

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

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

  await tsParticles.load({
    id: "tsparticles",
    options: {
      /* options */
      /* here you can use particles.shape.type: "polygon" */
      /*   or you can use particles.shape.type: "triangle" */
    },
  });
})();

ESM / CommonJS

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

$ npm install @tsparticles/shape-polygon

or

$ yarn add @tsparticles/shape-polygon

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

const { tsParticles } = require("@tsparticles/engine");
const { loadPolygonShape } = require("@tsparticles/shape-polygon");

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

or

import { tsParticles } from "@tsparticles/engine";
import { loadPolygonShape } from "@tsparticles/shape-polygon";

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

Option mapping

• Primary options key: particles.shape.type: "polygon"
• Shape-specific options key: particles.shape.options.polygon

{
  "particles": {
    "shape": {
      "type": "polygon",
      "options": {
        "polygon": {}
      }
    }
  }
}

Common pitfalls

• Calling tsParticles.load(...) before loadPolygonShape(...)
• 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/