ui/docs/content/1.getting-started/2.installation/1.nuxt.md

title, description, framework, module

title	description	framework	module
Installation	Learn how to install and configure Nuxt UI in your Nuxt application.	nuxt	ui

::callout{to="/getting-started/installation/vue" icon="i-logos-vue" class="hidden"} Looking for the Vue version? ::

Setup

Add to a Nuxt project

::steps{level="4"}

Install the Nuxt UI v3 alpha package

::code-group{sync="pm"}

pnpm add @nuxt/ui@next

yarn add @nuxt/ui@next

npm install @nuxt/ui@next

bun add @nuxt/ui@next

::

::warning If you're using pnpm, ensure that you either set shamefully-hoist=true in your .npmrc file or install tailwindcss@next in your project's root directory. ::

Add the Nuxt UI module in your nuxt.config.ts

export default defineNuxtConfig({
  modules: ['@nuxt/ui']
})

Import Tailwind CSS and Nuxt UI in your CSS

@import "tailwindcss";
@import "@nuxt/ui";

::tip Use the css property in your nuxt.config.ts to import your CSS file.

export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  css: ['~/assets/css/main.css']
})

::

::callout{icon="i-simple-icons-visualstudiocode"} It's recommended to install the Tailwind CSS IntelliSense extension for VSCode and add the following settings:

"files.associations": {
  "*.css": "tailwindcss"
},
"editor.quickSuggestions": {
  "strings": "on"
}

::

Wrap your app with App component

<template>
  <UApp>
    <NuxtPage />
  </UApp>
</template>

::note{to="/components/app"} The App component provides global configurations and is required for Toast and Tooltip components to work. ::

::

Use our Nuxt Starter

Start your project with a Nuxt template with Nuxt UI v3 pre-configured by using our Nuxt UI Starter.

Create a new project locally by running the following command:

npx nuxi@latest init -t ui3 <my-app>

::note The <my-app> argument is the name of the directory where the project will be created, replace it with your project name. ::

Once the installation is complete, navigate into your project and start the development server:

cd <my-app>
npm run dev

Options

You can customize Nuxt UI by providing options in your nuxt.config.ts.

prefix

Use the prefix option to change the prefix of the components.

• Default: U{lang="ts-type"}

export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  ui: {
    prefix: 'Nuxt'
  }
})

fonts

Use the fonts option to enable or disable the @nuxt/fonts module.

• Default: true{lang="ts-type"}

export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  ui: {
    fonts: false
  }
})

colorMode

Use the colorMode option to enable or disable the @nuxt/color-mode module.

• Default: true{lang="ts-type"}

export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  ui: {
    colorMode: false
  }
})

theme.colors

Use the theme.colors option to define the dynamic color aliases used to generate components theme.

• Default: ['primary', 'secondary', 'success', 'info', 'warning', 'error']{lang="ts-type" class="inline"}

export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  ui: {
    theme: {
      colors: ['primary', 'error']
    }
  }
})

::tip{to="/getting-started/theme#colors"} Learn more about color customization and theming in the Theme section. ::

theme.transitions

Use the theme.transitions option to enable or disable transitions on components.

• Default: true{lang="ts-type"}

export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  ui: {
    theme: {
      transitions: false
    }
  }
})

::note This option adds the transition-colors class on components with hover or active states. ::

Continuous Releases

Nuxt UI v3 uses pkg.pr.new for continuous preview releases, providing developers with instant access to the latest features and bug fixes without waiting for official releases.

Preview releases are automatically generated for every commit to the v3 branch and pull requests targeting the v3 branch. To use it into your project, use the installation command below by replacing 5385f84 with any commit hash or pull request number.

::code-group{sync="pm"}

pnpm add https://pkg.pr.new/@nuxt/ui@5385f84

yarn add https://pkg.pr.new/@nuxt/ui@5385f84

npm install https://pkg.pr.new/@nuxt/ui@5385f84

bun add https://pkg.pr.new/@nuxt/ui@5385f84

::

::note pkg.pr.new will automatically comment on PRs with the installation URL, making it easy to test changes. ::