ui

Nuxt UI is a UI library for Vue and Nuxt that combines Reka UI, Tailwind CSS and Tailwind Variants. Its stated goal is to give developers tooling for building sophisticated, accessible and highly performant user interfaces. Repository status: this README lives on the v4 branch; separate v3 and v2 branches are maintained for earlier major versions. The public documentation is hosted at ui.nuxt.com. Installation - The package is installed as @nuxt/ui alongside tailwindcss, with commands shown for pnpm, yarn, npm and bun. - For Nuxt: register '@nuxt/ui' in the modules array of nuxt.config.ts and point css at a stylesheet such as ~/assets/css/main.css. - For plain Vue: add the Nuxt UI Vite plugin (@nuxt/ui/vite) to vite.config.ts together with @vitejs/plugin-vue, then register the Vue plugin (@nuxt/ui/vue-plugin) in the app entry file; a router is created with vue-router in the shown example. - In both setups the CSS entry imports "tailwindcss" followed by "@nuxt/ui". - Dedicated installation guides exist for Nuxt and Vue. Templates A set of ready-to-use templates is listed, with a link to an official templates page: Starter (minimal starting point), Landing (landing page powered by Nuxt Content), Docs (documentation site powered by Nuxt Content), SaaS (landing, pricing, docs and blog powered by Nuxt Content), Dashboard (multi-column layout), Chat (AI chatbot with GitHub authentication and persistent chat history powered by Vercel AI SDK), Portfolio (portfolio and blog powered by Nuxt Content), Changelog (displays repository release notes from GitHub powered by Nuxt MDC), Editor (rich text editor powered by TipTap supporting markdown, HTML and JSON content types), and Calendar (day, week and month views with drag and drop and optimistic updates). Contribution and development Contributors are invited to report bugs and submit suggestions through the project's reporting and contribution guides. An AGENTS.md file provides contributing guidelines aimed at AI coding assistants, covering component structure, theming patterns, testing conventions and documentation guidelines; it is described as being picked up automatically by AI coding agents. Instructions for setting up a local development environment are linked from the contribution documentation. Credits are given to nuxt/nuxt, nuxt/icon, nuxt/fonts, nuxt-modules/color-mode, unovue/reka-ui, tailwindlabs/tailwindcss and vueuse/vueuse. The project is licensed under the MIT license.