This package has been deprecated

Author message:

starting from tsparticles v3 the packages are now moved to @tsparticles/package-name instead of tsparticles-package-name

tsparticles-plugin-emitters
TypeScript icon, indicating that this package has built-in type declarations

2.12.0 • Public • Published

banner

tsParticles Emitters Plugin

jsDelivr npmjs npmjs GitHub Sponsors

tsParticles plugin for particles emitters.

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.min.js file will export the function to load the plugin:

loadEmittersPlugin;

Usage

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

(async () => {
  await loadEmittersPlugin(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

or

$ yarn add tsparticles-plugin-emitters

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

const { tsParticles } = require("tsparticles-engine");
const { loadEmittersPlugin } = require("tsparticles-plugin-emitters");

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

or

import { tsParticles } from "tsparticles-engine";
import { loadEmittersPlugin } from "tsparticles-plugin-emitters";

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

Package Sidebar

Install

npm i tsparticles-plugin-emitters

Weekly Downloads

36,654

Version

2.12.0

License

MIT

Unpacked Size

454 kB

Total Files

107

Last publish

Collaborators

  • ar3s
  • matteobruni