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

⚠️⚠️ _This readme refers to v2 version, read here for v1 documentation* ⚠️⚠️

• tsParticles - TypeScript Particles
  • Table of Contents
  • Do you want to use it on your website?
  • Library installation
    • Hosting / CDN
      • jsDelivr
      • cdnjs
      • unpkg
    • npm
    • yarn
    • pnpm
      • Import and require
    • Usage
  • Official components for some of the most used frameworks
    • Angular
    • Astro
    • Ember.js
    • Inferno
    • jQuery
    • Preact
    • ReactJS
    • RiotJS
      • riot-particles
    • SolidJS
      • solid-particles
    • Svelte
    • VueJS 2.x
    • VueJS 3.x
    • Web Components
      • web-particles
    • WordPress
      • wordpress-particles
    • Elementor
  • Presets
    • Big Circles
    • Bubbles
    • Confetti
    • Fire
    • Firefly
    • Fireworks
    • Fountain
    • Links
    • Sea Anemone
    • Snow
    • Stars
    • Triangles
  • Templates and Resources
  • Demo / Generator
  • Video Tutorials
    • Characters as particles
    • Polygon mask
    • Animated stars
    • Nyan cat flying on scrolling stars
    • Snow particles
    • Background Mask particles
  • Options
  • Want to see it in action and try it?
  • Migrating from Particles.js
  • Plugins/Customizations
  • Dependency Graphs
    • Huge thanks to JetBrains for the 2020-2022 Open Source Licenses!

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.

Please use these hosts or your own to load tsParticles on your projects

https://unpkg.com/tsparticles-confetti/ https://unpkg.com/tsparticles-engine/ https://unpkg.com/tsparticles-fireworks/ https://unpkg.com/tsparticles-slim/ https://unpkg.com/tsparticles/

tsParticles Confetti

tsParticles Engine

tsParticles Fireworks

tsParticles Slim

tsParticles

npm install tsparticles-engine

yarn add tsparticles-engine

pnpm install tsparticles-engine

const tsParticles = require("tsparticles-engine");

// or

import { tsParticles } from "tsparticles-engine";

The imported tsParticles is the same instance you have when including the script in the page using the <script> tag.

Load tsParticles and configure the particles:

index.html

<div id="tsparticles"></div>

<script src="tsparticles.engine.min.js"></script>

app.js

/* tsParticles.load(@params); */

tsParticles.load({
    id: "tsparticles",
    options: {
        /* options here */
    },
    // url: "http://foo.bar/particles.js // this can be used as an alternative to options property
});

// after initialization this can be used.

/* tsParticles.setOnClickHandler(@callback); */

/* this will be fired from all particles loaded */

tsParticles.setOnClickHandler((event, particles) => {
    /* custom on click handler */
});

// now you can control the animations too, it's possible to pause and resume the animations
// these methods don't change the config so you're safe with all your configurations
// domItem(0) returns the first tsParticles instance loaded in the dom
const particles = tsParticles.domItem(0);

// play will start the animations, if the move is not enabled it won't enable it, it just updates the frame
particles.play();

// pause will stop the animations
particles.pause();

ng-particles

Instructions available here

astro-particles

Instructions available here

ember-tsparticles

Instructions available here

inferno-particles

Instructions available here

jquery-particles

Instructions available here

preact-particles

Instructions available here

react-particles

Instructions available here

You can find the instructions here

You can find the instructions here

svelte-particles

Instructions available here

vue2-particles

Instructions available here

vue3-particles

Instruction available here

You can find the instructions here

The plugin page hosted on WordPress.org can be found here

Actually, an official tsParticles plugin isn't existing, but I have a collaboration with the Premium Addons for Elementor plugin collection.

There are some presets ready to be used in this repository, and they also have a bundle file that contains everything needed to run.

This preset loads big colored circles moving upwards on a white background.

You can find the instructions here

This preset loads colored bubbles coming from the bottom of the screen on a white background.

You can find the instructions here

This preset loads white and red confetti launched from the screen center on a transparent background.

You can find the instructions here

This preset loads a faded red to a black background with particles colored like fire and ash sparks.

You can find the instructions here

This preset loads a mouse trail made with small fading particles like little fireflies.

You can find the instructions here

This preset loads a beautiful fireworks effect.

You can find the instructions here

You can find the instructions here

You can find the instructions here

You can find the instructions here

You can find the instructions here

You can find the instructions here

You can find the instructions here

You can find some tsParticles related templates here. The templates are created for Vanilla Javascript, ReactJS, VueJS, Angular, SvelteJS, and other frameworks.

The templates will vary, new ones can be created or older ones updated with the latest features or changed to a better style. Check them out once in a while.

If you created some good design with tsParticles feel free to submit a pull request with your cool template, you'll be credited as the template author!

https://github.com/tsparticles/templates

https://particles.js.org/samples

You can find all video tutorials on the website here: https://particles.js.org/video.html

More videos are coming soon! Check every day if there are some new contents.

particles.json

You can find some config samples here 📖

You can find all options available here 📖

I've created a tsParticles collection on CodePen 😮 or you can check out my profile

Otherwise, there's the demo page link below.

Want to see even more demos? Clone the repository on your computer and follow these instructions

$ pnpm i
$ pnpm run build
$ cd demo/vanilla
$ pnpm start

Boom! 💥 http://localhost:3000 and you can check out other demos.

If you are brave enough you can switch to the dev branch for trying the features under development.

tsParticles has a package that makes this library 100% compatible with the particles.js configuration.

Seriously, you just need to change the script from particles.js to the bundled compatibility package, et-voilà, you're ready 🧙!

You can read more here

Want to know 5 reasons to do the switch? Read here

Below you can find all the information you need to install tsParticles and its new syntax.

tsParticles now supports some customizations 🥳.

You can create your own plugins

Read more here...

flowchart LR

subgraph b [Bundles]
bp[Particles.js compatibility bundle] --> bs[tsParticles Slim]
bs --> bf[tsParticles]
end

e[tsParticles Engine] --> b

iea & iebo & iebu & iec & ieg & iepa & iepu & ierem & ierep & ies --> bs
ipa & ipc & ipl --> bs
mb & mp --> bs
ple4 --> bs
sc & si & sl & sp & ssq & sst & st --> bs
ua & uc & ul & uop & uou & usi & ust --> bs

iet --> bf
pla & plem --> bf
ur & uti & utw & uw --> bf

subgraph i [Interactions]

subgraph ie [Externals]
iea[Attract]
iebo[Bounce]
iebu[Bubble]
iec[Connect]
ieg[Grab]
iepa[Pause]
iepu[Push]
ierem[Remove]
ierep[Repulse]
ies[Slow]
iet[Trail]
end

il[Light]

subgraph ip [Particles]
ipa[Attract]
ipc[Collisions]
ipl[Links]
ipr[Repulse]
end

end

i --> ie
i --> ip

e --> i

subgraph m [Movers]
mb[Base]
mp[Parallax]
end

e --> m

subgraph pa [Paths]
pac[Curves]
pape[Perlin Noise]
papo[Polygon]
pas[Simplex Noise]
end

e --> pa

subgraph pl [Plugins]
pla[Absorbers]
plem[Emitters]
plh[HSV Color]
pli[Infection]
plm[Motion]
plp[Polygon Mask]

subgraph plea [Easings]
pleb[Back]
pleci[Circ]
plecu[Cubic]
plee[Expo]
ple4[Quad]
ple5[Quint]
ples[Sine]
end

end

pl --> plea

e --> pl

subgraph s [Shapes]
sb[Bubble]
sc[Circle]
sh[Heart]
si[Image]
sl[Line]
sm[Multiline Text]
sp[Polygon]
sr[Rounded Rectangle]
ssp[Spiral]
ssq[Square]
sst[Star]
st[Text]
end

e --> s

subgraph u [Updaters]
ua[Angle]
uc[Color]
ud[Destroy]
ug[Gradient]
ul[Life]
uop[Opacity]
uor[Orbit]
uou[Out Modes]
ur[Roll]
usi[Size]
ust[Stroke Color]
uti[Tilt]
utw[Twinkle]
uw[Wobble]
end

e --> u

JetBrains WebStorm is used to maintain this project.