tsparticles

tsParticles Full Bundle

tsParticles full bundle loads all the v1 features to a @tsparticles/engine instance.

Included Packages

• @tsparticles/slim (and all its dependencies)
• @tsparticles/engine
• @tsparticles/interaction-external-drag
• @tsparticles/interaction-external-trail
• @tsparticles/plugin-absorbers
• @tsparticles/plugin-emitters
• @tsparticles/plugin-emitters-shape-circle
• @tsparticles/plugin-emitters-shape-square
• @tsparticles/shape-text
• @tsparticles/updater-destroy
• @tsparticles/updater-roll
• @tsparticles/updater-tilt
• @tsparticles/updater-twinkle
• @tsparticles/updater-wobble

Dependency Graph

flowchart TD

subgraph b [Bundle]
  bf[tsparticles]
  bs[tsparticles/slim]
end

subgraph c [Core]
  ce[tsparticles/engine]
end

subgraph i [Interactions]
  ied[tsparticles/interaction-external-drag]
  iet[tsparticles/interaction-external-trail]
end

subgraph p [Plugins]
  pa[tsparticles/plugin-absorbers]
  pe[tsparticles/plugin-emitters]
  pesc[tsparticles/plugin-emitters-shape-circle]
  pess[tsparticles/plugin-emitters-shape-square]
end

subgraph s [Shapes]
  st[tsparticles/shape-text]
end

subgraph u [Updaters]
  ud[tsparticles/updater-destroy]
  ur[tsparticles/updater-roll]
  ut[tsparticles/updater-tilt]
  utw[tsparticles/updater-twinkle]
  uw[tsparticles/updater-wobble]
end

bf --> bs
bf --> ce
bf --> i
bf --> p
bf --> s
bf --> u

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 two different files:

• One is a bundle file with all the scripts included in a single file
• One is a file including just the loadFull function to load the tsParticles full preset, all dependencies must be included manually

Bundle

Including the tsparticles.bundle.min.js file will work exactly like v1, you can start using the tsParticles instance in the same way.

This is the easiest usage, since it's a single file with the same v1 features.

All new features will be added as external packages, this bundle is recommended for migrating from v1 easily.

Not Bundle

This installation requires more work since all dependencies must be included in the page. Some lines above are all specified in the Included Packages section.

A note about @tsparticles/slim can be made: it's not mandatory to include all of its dependencies, the slim bundle file is enough, and if this is done the @tsparticles/engine is not needed, since it's already bundled in the slim bundle.

Usage

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

(async () => {
  await loadFull(tsParticles);

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

React.js / Preact / Inferno

The syntax for React.js, Preact and Inferno is the same.

This sample uses the class component syntax, but you can use hooks as well (if the library supports it).

Class Components

import React from "react";
import Particles from "react-particles";
import type { Engine } from "@tsparticles/engine";
import { loadFull } from "tsparticles";

export class ParticlesContainer extends PureComponent<unknown> {
  // this customizes the component tsParticles installation
  async customInit(engine: Engine): Promise<void> {
    // this adds the bundle to tsParticles
    await loadFull(engine);
  }

  render() {
    const options = {
      /* custom options */
    };

    return <Particles options={options} init={this.customInit} />;
  }
}

Hooks / Functional Components

import React, { useCallback } from "react";
import Particles from "react-particles";
import type { Engine } from "@tsparticles/engine";
import { loadFull } from "tsparticles";

export function ParticlesContainer(props: unknown) {
  // this customizes the component tsParticles installation
  const customInit = useCallback(async (engine: Engine) => {
    // this adds the bundle to tsParticles
    await loadFull(engine);
  });

  const options = {
    /* custom options */
  };

  return <Particles options={options} init={this.customInit} />;
}

Vue (2.x and 3.x)

The syntax for Vue.js 2.x and 3.x is the same

<Particles id="tsparticles" :particlesInit="particlesInit" :options="options" />

const options = {
  /* custom options */
};

async function particlesInit(engine: Engine): Promise<void> {
  await loadFull(engine);
}

Angular

<ng-particles [id]="id" [options]="options" [particlesInit]="particlesInit"></ng-particles>

const options = {/* custom options */};

async function particlesInit(engine: Engine): Promise<void> {
  await loadFull(engine);
}

Svelte

<Particles
    id="tsparticles"
    options={options}
    particlesInit={particlesInit}
/>

let options = {/* custom options */};

let particlesInit = async engine => {
  await loadFull(engine);
};

Common pitfalls

• Calling tsParticles.load(...) before loadFull(...)
• 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/