Installation

Install @nuxthq/ui dependency to your project:

yarn

yarn add -D @nuxthq/ui

Add it to your modules section in your nuxt.config:

nuxt.config

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

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

As this module installs @nuxtjs/tailwindcss and @nuxtjs/color-mode for you, you should remove them from your modules and dependencies if you've previously installed them manually.

Playground

Play on StackBlitz

Options

Key	Default	Description
`prefix`	`u`	Define the prefix of the imported components.
`global`	`false`	Expose components globally.
`icons`	`['heroicons']`	Icon collections to load.

Edge

To use the latest updates pushed on the dev branch, you can use @nuxthq/ui-edge.

Update your package.json to the following:

package.json

{
  "devDependencies": {
    "@nuxthq/ui": "npm:@nuxthq/[email protected]"
  }
}

Then run npm install or yarn install.