The easiest way to add confetti to your StimulusJS app.
npm install stimulus-confettiAre you in the mood to add confetti to your stimulus application? You're in luck! This package helps you do that in no-time.
!The easiest way to add confetti to your Stimulus JS app
Add the package to your project.
``bash`
yarn add stimulus-confettior
npm install stimulus-confetti
Register the controller in your Stimulus app.
`javascript
import { Confetti } from "stimulus-confetti"
application.register('confetti', Confetti)
`
`html`
target="_blank"
data-controller="confetti"
data-action="click->confetti#spray"
>Star Avo
When you click that link, the confetti will spray and after the animation finishes, the browser will navigate to that location.
There are three types of animation.
1. Basic which shoots of confetti under your mouse
`html`
target="_blank"
data-controller="confetti"
data-action="click->confetti#spray"
data-animation-value="basic"
>Star Avo
2. School pride which adds two cannons on each side of the screen
`html`
target="_blank"
data-controller="confetti"
data-action="click->confetti#spray"
data-animation-value="school-pride"
data-duration-value="10"
>Star Avo
3. Stars which will spray stars from under your cursor
`html`
target="_blank"
data-controller="confetti"
data-action="click->confetti#spray"
data-animation-value="stars"
>Star Avo
Values can be basic, school-pride, or stars and will change the type of animation.
Defaults to basic.
Controls whether at the end of the animation, the browser should follow the link. You can set it to false when you want to test the animation.
Defaults to true.
The duration, in seconds, for the School pride animation.
Defaults to 5.
The first color for the School pride animation.
Defaults to #0886DE
The second color for the School pride animation.
Defaults to #FF6154
Controls wether log messages are being displayed in the console.
Defaults to false.
Controls various setting for the canvas-confetti package.
This package is based on the canvas-confetti` package, so please donate to help them and support their work.
If you enjoy this package try out Avo. It helps developers build internal tools, admins, CMSes, CRMs, and any other type of business apps 10x faster on top of Ruby on Rails.
