tsParticles

tsParticles - Easily create highly customizable JavaScript particles effect...

AnimationCanvasReactAngularVue
tsparticles/tsparticlesparticles.js.orgtsparticles

README

banner

tsParticles - TypeScript Particles


*A lightweight TypeScript library for creating particles. Dependency free (\), browser ready and compatible with
React.js, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Inferno, Riot.js, Solid.js, and Web Components

Table of Contents


Do you want to use it on your website?


_Documentation and Development references here 📖_

This library is available on two of the most popular CDNs and it's easy and ready to use, if you were using
particles.js
it's even easier.

You'll find the
instructions below, with all the
links you need, and _don't be scared by TypeScript, it's just the source language_.

The output files are just JavaScript. 🤩

CDNs and npm have all the sources you need in Javascript, a bundle browser ready (tsparticles.engine.min.js), and
all
files splitted for import syntax.

If you are interested there are some _simple instructions_
just below to guide you to
migrate from the old particles.js library.

_Library installation_


_Hosting / CDN_


_Please use these hosts or your own to load tsParticles on your projects_

  1. ```shell
  2. npm install tsparticles-engine
  3. ```

_yarn_


  1. ```shell
  2. yarn add tsparticles-engine
  3. ```

_pnpm_


  1. ```shell
  2. pnpm install tsparticles-engine
  3. ```

Import and require


  1. ```javascript
  2. const tsParticles = require("tsparticles-engine");

  4. // or

  6. import { tsParticles } from "tsparticles-engine";
  7. ```

The imported `tsParticles` is the same instance you have when including the script in the page using the `