A lightweight JavaScript library for creating particles
npm install particles.js-------------------------------
Load particles.js and configure the particles:
index.html
``html
`
app.js
`javascript`
/ particlesJS.load(@dom-id, @path-json, @callback (optional)); /
particlesJS.load('particles-js', 'assets/particles.json', function() {
console.log('callback - particles-js config loaded');
});
particles.json
`javascript`
{
"particles": {
"number": {
"value": 80,
"density": {
"enable": true,
"value_area": 800
}
},
"color": {
"value": "#ffffff"
},
"shape": {
"type": "circle",
"stroke": {
"width": 0,
"color": "#000000"
},
"polygon": {
"nb_sides": 5
},
"image": {
"src": "img/github.svg",
"width": 100,
"height": 100
}
},
"opacity": {
"value": 0.5,
"random": false,
"anim": {
"enable": false,
"speed": 1,
"opacity_min": 0.1,
"sync": false
}
},
"size": {
"value": 10,
"random": true,
"anim": {
"enable": false,
"speed": 80,
"size_min": 0.1,
"sync": false
}
},
"line_linked": {
"enable": true,
"distance": 300,
"color": "#ffffff",
"opacity": 0.4,
"width": 2
},
"move": {
"enable": true,
"speed": 12,
"direction": "none",
"random": false,
"straight": false,
"out_mode": "out",
"bounce": false,
"attract": {
"enable": false,
"rotateX": 600,
"rotateY": 1200
}
}
},
"interactivity": {
"detect_on": "canvas",
"events": {
"onhover": {
"enable": false,
"mode": "repulse"
},
"onclick": {
"enable": true,
"mode": "push"
},
"resize": true
},
"modes": {
"grab": {
"distance": 800,
"line_linked": {
"opacity": 1
}
},
"bubble": {
"distance": 800,
"size": 80,
"duration": 2,
"opacity": 8,
"speed": 3
},
"repulse": {
"distance": 400,
"duration": 0.4
},
"push": {
"particles_nb": 4
},
"remove": {
"particles_nb": 2
}
}
},
"retina_detect": true
}
-------------------------------
key | option type / notes | example
----|---------|------|------
particles.number.value | number | 40particles.number.density.enable | boolean | true / false particles.number.density.value_area | number | 800particles.color.value | HEX (string) "#b61924"
RGB (object)
HSL (object)
array selection (HEX)
random (string) | {r:182, g:25, b:36}
{h:356, s:76, l:41}
["#b61924", "#333333", "999999"]
"random"
particles.number.density.value_area | number | 800particles.shape.type | string "circle"
array selection | "edge"
"triangle"
"polygon"
"star"
"image"
["circle", "triangle", "image"]
particles.shape.stroke.width | number | 2particles.shape.stroke.color | HEX (string) | "#222222"particles.shape.polygon.nb_slides | number | 5particles.shape.image.src | path link "assets/img/yop.svg"
svg / png / gif / jpg | "http://mywebsite.com/assets/img/yop.png"
particles.shape.image.width | number 100
(for aspect ratio) | particles.shape.image.height | number 100
(for aspect ratio) | particles.opacity.value | number (0 to 1) | 0.75particles.opacity.random | boolean | true / false particles.opacity.anim.enable | boolean | true / false particles.opacity.anim.speed | number | 3particles.opacity.anim.opacity_min | number (0 to 1) | 0.25particles.opacity.anim.sync | boolean | true / falseparticles.size.value | number | 20particles.size.random | boolean | true / false particles.size.anim.enable | boolean | true / false particles.size.anim.speed | number | 3particles.size.anim.size_min | number | 0.25particles.size.anim.sync | boolean | true / falseparticles.line_linked.enable | boolean | true / falseparticles.line_linked.distance | number | 150particles.line_linked.color | HEX (string) | #ffffffparticles.line_linked.opacity | number (0 to 1) | 0.5particles.line_linked.width | number | 1.5particles.move.enable | boolean | true / falseparticles.move.speed | number | 4particles.move.direction | string | "none" "top"
"top-right"
"right"
"bottom-right"
"bottom"
"bottom-left"
"left"
"top-left"
particles.move.random | boolean | true / falseparticles.move.straight | boolean | true / falseparticles.move.out_mode | string "out"
(out of canvas) | "bounce"
particles.move.bounce | boolean true
(between particles) | / falseparticles.move.attract.enable | boolean | true / falseparticles.move.attract.rotateX | number | 3000particles.move.attract.rotateY | number | 1500interactivity.detect_on | string | "canvas", "window"interactivity.events.onhover.enable | boolean | true / falseinteractivity.events.onhover.mode | string "grab"
array selection | "bubble"
"repulse"
["grab", "bubble"]
interactivity.events.onclick.enable | boolean | true / falseinteractivity.events.onclick.mode | string "push"
array selection | "remove"
"bubble"
"repulse"
["push", "repulse"]
interactivity.events.resize | boolean | true / falseinteractivity.events.modes.grab.distance | number | 100interactivity.events.modes.grab.line_linked.opacity | number (0 to 1) | 0.75interactivity.events.modes.bubble.distance | number | 100interactivity.events.modes.bubble.size | number | 40interactivity.events.modes.bubble.duration | number 0.4
(second) | interactivity.events.modes.repulse.distance | number | 200interactivity.events.modes.repulse.duration | number 1.2
(second) | interactivity.events.modes.push.particles_nb | number | 4interactivity.events.modes.push.particles_nb | number | 4retina_detect | boolean | true / false
-------------------------------
##### Bower
``
bower install particles.js --save
##### Rails Assets
```
gem 'rails-assets-particles.js'