cursorpop
v1.0.7
Published
Make custom cursor particles. Make your cursor POP!
Downloads
3
Maintainers
angelina-tsuboiReadme
CursorPop - Make your cursor POP!
A simple, lightweight JS library for making custom cursor particles.
Website
angelina-tsuboi.github.io/CursorPop
Installation
npm i cursorpopSetup
Example HTML template
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Test Template</title>
<style>.main{width: 100vw; height: 100vh;}</style>
<link rel="stylesheet" href="./node_modules/cursorpop/cursorpop.css">
</head>
<body>
<div class="main">
<h1>Testing CursorPop</h1>
</div>
<script src="./node_modules/cursorpop/cursorpop.js"></script>
<script src="script.js"></script>
</body>
</html>JS setup
let cursorPop = cursorpop();
document.body.onclick = function(e){
cursorPop.pop(e.pageX, e.pageY)
}Or with JQuery
let cursorPop = cursorpop();
$('body').on('click', function(e) {
cursorPop.pop(e.pageX, e.pageY)
})Reference
Constructor
// create a cursorpop object
let cursorPop = cursorpop();Generate Particles
//show particles (takes x and y coordinates of cursor)
cursorPop.pop(x, y);Appearance
// set all parameters
cursorPop.set(amount, size, smoothness, colors, speed);
// set particles to solid color
cursorPop.color(color);
// set particles to colors within color range (colors array)
cursorPop.color(colors);
// set smoothness of particles
cursorPop.smoothness(smoothness);
// set speed of particles
cursorPop.speed(speed);
// set size of particles
cursorPop.size(size);
//set amount of particles
cursorPop.amount(amount);Get involved
Please have a look at the contribution guidelines before submitting contributions.
Questions?
Feel free to email us any questions! Our contact info is on the CursorPop website.
License
This project is licensed under MIT. Please read the LICENSE for details.