@tsparticles/shape-image

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

or

$ 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);
})();

or

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

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

Changelog

3.7.0 (2024-11-24)

Bug Fixes

• fixed issue in Firefox that caused the canvas to expand each frame (628a05d)

Features

• added new named color plugin, and hex color in the engine (c4db774)