# @tsparticles/basic

> Basic tsParticles bundle — minimal core engine with only the essential features for fast, lightweight particle animations. Ready to use components available for React, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Riot.js, Inferno.

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

## Install

```sh
npm install @tsparticles/basic
pnpm add @tsparticles/basic
yarn add @tsparticles/basic
bun add @tsparticles/basic
```

## 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 | 2023-08-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 11 |
| Unpacked size | 581.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 8983 |
| 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/basic
- 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/basic

## Dependencies (11)

- [@tsparticles/engine](https://npm.io/package/@tsparticles/engine.md) 4.4.0
- [@tsparticles/plugin-move](https://npm.io/package/@tsparticles/plugin-move.md) 4.4.0
- [@tsparticles/plugin-blend](https://npm.io/package/@tsparticles/plugin-blend.md) 4.4.0
- [@tsparticles/shape-circle](https://npm.io/package/@tsparticles/shape-circle.md) 4.4.0
- [@tsparticles/updater-size](https://npm.io/package/@tsparticles/updater-size.md) 4.4.0
- [@tsparticles/updater-paint](https://npm.io/package/@tsparticles/updater-paint.md) 4.4.0
- [@tsparticles/updater-opacity](https://npm.io/package/@tsparticles/updater-opacity.md) 4.4.0
- [@tsparticles/plugin-hex-color](https://npm.io/package/@tsparticles/plugin-hex-color.md) 4.4.0
- [@tsparticles/plugin-hsl-color](https://npm.io/package/@tsparticles/plugin-hsl-color.md) 4.4.0
- [@tsparticles/plugin-rgb-color](https://npm.io/package/@tsparticles/plugin-rgb-color.md) 4.4.0
- [@tsparticles/updater-out-modes](https://npm.io/package/@tsparticles/updater-out-modes.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
- … 63 more at https://npm.io/package/@tsparticles/basic/versions

## README

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

# tsParticles Basic Bundle

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

[tsParticles](https://github.com/tsparticles/tsparticles) basic bundle loads the minimum features to a `@tsparticles/engine` instance for having dots moving in the canvas.

**Included Packages**

- [@tsparticles/engine](https://github.com/tsparticles/tsparticles/tree/main/engine)
- [@tsparticles/plugin-move](https://github.com/tsparticles/tsparticles/tree/main/plugins/move)
- [@tsparticles/plugin-hex-color](https://github.com/tsparticles/tsparticles/tree/main/plugins/colors/hex)
- [@tsparticles/plugin-hsl-color](https://github.com/tsparticles/tsparticles/tree/main/plugins/colors/hsl)
- [@tsparticles/plugin-rgb-color](https://github.com/tsparticles/tsparticles/tree/main/plugins/colors/rgb)
- [@tsparticles/plugin-blend](https://github.com/tsparticles/tsparticles/tree/main/plugins/blend)
- [@tsparticles/shape-circle](https://github.com/tsparticles/tsparticles/tree/main/shapes/circle)
- [@tsparticles/updater-paint](https://github.com/tsparticles/tsparticles/tree/main/updaters/paint)
- [@tsparticles/updater-opacity](https://github.com/tsparticles/tsparticles/tree/main/updaters/opacity)
- [@tsparticles/updater-out-modes](https://github.com/tsparticles/tsparticles/tree/main/updaters/outModes)
- [@tsparticles/updater-size](https://github.com/tsparticles/tsparticles/tree/main/updaters/size)

## Dependency Graph

```mermaid
flowchart TD

subgraph b [Bundle]
  bb[tsparticles/basic]
end

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

subgraph p [Plugins]
  pm[tsparticles/plugin-move]
  ph[tsparticles/plugin-hex-color]
  phs[tsparticles/plugin-hsl-color]
  pr[tsparticles/plugin-rgb-color]
  pbl[tsparticles/plugin-blend]
end

subgraph s [Shapes]
  sc[tsparticles/shape-circle]
end

subgraph u [Updaters]
  up[tsparticles/updater-paint]
  uo[tsparticles/updater-opacity]
  uom[tsparticles/updater-out-modes]
  us[tsparticles/updater-size]
end

bb --> ce
bb --> p
bb --> s
bb --> 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 `loadBasic` function to load the tsParticles basic preset, all dependencies must be
  included manually

#### Bundle

Including the `tsparticles.basic.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 some of the `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.

### Usage

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

```javascript
(async () => {
  await loadBasic(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 { loadBasic } from "@tsparticles/basic";

export class ParticlesContainer extends PureComponent<unknown> {
  // this customizes the component tsParticles installation
  async customInit(engine: Engine) {
    // this adds the bundle to tsParticles
    await loadBasic(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 { loadBasic } from "@tsparticles/basic";

export function ParticlesContainer(props: unknown) {
  // this customizes the component tsParticles installation
  const customInit = useCallback(async (engine: Engine) => {
    // this adds the bundle to tsParticles
    await loadBasic(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) {
    await loadBasic(engine);
}
```

### Angular

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

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

async function particlesInit(engine: Engine): void {
  await loadBasic(engine);
}
```

### Svelte

```sveltehtml

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

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

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

## Common pitfalls

- Calling `tsParticles.load(...)` before `loadBasic(...)`
- 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/basic · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._