vue-confetti
Advanced tools
:tada: A Vue component for dropping confetti :tada:
npm install vue-confetti --save
<template>
<main>
<button @click="start">Start</button>
<button @click="stop">Stop</button>
<button @click="love">Show some love</button>
</main>
</template>
<script>
import Vue from 'vue'
import VueConfetti from 'vue-confetti'
Vue.use(VueConfetti)
export default {
methods: {
start() {
this.$confetti.start();
},
stop() {
this.$confetti.stop();
}
love() {
this.$confetti.update({
shape: 'heart',
colors: [
'red',
'pink',
'#ba0000'
],
});
}
}
}
</script>
The following options can be passed to $confetti.start() or $confetti.update():
| Property | Type | Description | Default |
|---|---|---|---|
| shape | String | The shape of the confetti ('circle', 'rect', 'heart' or 'image'). | 'circle' |
| size | Number | The size of the particles (should be a positive number). | 10 |
| dropRate | Number | The speed at which the particles fall. | 10 |
| colors | Array | The confetti colors. | ['DodgerBlue', 'OliveDrab', 'Gold', 'pink', 'SlateBlue', 'lightblue', 'Violet', 'PaleGreen', 'SteelBlue', 'SandyBrown', 'Chocolate', 'Crimson'] |
| image | String | The path to a custom image or SVG to use as the particle. Note that shape must be set to image. | null |
| canvasId | String | The ID for a custom canvas element (the default is to append a canvas to the <body> element). | null |
| particlesPerFrame | Number | The number of particles to drop per animation frame. | 2 |
$confetti.start({
shape: 'heart',
colors: [
'red',
'pink',
'#ba0000',
],
});
$confetti.start({
shape: 'image',
image: 'http://placekitten.com/50/50',
});
$confetti.start({
canvasId: 'my-custom-canvas',
});
$confetti.start({
particlesPerFrame: 0.25,
dropRate: 3,
size: 5,
});
The following scripts are available for local development:
# test
npm run test
# run with webpack watch
npm run dev
# build for production
npm run build
# serve the demo page (watch for changes from another terminal)
npm run demo
Note that vue-confetti enforces conventional commits to help automate the release process. Whenever code is merged into master the next semantic version number is automatically determined, a changelog generated and the release published.
FAQs
A Vue component for dropping confetti.
The npm package vue-confetti receives a total of 12,801 weekly downloads. As such, vue-confetti popularity was classified as popular.
We found that vue-confetti 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
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
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.