@le-pepe/nuxt-snow-effect
Nuxt Snow Effect
A simple Nuxt module to add snow effect to your Nuxt application using snow-effect custom element.
Features
- Add snow effect to your Nuxt application
- Customize the snow effect with various options
- Easy to use and setup
Quick Setup
Install the module to your Nuxt application with one command:
npx nuxi module add @le-pepe/nuxt-snow-effect
Add the module to your nuxt.config.ts:
export default defineNuxtConfig({
modules: [
'@le-pepe/nuxt-snow-effect',
],
})
Then in your app.vue file, add <SnowEffectComponent>:
<SnowEffectComponent />
Options
| Option | Type | Default | Example | Description |
|---|---|---|---|---|
| color | string | white / #ffffff | <SnowEffectComponent color="red" /> |
Change the color of the flakes |
| flakes | number | 100 | <SnowEffectComponent flakes="150" /> |
Change the number of flakes |
| speed | number | 1 | <SnowEffectComponent speed="1.5" /> |
Change the speed of the falling flakes |
Contribution
Local development
# Install dependencies
npm install
# Generate type stubs
npm run dev:prepare
# Develop with the playground
npm run dev
# Build the playground
npm run dev:build
# Run ESLint
npm run lint
# Run Vitest
npm run test
npm run test:watch
# Release new version
npm run release
Version History
| Version | Released | Vue | License |
|---|---|---|---|
| 1.5.0 | ^3.0 | MIT | |
| 1.4.0 | ^3.0 | MIT | |
| 1.3.0 | ^3.0 | MIT | |
| 1.2.6 | ^3.0 | MIT | |
| 1.2.5 | ^3.0 | MIT | |
| 1.2.4 | ^3.0 | MIT | |
| 1.2.2 | ^3.0 | MIT | |
| 1.2.1 | ^3.0 | MIT | |
| 1.2.0 | ^3.0 | MIT |