Loading...
Loading...
Build UIs with @nuxt/ui v4 — 125+ accessible Vue components with Tailwind CSS theming. Use when creating interfaces, customizing themes to match a brand, building forms, or composing layouts like dashboards, docs sites, and chat interfaces.
npx skill4agent add nuxt/ui nuxt-uipnpm add @nuxt/ui tailwindcss// nuxt.config.ts
export default defineNuxtConfig({
modules: ['@nuxt/ui'],
css: ['~/assets/css/main.css']
})/* app/assets/css/main.css */
@import "tailwindcss";
@import "@nuxt/ui";<!-- app.vue -->
<template>
<UApp>
<NuxtPage />
</UApp>
</template>pnpm add @nuxt/ui tailwindcss// 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()
]
})// src/main.ts
import './assets/main.css'
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')/* assets/main.css */
@import "tailwindcss";
@import "@nuxt/ui";<!-- src/App.vue -->
<template>
<UApp>
<RouterView />
</UApp>
</template>Vue: Addto your rootclass="isolate"in<div id="app">.index.html
Vue + Inertia: Useinui({ router: 'inertia' }).vite.config.ts
UApplocale@nuxt/iconi-{collection}-{name}<UIcon name="i-lucide-sun" class="size-5" />
<UButton icon="i-lucide-plus" label="Add" />
<UAlert icon="i-lucide-info" title="Heads up" />Browse all icons at icones.js.org. Thecollection is used throughout Nuxt UI defaults.lucide
pnpm i @iconify-json/lucide
pnpm i @iconify-json/simple-icons// nuxt.config.ts
export default defineNuxtConfig({
icon: {
customCollections: [{
prefix: 'custom',
dir: './app/assets/icons'
}]
}
})<UIcon name="i-custom-my-icon" />text-defaultbg-elevatedborder-mutedprimarysecondarysuccessinfowarningerrorneutral// Nuxt — app.config.ts
export default defineAppConfig({
ui: { colors: { primary: 'indigo', neutral: 'zinc' } }
})// Vue — 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({
ui: { colors: { primary: 'indigo', neutral: 'zinc' } }
})
]
})uiclassui<UButton :ui="{ base: 'rounded-none', trailingIcon: 'size-3 rotate-90' }" />
<UCard :ui="{ header: 'bg-muted', body: 'p-8' }" />.nuxt/ui/<component>.tsnode_modules/.nuxt-ui/ui/<component>.tsFor CSS variables, custom colors, global config, compound variants, and a full brand customization playbook, see references/theming.md
// Notifications
const toast = useToast()
toast.add({ title: 'Saved', color: 'success', icon: 'i-lucide-check' })
// Programmatic overlays
const overlay = useOverlay()
const modal = overlay.create(MyModal)
const { result } = modal.open({ title: 'Confirm' })
await result
// Keyboard shortcuts
defineShortcuts({
meta_k: () => openSearch(),
escape: () => close()
})For full composable reference, see references/composables.md
<script setup lang="ts">
import { z } from 'zod'
const schema = z.object({
email: z.string().email('Invalid email'),
password: z.string().min(8, 'Min 8 characters')
})
type Schema = z.output<typeof schema>
const state = reactive<Partial<Schema>>({ email: '', password: '' })
function onSubmit() {
// UForm validates before emitting @submit — state is valid here
}
</script>
<template>
<UForm :schema="schema" :state="state" @submit="onSubmit">
<UFormField name="email" label="Email" required>
<UInput v-model="state.email" type="email" />
</UFormField>
<UFormField name="password" label="Password" required>
<UInput v-model="state.password" type="password" />
</UFormField>
<UButton type="submit">Sign in</UButton>
</UForm>
</template>For all form components and validation patterns, see references/components.md
<!-- Modal -->
<UModal v-model:open="isOpen" title="Edit" description="Edit your profile">
<template #body>Content</template>
<template #footer>
<UButton variant="ghost" @click="isOpen = false">Cancel</UButton>
<UButton @click="save">Save</UButton>
</template>
</UModal>
<!-- Slideover (side panel) -->
<USlideover v-model:open="isOpen" title="Settings" side="right">
<template #body>Content</template>
</USlideover>
<!-- Dropdown menu (flat array) -->
<UDropdownMenu :items="[
{ label: 'Edit', icon: 'i-lucide-pencil' },
{ type: 'separator' },
{ label: 'Delete', icon: 'i-lucide-trash', color: 'error' }
]">
<UButton icon="i-lucide-ellipsis-vertical" variant="ghost" />
</UDropdownMenu>
<!-- Dropdown menu (nested array — groups with automatic separators) -->
<UDropdownMenu :items="[
[{ label: 'Edit', icon: 'i-lucide-pencil' }, { label: 'Duplicate', icon: 'i-lucide-copy' }],
[{ label: 'Delete', icon: 'i-lucide-trash', color: 'error' }]
]">
<UButton icon="i-lucide-ellipsis-vertical" variant="ghost" />
</UDropdownMenu>For all overlay components, see references/components.md
| Layout | Description | Reference |
|---|---|---|
| Page | Landing, blog, changelog, pricing — public-facing pages | layouts/page.md |
| Dashboard | Admin UI with resizable sidebar and panels | layouts/dashboard.md |
| Docs | Documentation with sidebar nav and TOC | layouts/docs.md |
| Chat | AI chat with messages and prompt | layouts/chat.md |
| Editor | Rich text editor with toolbars | layouts/editor.md |
| Template | Framework | GitHub |
|---|---|---|
| Starter | Nuxt | nuxt-ui-templates/starter |
| Starter | Vue | nuxt-ui-templates/starter-vue |
| Dashboard | Nuxt | nuxt-ui-templates/dashboard |
| Dashboard | Vue | nuxt-ui-templates/dashboard-vue |
| SaaS | Nuxt | nuxt-ui-templates/saas |
| Landing | Nuxt | nuxt-ui-templates/landing |
| Docs | Nuxt | nuxt-ui-templates/docs |
| Portfolio | Nuxt | nuxt-ui-templates/portfolio |
| Chat | Nuxt | nuxt-ui-templates/chat |
| Editor | Nuxt | nuxt-ui-templates/editor |
| Changelog | Nuxt | nuxt-ui-templates/changelog |
| Starter | Laravel | nuxt-ui-templates/starter-laravel |
| Starter | AdonisJS | nuxt-ui-templates/starter-adonis |
When starting a new project, clone the matching template instead of setting up from scratch.
.nuxt/ui/<component>.tsnode_modules/.nuxt-ui/ui/<component>.ts