@nuxt/ui
@nuxt/ui
The Intuitive UI Library powered by Reka UI and Tailwind CSS.
Nuxt UI
Nuxt UI harnesses the combined strengths of Reka UI, Tailwind CSS, and Tailwind Variants to offer developers an unparalleled set of tools for creating sophisticated, accessible, and highly performant user interfaces.
!NOTE You are on the
v3
development branch, check out the v2 branch for Nuxt UI v2.
Documentation
Visit https://ui.nuxt.com to explore the documentation.
Installation
pnpm
pnpm add @nuxt/ui
yarn
yarn add @nuxt/ui
npm
npm install @nuxt/ui
bun
bun add @nuxt/ui
Nuxt
- Add the Nuxt UI module in your
nuxt.config.ts
:
nuxt.config.ts
export default defineNuxtConfig({
modules: ['@nuxt/ui']
})
- Import Tailwind CSS and Nuxt UI in your CSS:
assets/css/main.css
@import "tailwindcss";
@import "@nuxt/ui";
Learn more in the installation guide.
Vue
- Add the Nuxt UI Vite plugin in your
vite.config.ts
:
vite.config.ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import ui from '@nuxt/ui/vite'
export default defineConfig({
plugins: [
vue(),
ui()
]
})
- Use the Nuxt UI Vue plugin in your
main.ts
:
main.ts
import { createApp } from 'vue'
import { createRouter, createWebHistory } from 'vue-router'
import ui from '@nuxt/ui/vue-plugin'
import App from './App.vue'
const app = createApp(App)
const router = createRouter({
routes: [],
history: createWebHistory()
})
app.use(router)
app.use(ui)
app.mount('#app')
- Import Tailwind CSS and Nuxt UI in your CSS:
assets/main.css
@import "tailwindcss";
@import "@nuxt/ui";
Learn more in the installation guide.
Credits
- nuxt/nuxt
- nuxt/icon
- nuxt/fonts
- nuxt-modules/color-mode
- unovue/reka-ui
- tailwindlabs/tailwindcss
- vueuse/vueuse
License
Licensed under the MIT license.