Getting Started

Installation

Add NuxtWind to your Nuxt 3 Project.

Setup

  1. Install @nuxtwind/components to your Nuxt 3 project:
pnpm i @nuxtwind/components
  1. Add the @nuxtwind/components module to your nuxt.config.ts:
nuxt.config.ts
export default defineNuxtConfig({
  modules: ["@nuxtwind/components"],
});

That's it! You can now use all components in your Nuxt app ✨

At this point your components will use the default theme. You can customize the theme by following the theme guide.

Options

You can pass the following options to the @nuxtwind/components module in your nuxt.config.ts to customize its behavior:

nuxt.config.ts
export default defineNuxtConfig({
  modules: ["@nuxtwind/components"],
  nuxtwind: {
    // Module options
  },
});

prefix

string
Default
NXW-

global

boolean
Default
false

debugLog

boolean
Default
false

theme

object

Copyright © 2024