Getting Started
Installation
Add NuxtWind to your Nuxt 4 Project.
Setup
Install @nuxtwind/components to your Nuxt 4 project:
pnpm i @nuxtwind/components
yarn add @nuxtwind/components
npm install @nuxtwind/components
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
colorMode
object
Default
{
"classSuffix": ""
}
css
object
Default
{
"autoCreate": true,
"autoUpdate": true
}