# tsparticles

> Full-featured tsParticles bundle — create stunning particle, confetti and fireworks animations with all official plugins and presets included. Ready to use components available for React, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Riot.js, Inf

Latest version **4.4.0** (published 2026-08-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install tsparticles
pnpm add tsparticles
yarn add tsparticles
bun add tsparticles
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.4.0 |
| Published | 2026-08-31 |
| First published | 2020-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 14 |
| Unpacked size | 1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 8986 |
| Author | Matteo Bruni |
| Maintainers | matteobruni |
| Keywords | front-end, frontend, tsparticles, particles.js, particlesjs, particles, particle, canvas, jsparticles, xparticles, particles-js, particles-bg, particles-bg-vue, particles-ts, particles.ts, react-particles-js, react-particles.js, react-particles, react, reactjs, vue-particles, ngx-particles, angular-particles, particleground, vue, vuejs, preact, preactjs, jquery, angularjs, angular, typescript, javascript, animation, web, html5, web-design, webdesign, css, html, css3, animated, background, confetti, canvas, fireworks, fireworks-js, confetti-js, confettijs, fireworksjs, canvas-confetti |

## Links

- npm: https://www.npmjs.com/package/tsparticles
- Repository: https://github.com/tsparticles/tsparticles
- Homepage: https://particles.js.org
- Issues: https://github.com/tsparticles/tsparticles/issues
- Funding: https://github.com/sponsors/matteobruni
- npm.io page: https://npm.io/package/tsparticles

## Dependencies (14)

- [@tsparticles/slim](https://npm.io/package/@tsparticles/slim.md) 4.4.0
- [@tsparticles/engine](https://npm.io/package/@tsparticles/engine.md) 4.4.0
- [@tsparticles/shape-text](https://npm.io/package/@tsparticles/shape-text.md) 4.4.0
- [@tsparticles/updater-roll](https://npm.io/package/@tsparticles/updater-roll.md) 4.4.0
- [@tsparticles/updater-tilt](https://npm.io/package/@tsparticles/updater-tilt.md) 4.4.0
- [@tsparticles/updater-wobble](https://npm.io/package/@tsparticles/updater-wobble.md) 4.4.0
- [@tsparticles/plugin-emitters](https://npm.io/package/@tsparticles/plugin-emitters.md) 4.4.0
- [@tsparticles/updater-destroy](https://npm.io/package/@tsparticles/updater-destroy.md) 4.4.0
- [@tsparticles/updater-twinkle](https://npm.io/package/@tsparticles/updater-twinkle.md) 4.4.0
- [@tsparticles/plugin-absorbers](https://npm.io/package/@tsparticles/plugin-absorbers.md) 4.4.0
- [@tsparticles/interaction-external-drag](https://npm.io/package/@tsparticles/interaction-external-drag.md) 4.4.0
- [@tsparticles/interaction-external-trail](https://npm.io/package/@tsparticles/interaction-external-trail.md) 4.4.0
- [@tsparticles/plugin-emitters-shape-circle](https://npm.io/package/@tsparticles/plugin-emitters-shape-circle.md) 4.4.0
- [@tsparticles/plugin-emitters-shape-square](https://npm.io/package/@tsparticles/plugin-emitters-shape-square.md) 4.4.0

## Alternatives

- [@luma.gl/experimental](https://npm.io/package/@luma.gl/experimental.md) — 77.1K weekly downloads
- [persona-harness](https://npm.io/package/persona-harness.md) — 4.7K weekly downloads
- [@tsparticles/effect-bubble](https://npm.io/package/@tsparticles/effect-bubble.md) — 4.6K weekly downloads
- [f3d](https://npm.io/package/f3d.md) — 730 weekly downloads
- [spark-html-motion](https://npm.io/package/spark-html-motion.md) — 298 weekly downloads

## Recent versions

- 4.4.0 (latest) — 2026-08-31
- 4.0.0-beta.17 (beta) — 2026-05-15
- 4.0.0-alpha.28 (alpha) — 2026-03-15
- 3.0.2 (next) — 2023-12-06
- 4.3.2 — 2026-07-10
- 4.3.1 — 2026-07-01
- 4.3.0 — 2026-06-27
- 4.2.1 — 2026-06-19
- 4.2.0 — 2026-06-17
- 4.1.3 — 2026-06-03
- 4.1.2 — 2026-06-01
- 4.1.1 — 2026-05-31
- 4.1.0 — 2026-05-29
- 4.0.5 — 2026-05-19
- 4.0.4 — 2026-05-19
- … 423 more at https://npm.io/package/tsparticles/versions

## README

[![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org)

# tsParticles Full Bundle

[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles/badge)](https://www.jsdelivr.com/package/npm/tsparticles) [![npmjs](https://badge.fury.io/js/tsparticles.svg)](https://www.npmjs.com/package/tsparticles) [![npmjs](https://img.shields.io/npm/dt/tsparticles)](https://www.npmjs.com/package/tsparticles) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)

[tsParticles](https://github.com/tsparticles/tsparticles) full bundle loads all the v1 features to
a `@tsparticles/engine` instance.

**Included Packages**

- [@tsparticles/slim (and all its dependencies)](https://github.com/tsparticles/tsparticles/tree/main/bundles/slim)
- [@tsparticles/engine](https://github.com/tsparticles/tsparticles/tree/main/engine)
- [@tsparticles/interaction-external-drag](https://github.com/tsparticles/tsparticles/tree/main/interactions/external/drag)
- [@tsparticles/interaction-external-trail](https://github.com/tsparticles/tsparticles/tree/main/interactions/external/trail)
- [@tsparticles/plugin-absorbers](https://github.com/tsparticles/tsparticles/tree/main/plugins/absorbers)
- [@tsparticles/plugin-emitters](https://github.com/tsparticles/tsparticles/tree/main/plugins/emitters)
- [@tsparticles/plugin-emitters-shape-circle](https://github.com/tsparticles/tsparticles/tree/main/plugins/emittersShapes/circle)
- [@tsparticles/plugin-emitters-shape-square](https://github.com/tsparticles/tsparticles/tree/main/plugins/emittersShapes/square)
- [@tsparticles/shape-text](https://github.com/tsparticles/tsparticles/tree/main/shapes/text)
- [@tsparticles/updater-destroy](https://github.com/tsparticles/tsparticles/tree/main/updaters/destroy)
- [@tsparticles/updater-roll](https://github.com/tsparticles/tsparticles/tree/main/updaters/roll)
- [@tsparticles/updater-tilt](https://github.com/tsparticles/tsparticles/tree/main/updaters/tilt)
- [@tsparticles/updater-twinkle](https://github.com/tsparticles/tsparticles/tree/main/updaters/twinkle)
- [@tsparticles/updater-wobble](https://github.com/tsparticles/tsparticles/tree/main/updaters/wobble)

## Dependency Graph

```mermaid
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:

```javascript
(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_

```typescript jsx
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_

```typescript jsx
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_

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

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

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

### Angular

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

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

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

### Svelte

```sveltehtml

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

```js
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/>

---
_Source: https://npm.io/package/tsparticles · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._