Setup

This module is plug-and-play with sensible defaults. Just install the package to get started.

Installation

1. Install the nuxt-particles package:

pnpm add -D nuxt-particles

yarn add -D nuxt-particles

npm install --save-dev nuxt-particles

2. Add the nuxt-particles package to the modules array in your nuxt.config.ts:

export default defineNuxtConfig({  modules: [    // ...    'nuxt-particles'  ],  // ...})

Options

You may configure the nuxt-particles module by adding a particles property to your nuxt.config.ts:

export default defineNuxtConfig({  // ...  particles: {    mode: 'full', // 'full' | 'slim' | 'basic' | 'custom'    lazy: true  }})

Learn more about the available options in the Configuration section.