Package Exports

tsparticles-shape-image
tsparticles-shape-image/cjs/index.js
tsparticles-shape-image/esm/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tsparticles-shape-image) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

tsParticles Image Shape

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

loadImageShape;

Usage

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

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

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

ESM / CommonJS

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

$ npm install tsparticles-shape-image

$ yarn add tsparticles-shape-image

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

const { tsParticles } = require("tsparticles-engine");
const { loadImageShape } = require("tsparticles-shape-image");

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

import { tsParticles } from "tsparticles-engine";
import { loadImageShape } from "tsparticles-shape-image";

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