arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-14 12:14:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: rewrite to use app config and rework docs (#143)

Browse Source 
Co-authored-by: Daniel Roe <daniel@roe.dev>
Co-authored-by: Sébastien Chopin <seb@nuxt.com>
This commit is contained in:
Benjamin Canac
2023-05-04 14:49:19 +02:00
committed by GitHub
parent 56230ea915
commit 6da0db0113
144 changed files with 10470 additions and 8109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -1,6 +1,6 @@
# @nuxthq/ui
Components library as a Nuxt module using [TailwindCSS](https://tailwindcss.com).
Components library as a Nuxt module using [TailwindCSS](https://tailwindcss.com) and [HeadlessUI](https://headlessui.com).
## Installation
@@ -29,43 +29,3 @@ If you want latest updates, please use `@nuxthq/ui-edge` in your `package.json`:
}
}
```
## Options
- `primary`
Define the primary variant. Defaults to `indigo`. You can specify your own object of colors like here:
**Example:**
```js
import { defineNuxtConfig } from 'nuxt'
export default defineNuxtConfig({
buildModules: [
'@nuxthq/ui'
],
ui: {
primary: 'blue'
}
})
```
- `prefix`
Define the prefix of the imported components. Defaults to `u`.
**Example:**
```js
import { defineNuxtConfig } from 'nuxt'
export default defineNuxtConfig({
buildModules: [
'@nuxthq/ui'
],
ui: {
prefix: 'tw'
}
})
```