@tsparticles/plugin-emitters-shape-canvas

tsParticles Emitters Shape Canvas Plugin

tsParticles plugin for adding the emitters shape canvas support.

How to use it

CDN / Vanilla JS / jQuery

The CDN/Vanilla version JS has one required file in vanilla configuration:

Including the tsparticles.plugin.emitters.shape.canvas.min.js file will export the function to load the plugin:

loadEmittersShapeCanvasPlugin

Usage

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

(async () => {
  await loadEmittersPlugin(tsParticles);
  await loadEmittersShapeCanvasPlugin(tsParticles);

  await tsParticles.load({
    id: "tsparticles",
    options: {
      /* options */
    },
  });
})();

ESM / CommonJS

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

$ npm install @tsparticles/plugin-emitters-shape-canvas

or

$ yarn add @tsparticles/plugin-emitters-shape-canvas

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

const { tsParticles } = require("@tsparticles/engine");
const { loadEmittersPlugin } = require("@tsparticles/plugin-emitters");
const { loadEmittersShapeCanvasPlugin } = require("@tsparticles/plugin-emitters-shape-canvas");

(async () => {
  await loadEmittersPlugin(tsParticles);
  await loadEmittersShapeCanvasPlugin(tsParticles);
})();

or

import { tsParticles } from "@tsparticles/engine";
import { loadEmittersPlugin } from "@tsparticles/plugin-emitters";
import { loadEmittersShapeCanvasPlugin } from "@tsparticles/plugin-emitters-shape-canvas";

(async () => {
  await loadEmittersPlugin(tsParticles);
  await loadEmittersShapeCanvasPlugin(tsParticles);
})();

Changelog

3.8.1 (2025-01-31)

Bug Fixes

• fixed z-index style when fullScreen is active, closes #5458 (5e94ca4)