mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 12:14:41 +01:00
212154d0d0ce40b5db14aaaa53a0a2828f6f6b1c
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Nuxt UI
Nuxt UI is a module that provides a set of Vue components and composables built with Tailwind CSS and Headless 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.
Features
- Built with Headless UI and Tailwind 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 on ui2.nuxt.com
Installation
# npm
npm install @nuxt/ui@2
# yarn
yarn add @nuxt/ui@2
# pnpm
pnpm add @nuxt/ui@2
# bun
bun add @nuxt/ui@2
Next, register the @nuxt/ui module in your nuxt.config.ts:
export default defineNuxtConfig({
modules: ['@nuxt/ui']
})
Documentation
Visit https://ui2.nuxt.com to explore the documentation.
Credits
- nuxt/nuxt
- nuxt-modules/color-mode
- nuxt-modules/tailwindcss
- tailwindlabs/tailwindcss
- tailwindlabs/headlessui
- vueuse/vueuse
- egoist/tailwindcss-icons
Contributing
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 the contribution guide to share your suggestions.
Local Development
Follow the docs to Set up your local development environment and contribute.
License
Licensed under the MIT license.
Description
Languages
Vue
50.7%
TypeScript
47.2%
JavaScript
1.2%
CSS
0.8%
