Installation • Usage • Documentation

Party🎉

An implementation of the party.js library for the Obsidian.

Features

Create confetti and sparkles effects

What else do you want?

Installation

Search for the "Party🎉" in the Obsidian plugin list.

Manual Installation

Go to Releases and download the latest release
Enable plugins in the Obsidian settings
Extract the contents of the zip file to obsidian plugins folder
You should have a folder named "obsidian-party", containing "main.js" and "manifest.json" files
Restart Obsidian and enable the plugin in the plugin list

Manual build

Clone the repository
Run npm i or yarn to install dependencies
npm run dev to build the plugin

Usage

Either add a confetti or sparkles class for an element, or make use of all features of the party module! Also, you'd better to not spam particles, because it can cause performance issues.

Examples

Simple confetti button

<button class="confetti">Click me!</button>

DataView JS support

```dataviewjs
const buttonMaker = (text) => {
    const btn = this.container.createEl('button', {"text": text});
    btn.addEventListener('click', async (evt) => {
      evt.preventDefault();
	    party.confetti(btn); // <---- creating confetti
	    party.sparkles(btn); // <---- creating sparkles
    });
    return btn;
}

dv.table(["File", "Button"],
	dv.pages('"Dataview"')
    .map(t => [
      t.file.link,
      buttonMaker("Let's start the party!")
    ]
  )
)
```

dsarman/obsidian-party