Repository files navigation

Nuxt UI is a module that provides a set of Vue components and composables built withTailwind CSS andHeadless UI to help you build beautiful and accessible user interfaces.

Its goal is to provide everything related to UI when building a Nuxt app. This includes components, icons, colors, dark mode but also keyboard shortcuts.

• Built withHeadless UI andTailwind CSS
• HMR support through Nuxt App Config
• Dark mode support
• Support for LTR and RTL languages
• Keyboard shortcuts
• Bundled icons
• Fully typed
• Figma Kit

Read more onui.nuxt.com

# npmnpm install @nuxt/ui# yarnyarn add @nuxt/ui# pnpmpnpm add @nuxt/ui# bunbun add @nuxt/ui

Then, register the module in yournuxt.config.ts:

exportdefaultdefineNuxtConfig({modules:['@nuxt/ui']})

If you want latest updates, please use@nuxt/ui-edge in yourpackage.json:

{"devDependencies": {"@nuxt/ui":"npm:@nuxt/ui-edge@latest"  }}

Visithttps://ui.nuxt.com to explore the documentation.

• nuxt/nuxt
• nuxt-modules/color-mode
• nuxt-modules/tailwindcss
• tailwindlabs/tailwindcss
• tailwindlabs/headlessui
• vueuse/vueuse
• egoist/tailwindcss-icons

Thank you for considering contributing to Nuxt UI. Here are a few ways you can get involved:

• Reporting Bugs: If you come across any bugs or issues, please check out the reporting bugs guide to learn how to submit a bug report.
• Suggestions: Have any thoughts to enhance Nuxt UI? We'd love to hear them! Check out thecontribution guide to share your suggestions.

Follow the docs toSet up your local development environment and contribute.

Licensed under theMIT license.