Skip to content
/ ui Public

The Intuitive Vue UI Library powered by Reka UI & Tailwind CSS.

License

Notifications You must be signed in to change notification settings

nuxt/ui

Repository files navigation

Nuxt UI

Nuxt UI

npm version npm downloads License Nuxt

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 add @nuxt/ui
yarn add @nuxt/ui
npm install @nuxt/ui
bun add @nuxt/ui

Nuxt

  1. Add the Nuxt UI module in your nuxt.config.ts:
export default defineNuxtConfig({
  modules: ['@nuxt/ui']
})
  1. Import Tailwind CSS and Nuxt UI in your CSS:
@import "tailwindcss" theme(static);
@import "@nuxt/ui";

Learn more in the installation guide.

Vue

  1. Add the Nuxt UI Vite plugin in your 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()
  ]
})
  1. Use the Nuxt UI Vue plugin in your 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')
  1. Import Tailwind CSS and Nuxt UI in your CSS:
@import "tailwindcss" theme(static);
@import "@nuxt/ui";

Learn more in the installation guide.

Credits

License

Licensed under the MIT license.