ui/README.md

@nuxthq/ui

This module has been developed by the NuxtLabs team for Volta and Nuxt Studio, 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

• Fully styled and customizable components
• HMR support through Nuxt App Config
• Dark mode support
• Keyboard shortcuts
• Bundled icons
• Fully typed

Installation

yarn add --dev @nuxthq/ui

Then, register the module in your nuxt.config.ts:

export default defineNuxtConfig({
  modules: [
    '@nuxthq/ui'
  ]
})

If you want latest updates, please use @nuxthq/ui-edge in your package.json:

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

Documentation

Visit http://ui.nuxtlabs.com to view the documentation.

Credits

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

License

Licensed under the MIT license.