mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 20:19:34 +01:00
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
---
|
|
title: Introduction
|
|
description: 'Components library as a Nuxt module using TailwindCSS and HeadlessUI.'
|
|
---
|
|
|
|
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
|
|
|
|
- Fully styled and customizable components
|
|
- 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.
|
|
::
|