@tsparticles/shape-spiral
TypeScript icon, indicating that this package has built-in type declarations

3.3.0 • Public • Published

banner

tsParticles Spiral Shape

jsDelivr npmjs npmjs GitHub Sponsors

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

loadSpiralShape

Usage

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

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

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

ESM / CommonJS

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

$ npm install @tsparticles/shape-spiral

or

$ yarn add @tsparticles/shape-spiral

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

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

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

or

import { tsParticles } from "@tsparticles/engine";
import { loadSpiralShape } from "@tsparticles/shape-spiral";

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

Package Sidebar

Install

npm i @tsparticles/shape-spiral

Weekly Downloads

876

Version

3.3.0

License

MIT

Unpacked Size

315 kB

Total Files

38

Last publish

Collaborators

  • matteobruni
  • ar3s