@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.1.0 (2024-01-13)

Bug Fixes

• fixed memory allocation of emoji shape (3d84380)
• fixed sounds in fireworks bundle (ed77e79)
• improved support for element id (54a1683)

Features

• added mute/unmute functions to sound plugin for an easier control of the volume (b2169ef)
• added new options for sounds plugin, autoPlay and icons.enable (cfc6ab8)
• added new zig-zag path (48bc5d1)
• added poisson disc plugin for better particles initial positions (405f1df)
• improved first pointerdown/touchstart event listener for better autoplay (34db125)