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
- Use for your website
- Official components for some of the most used frameworks
- Presets
- Templates and Resources
- Demo / Generator
- Video Tutorials
- Migrating from Particles.js
- Plugins/Customizations
- Dependency Graphs
- Sponsors
Documentation and Development references here 📖
This library is available on the two 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-engine/ https://unpkg.com/tsparticles-slim/ https://unpkg.com/tsparticles/
tsParticles Engine
tsParticles Slim
tsParticles
npm install tsparticles-engineyarn add tsparticles-enginepnpm install tsparticles-engineStarting from version 1.12.11 import and require can be used to import tsParticles .
Now you can write something like this
const tsParticles = require("tsparticles-engine");
// or
import { tsParticles } from "tsparticles-engine";The imported tsParticles is the same instance you have when including the script.
Load tsParticles and configure the particles:
index.html
<div id="tsparticles"></div>
<script src="tsparticles.engine.min.js"></script>app.js
// @path-json can be an object or an array, the first will be loaded directly, the object from the array will be random selected
/* tsParticles.loadJSON(@dom-id, @path-json, @callback (optional)); */
tsParticles
.loadJSON("tsparticles", "presets/default.json")
.then((container) => {
console.log("callback - tsparticles config loaded");
})
.catch((error) => {
console.error(error);
});
//or
/* tsParticles.load(@dom-id, @options); */
tsParticles.load("tsparticles", {
/* options here */
});
//or
/* tsParticles.loadFromArray(@dom-id, @options, @index (optional)); */
tsParticles.loadFromArray("tsparticles", [
{
/* options here */
},
{
/* other options here */
},
]);
//random object
tsParticles.loadFromArray(
"tsparticles",
[
{
/* options here */
},
{
/* other options here */
},
],
1
); //the second one
// Important! If the index is not in range 0...<array.length, the index will be ignored.
// 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
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.
Use Premium Addons for Elementor Page Builder and get the chance to include tsParticles in your next WordPress website without the need to write a single line of code. See a Live Example.
There are some presets ready to be used in this repository, and they have also 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 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 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 in 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 checkout my profile
Otherwise, there's the demo page link below. Just click/tap the Coronavirus below, don't be scared. It's safe 😷.
Want to see ever more demos? Clone the repository on your computer and follow these instructions
$ pnpm i
$ npx lerna run build
$ cd demo/vanilla
$ pnpm run startBoom! 💥 http://localhost:3000 and you can checkout 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 TD
subgraph c [Components]
ca[Angular]
ci[Inferno.js]
cj[JQuery]
cp[Preact]
cre[React.js]
cri[Riot.js]
cso[Solid.js]
csv[Svelte]
cv2[Vue.js 2.x]
cv3[Vue.js 3.x]
cw[Web Components]
end
e[tsParticles Engine] --> c
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 --> bs
ipa & ipc & ipl --> bs
mb & mp --> bs
sc & si & sl & sp & ssq & sst & st --> bs
ua & uc & ul & uop & uou & usi & ust --> bs
iet --> bf
pla & ple & plp --> 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]
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]
ple[Emitters]
pli[Infection]
plp[Polygon Mask]
end
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]
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
subgraph pr [Presets]
prbi[Big Circles]
prbu[Bubbles]
prc[Confetti]
prf[Fire]
prff[Firefly]
prfw[Fireworks]
prfo[Fountain]
prl[Links]
prsa[Sea Anemone]
prsn[Snow]
prst[Stars]
prt[Triangles]
end
e --> pr
Huge thanks to JetBrains for the 2020-2022 Open Source Licenses!
JetBrains WebStorm is used to maintain this project.
Codacy is a code quality platform that helps you to detect and fix code quality issues in your code.
Automate code reviews on your commits and pull requests
Check your code quality and keep track of your technical debt for more than 40 programming languages. Seamlessly integrated within your development workflow.