@tsparticles/shape-star

tsParticles Star Shape

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

loadStarShape;

Usage

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

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

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

ESM / CommonJS

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

$ npm install @tsparticles/shape-star

or

$ yarn add @tsparticles/shape-star

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

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

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

or

import { tsParticles } from "@tsparticles/engine";
import { loadStarShape } from "@tsparticles/shape-star";

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

Changelog

3.0.0 (2023-12-04)

Bug Fixes

• fixed new trail with rotated or tilted particles (a43f809)

Features

• added clear flag, enabled by default, if disabled, the canvas won't be cleared (299784c)
• added fade to trail effect (17750ea)