JSPM

tsparticles

1.11.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 64255
  • Score
    100M100P100Q152529F
  • License MIT

Porting of the abandoned Vincent Garreau's particles.js, converted in TypeScript. Added many new cool features and various bug fixes.

Package Exports

  • tsparticles
  • tsparticles/dist/Classes/Container
  • tsparticles/dist/Classes/Options/Options
  • tsparticles/dist/Enums/InteractivityDetect
  • tsparticles/dist/Enums/Modes/ClickMode
  • tsparticles/dist/Enums/Modes/DivMode
  • tsparticles/dist/Enums/Modes/HoverMode
  • tsparticles/dist/Enums/MoveDirection
  • tsparticles/dist/Enums/OutMode
  • tsparticles/dist/Enums/PolygonMaskInlineArrangement
  • tsparticles/dist/Enums/PolygonMaskMoveType
  • tsparticles/dist/Enums/PolygonMaskType
  • tsparticles/dist/Enums/ProcessBubbleType
  • tsparticles/dist/Enums/RotateDirection
  • tsparticles/dist/Enums/ShapeType

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tsparticles) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

tsParticles

tsParticles - TypeScript Particles

A lightweight TypeScript library for creating particles. Dependency free (*) and browser ready!

Particles.js converted in TypeScript, dependency free (*), improved with new cool 😎 features and various bugs fixed and it's currently under development!

Do you want to use it on your website?

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 ES5 JavaScript. 🤩

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

Actually the import syntax doesn't have instructions, but you can contact me by mail or in the project's Slack, the link is below and I'll help you find the right solution. Until a guide will be ready this is the fastest solution.

If you are still interested some lines below there are some instructions for migrating from the old particles.js library.

Want to see it in action and try it?

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 😷.

tsParticles demo

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

npm install && npm start

Boom! 💥 http://localhost:3000 and you can checkout other demos, if you are brave enough you can switch to the dev branch so you can try the features under development.

Dependencies

You may have notices the * near dependency free. Well almost all features works without any dependency, but... Well there's a but. The Polygon Mask feature requires pathseg for some browsers to work well, and obviously the Icon Fonts (like FontAwesome) must be included in your page.

Migrating from Particles.js

tsParticles are fully compatible with the particles.js configuration.

Seriously, you just need to change the script source 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.

General Informations

master staging dev
Master Build Status Staging Build Status Dev Build Status

CodeFactor Codacy Badge Maintainability

Social

Slack

Slack

Product Hunt

tsParticles - A lightweight TypeScript library for creating particles | Product Hunt Embed

API Docs

Documentation and Development references here: https://particles.matteobruni.it/docs/ 📖

Library installation

Hosting / CDN

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

jsDelivr

jsDelivr

cdnjs

Cdnjs

npm

npmjs

npm install tsparticles

yarn

yarn add tsparticles

NuGet

Nuget

Usage

Load tsParticles and configure the particles:

tsParticles demo

index.html

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

<script src="tsparticles.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((e) => { /* 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();

Demo / Generator

https://particles.matteobruni.it/

Particles demo

Characters as particles

Particles chars demo

Mouse hover connections

Particles mouse connections demo

Polygon mask

tsParticles Polygon Mask demo

Animated stars

Particles NASA demo

Nyan cat flying on scrolling stars

Particles Nyan Cat demo

Snow particles

tsParticles Snow demo

Background Mask particles

tsParticles Background Mask demo

COVID-19 SARS-CoV-2 particles

tsParticles COVID-19 demo

Don't click! DON'T CLICK! OH NO IT'S SPREADING!!!!

particles.json

{
  "detectRetina": false,
  "fpsLimit": 60,
  "interactivity": {
    "detectsOn": "canvas",
    "events": {
      "onClick": {
        "enable": false,
        "mode": "push"
      },
      "onDiv": {
        "elementId": "repulse-div",
        "enable": false,
        "mode": "repulse"
      },
      "onHover": {
        "enable": false,
        "mode": "grab",
        "parallax": {
          "enable": false,
          "force": 2,
          "smooth": 10
        }
      },
      "resize": true
    },
    "modes": {
      "bubble": {
        "distance": 200,
        "duration": 0.4,
        "opacity": 1,
        "size": 80
      },
      "connect": {
        "distance": 80,
        "lineLinked": {
          "opacity": 0.5
        },
        "radius": 60
      },
      "grab": {
        "distance": 100,
        "lineLinked": {
          "opacity": 1
        }
      },
      "push": {
        "quantity": 4
      },
      "remove": {
        "quantity": 2
      },
      "repulse": {
        "distance": 200,
        "duration": 0.4
      },
      "slow": {
        "_active": false,
        "factor": 1,
        "radius": 0
      }
    }
  },
  "particles": {
    "color": {
      "value": "#ffffff"
    },
    "lineLinked": {
      "blink": false,
      "color": {
        "value": "#fff"
      },
      "consent": false,
      "distance": 150,
      "enable": true,
      "opacity": 0.4,
      "shadow": {
        "blur": 5,
        "color": {
          "value": "lime"
        },
        "enable": false
      },
      "width": 1
    },
    "move": {
      "attract": {
        "enable": false,
        "rotate": {
          "x": 3000,
          "y": 3000
        }
      },
      "collisions": false,
      "direction": "none",
      "enable": true,
      "outMode": "out",
      "random": false,
      "speed": 2,
      "straight": false,
      "trail": {
        "enable": false,
        "length": 10,
        "fillColor": {
          "value": "#000000"
        }
      }
    },
    "number": {
      "density": {
        "enable": false,
        "area": 800
      },
      "limit": 0,
      "value": 100
    },
    "opacity": {
      "animation": {
        "enable": false,
        "minimumValue": 0,
        "speed": 2,
        "sync": false
      },
      "random": {
        "enable": false,
        "minimumValue": 1
      },
      "value": 1
    },
    "rotate": {
      "animation": {
        "enable": false,
        "speed": 0,
        "sync": false
      },
      "direction": "clockwise",
      "random": false,
      "value": 0
    },
    "shape": {
      "character": {
        "fill": false,
        "font": "Verdana",
        "style": "",
        "value": "*",
        "weight": "400"
      },
      "image": {
        "height": 100,
        "replaceColor": true,
        "src": "",
        "width": 100
      },
      "polygon": {
        "sides": 5
      },
      "stroke": {
        "color": {
          "value": "#ff0000"
        },
        "width": 0
      },
      "type": "circle"
    },
    "size": {
      "animation": {
        "enable": false,
        "minimumValue": 0,
        "speed": 5,
        "sync": false
      },
      "random": {
        "enable": false,
        "minimumValue": 1
      },
      "value": 3
    },
    "shadow": {
      "blur": 0,
      "color": {
        "value": "#000000"
      },
      "enable": false,
      "offset": {
        "x": 0,
        "y": 0
      }
    }
  },
  "polygon": {
    "draw": {
      "enable": false,
      "stroke": {
        "color": {
          "value": "#fff"
        },
        "width": 0.5,
        "opacity": 1
      }
    },
    "enable": false,
    "inline": {
      "arrangement": "one-per-point"
    },
    "move": {
      "radius": 10,
      "type": "path"
    },
    "scale": 1,
    "type": "none",
    "url": ""
  },
  "backgroundMask": {
    "cover": {
      "color": {
        "value": "#fff"
      },
      "opacity": 1
    },
    "enable": false
  },
  "pauseOnBlur": true
}

Options

property option type example notes
backgroundMask object See Background Mask options below
detectRetina boolean true / false replaces the old retina_detect property
fpsLimit number 60 defaults to 60, replaces the old fps_limit property
interactivity object See Interactivity options below
pauseOnBlur boolean true / false pauses the animations when the page isn't on foreground

Background Mask

key option type example notes
enable boolean true / false
cover.value HEX (string)
RGB (object)
HSL (object)
random (string)		 "#0d47a1"
{r:182, g:25, b:36}
{h:356, s:76, l:41}
"random"
cover.opacity number 0...1

Interactivity

key option type example notes
detectsOn string "canvas", "window", "parent" replaces the old detect_on property
events.onHover.enable boolean true / false
events.onHover.mode string
array		 "grab"
"bubble"
"repulse"
"connect"
["grab", "bubble"]		 the array enables all the specified modes
events.onClick.enable boolean true / false
events.onClick.mode string
array		 "push"
"remove"
"bubble"
"repulse"
["push", "repulse"]		 the array enables all the specified modes
events.onDiv.enable boolean true / false
events.onDiv.mode string
array		 "repulse"
["repulse"]		 the array enables all the specified modes
events.onDiv.elementId string repulse-div replaces the old el property
events.resize boolean true / false
events.modes.connect.distance number 100
events.modes.connect.radius number 60
events.modes.connect.lineLinked.opacity number 0...1
events.modes.grab.distance number 100
events.modes.grab.lineLinked.opacity number 0...1
events.modes.bubble.distance number 100
events.modes.bubble.size number 40
events.modes.bubble.duration number 0.4 seconds
events.modes.repulse.distance number 200
events.modes.repulse.duration number 1.2 seconds
events.modes.push.quantity number 4
events.modes.remove.quantity number 4

Particles

key option type example notes
number.value number 40
number.limit number 200 0 or less disables the limit
number.density.enable boolean true / false
number.density.area number 800
color.value HEX (string)
RGB (object)
HSL (object)
array (HEX)
random (string)		 "#0d47a1"
{r:182, g:25, b:36}
{h:356, s:76, l:41}
["#b61924", "#333333", "999999"]
"random"
shape.type string
array		 "circle"
"line"
"edge"
"triangle"
"polygon"
"star"
"image"
["circle", "triangle", "image"]
shape.stroke.width number 2
shape.stroke.color HEX (string)
RGB (object)
HSL (object)
random (string)		 "#0d47a1"
{r:182, g:25, b:36}
{h:356, s:76, l:41}
"random"
shape.polygon.sides number 5
shape.character object
array		 A single character object like below or an array of the same objects
shape.character.value object
array		 \uf179
shape.character.font string Font Awesome 5 Brands
shape.character.style string
shape.character.weight string 400 font weight, for FontAwesome it's required to use the exact weight for every family, Chrome won't render correctly otherwise.
shape.character.fill boolean true / false Fills or strokes the text. If the fonts doesn't support the stroke or the fill you won't see any particle. FontAwesome requires fill: true
shape.image object / array A single image object like below or an array of the same objects
shape.image.src path link
svg / png / gif / jpg		 "assets/img/yop.svg"
"http://mywebsite.com/assets/img/yop.png"
shape.image.width number 100 for aspect ratio
shape.image.height number 100 for aspect ratio
opacity.value number 0...1
opacity.random boolean true / false
opacity.animation.enable boolean true / false
opacity.animation.speed number 3
opacity.animation.minimumValue number 0...1 replaces the old opacity_min property
opacity.animation.sync boolean true / false
rotate.value number 45 angle in degrees
rotate.random boolean true / false
rotate.direction string clockwise / counterclockwise
rotate.animation.enable boolean true / false
rotate.animation.speed number 5
rotate.animation.sync boolean true / false
size.value number 20
size.random boolean true / false
size.animation.enable boolean true / false
size.animation.speed number 3
size.animation.minimumValue number 0.25
size.animation.sync boolean true / false
lineLinked.enable boolean true / false
lineLinked.distance number 150
lineLinked.color HEX (string)
RGB (object)
HSL (object)
random (string)		 "#0d47a1"
{r:182, g:25, b:36}
{h:356, s:76, l:41}
"random"
lineLinked.opacity number 0...1
lineLinked.width number 1.5
move.enable boolean true / false
move.speed number 4
move.direction string "none"
"top"
"top-right"
"right"
"bottom-right"
"bottom"
"bottom-left"
"left"
"top-left"
move.random boolean true / false
move.straight boolean true / false
move.outMode string "out"
"destroy"
"bounce"
"bounce-vertical"
"bounce-horizontal"		 out of canvas
move.bounce boolean true / false between particles
move.trail.enable boolean true / false
move.trail.length number 10
move.trail.fillColor HEX (string)
RGB (object)
HSL (object)
random (string)		 "#0d47a1"
{r:182, g:25, b:36}
{h:356, s:76, l:41}
"random"
move.attract.enable boolean true / false
move.attract.rotate.x number 3000
move.attract.rotate.y number 1500

Polygon Mask

key option type example notes
enable boolean true / false
draw.enable boolean true / false
draw.lineWidth number 0.5
draw.lineColor HEX (string)
RGB (object)
HSL (object)
random (string)		 "#0d47a1"
{r:182, g:25, b:36}
{h:356, s:76, l:41}
"random"
scale number 1
type string none
inside
outside
inline
move.radius number 10
url string demo/svg/deer.svg this file will be downloaded with an ajax request, if it won't load you have some XSS issues