tsParticles Branches Path

tsParticles path plugin for branches movement.

Quick checklist

1. Install @tsparticles/engine (or use the CDN bundle below)
2. Call the package loader function(s) before tsParticles.load(...)
3. Apply the package options in your tsParticles.load(...) config

How to use it

CDN / Vanilla JS / jQuery

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

Including the tsparticles.path.branches.min.js file will export the function to load the path plugin:

loadBranchesPath

Usage

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

(async () => {
  await loadBranchesPath(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/path-branches

or

$ yarn add @tsparticles/path-branches

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

const { tsParticles } = require("@tsparticles/engine");
const { loadBranchesPath } = require("@tsparticles/path-branches");

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

or

import { tsParticles } from "@tsparticles/engine";
import { loadBranchesPath } from "@tsparticles/path-branches";

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

Option mapping

• Primary options key: particles.move.path
• Path generator name: "branches"

{
  "particles": {
    "move": {
      "enable": true,
      "path": {
        "enable": true,
        "generator": "branches",
        "options": {}
      }
    }
  }
}

Common pitfalls

• Calling tsParticles.load(...) before loadBranchesPath(...)
• Verify required peer packages before enabling advanced options
• Change one option group at a time to isolate regressions quickly

Related docs

• All packages catalog: https://github.com/tsparticles/tsparticles
• Main docs: https://particles.js.org/docs/