Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

party-js

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

party-js

A JavaScript library to brighten up your user's site experience with visual effects!

2.2.0
latest
Source
npm

Version published: 2 years ago

Weekly downloads: 14K; decreased by-1.32%

Maintainers: 1

Weekly downloads

Created: 4 years ago

Source

Installation • Usage • Contributing

GitHub Repo stars npm downloads

Installation

The library is written in TypeScript and compiled to an UMD module to allow integration into different environments.

Browsers

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.

Node.JS

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");

Usage

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!

Known Issues

"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:
1. Remove the #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.
2. Manually calculate the needed container size and update it yourself. The library does not do this on a per-frame basis, in order not to unvoluntarily slow down older devices with timeout polling, and watching for document size changes is an expensive task, as of writing.

Contributing

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

Fixed exports in package.json that would cause issue with ECMAScript module loaders.
Moved webpackDevServer to optionalDependencies.

New Feature

The sparkles template now supports the shapes option, similar to the confetti template.

Keywords

FAQs

What is party-js?

Is party-js popular?

Is party-js well maintained?

Package last updated on 11 Jul 2022

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.

Install