Nuxt Snow Effect

A simple Nuxt module to add snow effect to your Nuxt application using snow-effect custom element.

• ✨  Release Notes

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 nuxt-snow-effect

Add the module to your nuxt.config.ts:

export default defineNuxtConfig({
  modules: [
    '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

# 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