JSPM

  • Created
  • Published
  • Downloads 138754
  • Score
    100M100P100Q178327F
  • License MIT

tsParticles square shape

Package Exports

    Readme

    banner

    tsParticles Square Shape

    jsDelivr npmjs npmjs GitHub Sponsors

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

    loadSquareShape;

    Usage

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

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

    ESM / CommonJS

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

    $ npm install @tsparticles/shape-square

    or

    $ yarn add @tsparticles/shape-square

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

    const { tsParticles } = require("@tsparticles/engine");
    const { loadSquareShape } = require("@tsparticles/shape-square");
    
    (async () => {
      await loadSquareShape(tsParticles);
    })();

    or

    import { tsParticles } from "@tsparticles/engine";
    import { loadSquareShape } from "@tsparticles/shape-square";
    
    (async () => {
      await loadSquareShape(tsParticles);
    })();