Skip to content

Latest commit

 

History

History
121 lines (84 loc) · 3.29 KB

README.md

File metadata and controls

121 lines (84 loc) · 3.29 KB
Raw

nuxt-ui.png

Nuxt UI

npm version npm downloads License Nuxt

We're thrilled to introduce Nuxt UI v3, a significant upgrade to our UI library that delivers extensive improvements and robust new capabilities. This major update harnesses the combined strengths of Radix Vue, Tailwind CSS v4, 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 dev branch for Nuxt UI v2.

Documentation

Visit https://ui3.nuxt.dev to explore the documentation.

Installation

pnpm add @nuxt/ui@next
yarn add @nuxt/ui@next
npm install @nuxt/ui@next
bun add @nuxt/ui@next

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";
@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 ui from '@nuxt/ui/vue-plugin'
import App from './App.vue'

const app = createApp(App)

app.use(ui)

app.mount('#app')
  1. Import Tailwind CSS and Nuxt UI in your CSS:
@import "tailwindcss";
@import "@nuxt/ui";

Learn more in the installation guide.

Credits

License

Licensed under the MIT license.