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

• 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
      • ng-particles
    • Astro
      • astro-particles
    • Ember.js
      • ember-tsparticles
    • Inferno
      • inferno-particles
    • jQuery
      • jquery-particles
    • Preact
      • preact-particles
    • ReactJS
      • react-particles
    • RiotJS
      • riot-particles
    • SolidJS
      • solid-particles
    • Svelte
      • svelte-particles
    • VueJS 2.x
      • vue2-particles
    • VueJS 3.x
      • vue3-particles
    • 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 Graph
  • Sponsors
    • Huge thanks to JetBrains for the 2020-2022 Open Source Licenses!

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

jsDelivr

cdnjs

unpkg

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

npm

tsParticles Confetti

tsParticles Engine

tsParticles Fireworks

tsParticles Basic

tsParticles Slim

tsParticles

tsParticles All

1npm install tsparticles-engine

yarn

1yarn add tsparticles-engine

pnpm

1pnpm install tsparticles-engine

Import and require

1const tsParticles = require("tsparticles-engine");
2
3// or
4
5import { tsParticles } from "tsparticles-engine";

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

Usage

Load tsParticles and configure the particles:

index.html

1<div id="tsparticles"></div>
2
3<script src="tsparticles.engine.min.js"></script>

app.js

1// @path-json can be an object or an array, the first will be loaded directly, and the object from the array will be randomly selected
2/* tsParticles.load(@params); */
3
4tsParticles
5  .load({
6    id: "tsparticles",
7    url: "presets/default.json",
8  })
9  .then((container) => {
10    console.log("callback - tsparticles config loaded");
11  })
12  .catch((error) => {
13    console.error(error);
14  });
15
16//or
17
18tsParticles.load({
19  id: "tsparticles",
20  options: {
21    /* options here */
22  },
23});
24
25//or
26
27tsParticles.load({
28  id: "tsparticles",
29  options: [
30    {
31      /* options here */
32    },
33    {
34      /* other options here */
35    },
36  ],
37});
38//random object
39
40tsParticles.load({
41  id: "tsparticles",
42  options: [
43    {
44      /* options here */
45    },
46    {
47      /* other options here */
48    },
49  ],
50  index: 1,
51}); //the second one
52// Important! If the index is not in range 0...<array.length, the index will be ignored.
53
54// after initialization this can be used.
55
56/* tsParticles.setOnClickHandler(@callback); */
57
58/* this will be fired from all particles loaded */
59
60tsParticles.setOnClickHandler((event, particles) => {
61  /* custom on click handler */
62});
63
64// now you can control the animations too, it's possible to pause and resume the animations
65// these methods don't change the config so you're safe with all your configurations
66// domItem(0) returns the first tsParticles instance loaded in the dom
67const particles = tsParticles.domItem(0);
68
69// play will start the animations, if the move is not enabled it won't enable it, it just updates the frame
70particles.play();
71
72// pause will stop the animations
73particles.pause();

Official components for some of the most used frameworks

Angular

ng-particles

Instructions available here

Astro

astro-particles

Instructions available here

Ember.js

ember-tsparticles

Instructions available here

Inferno

inferno-particles

Instructions available here

jQuery

jquery-particles

Instructions available here

Preact

preact-particles

Instructions available here

ReactJS

react-particles

Instructions available here

RiotJS

riot-particles

You can find the instructions here

SolidJS

solid-particles

You can find the instructions here

Svelte

svelte-particles

Instructions available here

VueJS 2.x

vue2-particles

Instructions available here

VueJS 3.x

vue3-particles

Instruction available here

Web Components

web-particles

You can find the instructions here

WordPress

wordpress-particles

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

Elementor

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

Presets

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

Big Circles

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

You can find the instructions here

Bubbles

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

You can find the instructions here

Confetti

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

You can find the instructions here

Fire

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

You can find the instructions here

Firefly

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

You can find the instructions here

Fireworks

This preset loads a beautiful fireworks effect.

You can find the instructions here

Fountain

You can find the instructions here

Links

You can find the instructions here

Sea Anemone

You can find the instructions here

Snow

You can find the instructions here

Stars

You can find the instructions here

Triangles

You can find the instructions here

Templates and Resources

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

Demo / Generator

https://particles.js.org/samples

Video Tutorials

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.

Characters as particles

Polygon mask

Animated stars

Nyan cat flying on scrolling stars

Snow particles

Background Mask particles

particles.json

You can find some config samples here 📖

Options

You can find all options available here 📖

Want to see it in action and try it?

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

1$ pnpm i
2$ pnpm run build
3$ cd demo/vanilla
4$ 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.

Migrating from Particles.js

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.

Plugins/Customizations

tsParticles now supports some customizations 🥳.

You can create your own plugins

Read more here...

Dependency Graph

1flowchart LR
2
3subgraph b [Bundles]
4bb[tsParticles Basic] --> bs[tsParticles Slim]
5bp[Particles.js compatibility bundle] --> bs
6bs --> bf[tsParticles]
7end
8
9e[tsParticles Engine] --> b
10
11iea & iebo & iebu & iec & ieg & iepa & iepu & ierem & ierep & ies --> bs
12ipa & ipc & ipl --> bs
13mb --> bb
14mp --> bs
15pleq --> bs
16sci --> bb
17si & sl & spo & ssq & sst & st --> bs
18uc & uop & uou & usi --> bb
19ul & urot & ust --> bs
20
21iet --> bf
22pla & plem --> bf
23urol & uti & utw & uw --> bf
24
25subgraph i [Interactions]
26
27subgraph ie [Externals]
28iea[Attract]
29iebo[Bounce]
30iebu[Bubble]
31iec[Connect]
32ieg[Grab]
33iepa[Pause]
34iepu[Push]
35ierem[Remove]
36ierep[Repulse]
37ies[Slow]
38iet[Trail]
39end
40
41il[Light]
42
43subgraph ip [Particles]
44ipa[Attract]
45ipc[Collisions]
46ipl[Links]
47ipr[Repulse]
48end
49
50end
51
52i --> ie
53i --> ip
54
55e --> i
56
57subgraph m [Movers]
58mb[Base]
59mp[Parallax]
60end
61
62e --> m
63
64subgraph pa [Paths]
65pac[Curves]
66papn[Perlin Noise]
67pap[Polygon]
68pasn[Simplex Noise]
69pasvg[SVG]
70end
71
72e --> pa
73
74subgraph pl [Plugins]
75pla[Absorbers]
76plcm[Canvas Mask]
77plem[Emitters]
78plh[HSV Color]
79pli[Infection]
80plm[Motion]
81plp[Polygon Mask]
82pls[Sounds]
83
84subgraph plea [Easings]
85pleb[Back]
86pleci[Circ]
87plecu[Cubic]
88plee[Expo]
89pleq[Quad]
90ple4[Quart]
91ple5[Quint]
92ples[Sine]
93end
94
95subgraph plex [Exports]
96plexi[Image]
97plexj[JSON]
98plexv[Video]
99end
100
101end
102
103pl --> plea
104
105e --> pl
106
107subgraph s [Shapes]
108sa[Arrow]
109sb[Bubble]
110sci[Circle]
111scog[Cog]
112sh[Heart]
113si[Image]
114sl[Line]
115smt[Multiline Text]
116spa[Path]
117spo[Polygon]
118srp[Rounded Polygon]
119srr[Rounded Rectangle]
120ssp[Spiral]
121ssq[Square]
122sst[Star]
123st[Text]
124end
125
126e --> s
127
128subgraph u [Updaters]
129uc[Color]
130ud[Destroy]
131ug[Gradient]
132ul[Life]
133uop[Opacity]
134uor[Orbit]
135uou[Out Modes]
136urol[Roll]
137urot[Rotate]
138usi[Size]
139ust[Stroke Color]
140uti[Tilt]
141utw[Twinkle]
142uw[Wobble]
143end
144
145e --> u

Sponsors

ScribbleMaps

Huge thanks to ScribbleMaps for their support on this project.

JetBrains

Huge thanks to JetBrains for the 2020-2022 Open Source Licenses!

JetBrains WebStorm is used to maintain this project.