A JavaScript library to brighten up your user's site experience with visual effects!
Installation • Usage • Contributing
The library is written in TypeScript and compiled to an UMD module to allow integration into different environments.
You can grab the latest version from jsdelivr.
<script src="https://cdn.jsdelivr.net/npm/party-js@latest/bundle/party.min.js"></script>
The library instance is loaded into the global party object.
If you are using a package-managed environment, you can also install the latest version via npm.
npm install party-js
# or
yarn add party-js
To use it, simply require or import it.
import party from "party-js";
// or
const party = require("party-js");
The library essentially offers a fully customizeable particle-system implementation into HTML documents. Users of the library have the ability to create and fine-tune effects to their individual liking. The library offers a few simple effects right out-of-the-box, so you don't have to waste time re-creating simple effects.
document.querySelector(".button").addEventListener("click", function (e) {
party.confetti(this, {
count: party.variation.range(20, 40),
});
});
If you want to learn more, check out the quick start guide!
"The particles are getting cut off inside the screen!"
When creating the particle container, the library calculates the document <body>'s size once. If your document size changes during the lifetime of your application you can either:
#party-js-container. This forces the library to re-initialize the container and will re-calculate the size. All particles will remain in memory, so nothing will be lost.First of all, thank you so much for wanting to contribute to the project! ❤
Please refer to the contribution guidelines when opening issues or creating pull requests.
FAQs
A JavaScript library to brighten up your user's site experience with visual effects!
We found that party-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.