mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 12:14:41 +01:00
89 lines
2.6 KiB
Markdown
89 lines
2.6 KiB
Markdown
[](https://ui.nuxtlabs.com)
|
|
|
|
# Nuxt UI
|
|
|
|
[![npm version][npm-version-src]][npm-version-href]
|
|
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
[![License][license-src]][license-href]
|
|
[![Nuxt][nuxt-src]][nuxt-href]
|
|
|
|
Nuxt UI provides everything related to UI when building Nuxt applications: components, icons, colors, dark mode and also keyboard shortcuts.
|
|
|
|
Is has been developed by [NuxtLabs](https://nuxtlabs.com/) for [Volta](https://volta.net), [Nuxt Studio](https://nuxt.studio/) and the Nuxt community.
|
|
|
|
## Features
|
|
|
|
- Built with [Headless UI](https://headlessui.dev/) and [Tailwind CSS](https://tailwindcss.com/)
|
|
- HMR support through Nuxt App Config
|
|
- Dark mode support
|
|
- Support for LTR and RTL languages
|
|
- Keyboard shortcuts
|
|
- Bundled icons
|
|
- Fully typed
|
|
|
|
Read more on [ui.nuxtlabs.com](https://ui.nuxtlabs.com)
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
# Using npm
|
|
npm install @nuxthq/ui
|
|
|
|
# Using yarn
|
|
yarn add @nuxthq/ui
|
|
|
|
# Using pnpm
|
|
pnpm add @nuxthq/ui
|
|
```
|
|
|
|
Then, register the module in your `nuxt.config.ts`:
|
|
|
|
```js
|
|
export default defineNuxtConfig({
|
|
modules: [
|
|
'@nuxthq/ui'
|
|
]
|
|
})
|
|
```
|
|
|
|
If you want latest updates, please use `@nuxthq/ui-edge` in your `package.json`:
|
|
|
|
```json
|
|
{
|
|
"devDependencies": {
|
|
"@nuxthq/ui": "npm:@nuxthq/ui-edge@latest"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Visit https://ui.nuxtlabs.com to explore the documentation.
|
|
|
|
## Credits
|
|
|
|
- [nuxt/nuxt](https://github.com/nuxt/nuxt)
|
|
- [nuxt-modules/color-mode](https://github.com/nuxt-modules/color-mode)
|
|
- [nuxt-modules/tailwindcss](https://github.com/nuxt-modules/tailwindcss)
|
|
- [tailwindlabs/tailwindcss](https://github.com/tailwindlabs/tailwindcss)
|
|
- [tailwindlabs/headlessui](https://github.com/tailwindlabs/headlessui)
|
|
- [vueuse/vueuse](https://github.com/vueuse/vueuse)
|
|
- [egoist/tailwindcss-icons](https://github.com/egoist/tailwindcss-icons)
|
|
|
|
## License
|
|
|
|
Licensed under the [MIT license](https://github.com/nuxtlabs/ui/blob/dev/LICENSE.md).
|
|
|
|
<!-- Badges -->
|
|
[npm-version-src]: https://img.shields.io/npm/v/@nuxthq/ui/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
[npm-version-href]: https://npmjs.com/package/@nuxthq/ui
|
|
|
|
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxthq/ui.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
[npm-downloads-href]: https://npmjs.com/package/@nuxthq/ui
|
|
|
|
[license-src]: https://img.shields.io/github/license/nuxtlabs/ui.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
[license-href]: https://github.com/nuxtlabs/ui/blob/main/LICENSE
|
|
|
|
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
|
|
[nuxt-href]: https://nuxt.com
|