mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-17 13:38:07 +01:00
37 lines
1.7 KiB
Markdown
37 lines
1.7 KiB
Markdown
---
|
|
title: Introduction
|
|
description: 'Fully styled and customizable components for Nuxt.'
|
|
head:
|
|
title: 'NuxtLabs UI: Fully styled and customizable components for Nuxt'
|
|
description: 'It provides everything related to UI when building your Nuxt app. This includes components, icons, colors, dark mode but also keyboard shortcuts. Built with Headless UI and Tailwind CSS, published under MIT License.'
|
|
---
|
|
|
|
This module has been developed by the [NuxtLabs](https://nuxtlabs.com/) team for [Volta](https://volta.net) and [Nuxt Studio](https://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.
|
|
|
|
::alert{icon="i-heroicons-light-bulb"}
|
|
[Volta](https://volta.net/) entire UI is built with this module alongside the 50+ keyboard shortcuts defined.
|
|
::
|
|
|
|
## Features
|
|
|
|
- Built with [Headless UI](https://headlessui.dev/) and [Tailwind CSS](https://tailwindcss.com/)
|
|
- HMR support through Nuxt App Config
|
|
- Dark mode support
|
|
- Keyboard shortcuts
|
|
- Bundled icons
|
|
- Fully typed
|
|
|
|
## 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)
|
|
|
|
::alert{icon="i-heroicons-exclamation-triangle"}
|
|
This documentation is still a work in progress and will be updated regularly.
|
|
::
|