@le-pepe/nuxt-snow-effect
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

Nuxt Snow Effect

npm version npm downloads License Nuxt

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

Dependents (0)

Package Sidebar

Install

npm i @le-pepe/nuxt-snow-effect

Weekly Downloads

1

Version

1.2.0

License

MIT

Unpacked Size

7.56 kB

Total Files

13

Last publish

Collaborators

  • le_pepe