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.
[2.2.0] (2022-07-11)
Bug Fix
package.json that would cause issue with ECMAScript module loaders.webpackDevServer to optionalDependencies.New Feature
shapes option, similar to the confetti template.FAQs
A JavaScript library to brighten up your user's site experience with visual effects!
The npm package party-js receives a total of 17,578 weekly downloads. As such, party-js popularity was classified as popular.
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.
Research
/Security News
Socket researchers discovered nine malicious NuGet packages that use time-delayed payloads to crash applications and corrupt industrial control systems.
Security News
Socket CTO Ahmad Nassri discusses why supply chain attacks now target developer machines and what AI means for the future of enterprise security.
Security News
Learn the essential steps every developer should take to stay secure on npm and reduce exposure to supply chain attacks.