svelte-confetti-explosion
Let's party
This library is the svelte port of the amazing react-confetti-explosion package. All the logic is from that package only, optimisation and Svelte code are mine
😉
Features
🤏 Tiny - 1.95KB min+br.🐇 Simple - Quite simple to use, and effectively no-config required!🧙♀️ Elegant - Use a Svelte component rather than setting things up inonMounthook.🗃️ Highly customizable - Offers tons of options that you can modify to get different behaviors.🖥️ SSR friendly - Works seamlessly in Sveltekit and other Server Side Rendering environments!
Installing
# pnpm
pnpm add svelte-confetti-explosion
# npm
npm install svelte-confetti-explosion
# yarn
yarn add svelte-confetti-explosionUsage
Basic usage:
<script>
import { ConfettiExplosion } from 'svelte-confetti-explosion';
</script>
<ConfettiExplosion />Customizing behavior with options:
<ConfettiExplosion particleCount={200} force={0.3} />Props
There's tons of options available for this package. All of them are already documented within the code itself, so you'll never have to leave the code editor.
particleCount
Number of confetti particles to create.
type: number
Default value: 150
Example:
<ConfettiExplosion particleCount={200} />particleSize
Size of the confetti particles in pixels
type: number
Default value: 12
Example:
<ConfettiExplosion particleSize={20} />duration
Duration of the animation in milliseconds
type: number
Default value: 3500
Example:
<ConfettiExplosion duration={5000} />colors
Colors to use for the confetti particles. Pass string array of colors. Can use hex colors, named colors, CSS Variables, literally anything valid in plain CSS.
type: Array<string>
Default value: ['#FFC700', '#FF0000', '#2E3191', '#41BBC7']
Example:
<ConfettiExplosion colors={['var(--yellow)', 'var(--red)', '#2E3191', '#41BBC7']} />particlesShape
Shape of particles to use. Can be mix, circles or rectangles
mix will use both circles and rectangles
circles will use only circles
rectangles will use only rectangles
type: 'mix' | 'circles' | 'rectangles'
Default value: 'mix'
Example:
<ConfettiExplosion particlesShape="circles" />force
Force of the confetti particles. Between 0 and 1. 0 is no force, 1 is maximum force. Will error out if you pass a value outside of this range.
type: number
Default value: 0.5
Example:
<ConfettiExplosion force={0.3} />stageHeight
Height of the stage in pixels. Confetti will only fall within this height.
type: number
Default value: 800
Example:
<ConfettiExplosion stageHeight={500} />stageWidth
Width of the stage in pixels. Confetti will only fall within this width.
type: number
Default value: 1600
Example:
<ConfettiExplosion stageWidth={500} />shouldDestroyAfterDone
Whether or not destroy all confetti nodes after the duration period has passed. By default it destroys all nodes, to free up memory.
type: boolean
Default value: true
Example:
<ConfettiExplosion shouldDestroyAfterDone={false} />Style Props
You can specify two style props on the component: --x and --y. These will shift the confetti particles on the x and y axis. by how much you specify, These can be in px, em, rem, vh, vw, literally any valid CSS unit.
USAGE:
<ConfettiExplosion --x="10px" --y="10px" />Examples
Performance
This library functions by creating 2 DOM nodes for every single confetti. By default, if the particlesCount is set to 150, it will create 300 nodes. This is a lot of nodes. For most devices, these many nodes are not a big issue, but I recommend checking your target devices' performance if you choose to go with a higher number, like 400 or 500.
Also, after the specified duration, all the confetti DOM nodes will be destroyed. This is to free up memory. If you wish to keep them around, set shouldDestroyAfterDone to false.
License
MIT License © Puru Vijay