tsParticles Canvas Utils Library

How to use it

CDN / Vanilla JS / jQuery

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

Including the tsparticles.canvas.utils.min.js file will export the function to load the canvas utils:

loadCanvasUtilsPath

Usage

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

(async () => {
  await loadCanvasUtilsPath(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/canvas-utils

$ yarn add @tsparticles/canvas-utils

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

const { tsParticles } = require("@tsparticles/engine");
const { loadCanvasUtilsPath } = require("@tsparticles/canvas-utils");

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

import { tsParticles } from "@tsparticles/engine";
import { loadCanvasUtilsPath } from "@tsparticles/canvas-utils";

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