Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.14 KB

README.md

File metadata and controls

34 lines (22 loc) · 1.14 KB

dom-confetti

npm version

Trigger confetti explosions in the DOM.

import confetti from 'dom-confetti';

const button = document.querySelector(".my-button")
button.addEventListener("click", () => confetti(button))

This will trigger a confetti explosion every time a button is clicked.

Demo

https://daniel-lundin.github.io/react-dom-confetti/

Interface

confetti(root, config = {})

root should be the DOM element to start the explosion at, and config, if given, may be an object specifying the following options:

  • angle - direction of the explosion in degrees, defaults to 90.
  • spread - spread of the explosion in degrees, deafults to 45.
  • startVelocity - Initial velocity of the particles, defaults to 45.
  • elementCount - Number of particle elements, default to 50.
  • decay - Decrease in velocity per frame, defaults to 0.9
  • random - Randomization function, defaults to Math.random

License MIT, copyright Daniel Lundin 2017