@tsparticles/shape-polygon

tsParticles Polygon Shape

tsParticles additional polygon shape.

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);
})();

Changelog

3.0.0-beta.0 (2023-08-24)

Bug Fixes

• deps: update dependency eslint-config-prettier to v9 (e6e2ba7)