mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 12:14:41 +01:00
72 lines
1.0 KiB
Markdown
72 lines
1.0 KiB
Markdown
# @nuxthq/ui
|
|
|
|
Components library as a Nuxt3 module using [TailwindCSS](https://tailwindcss.com).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
yarn add --dev @nuxthq/ui
|
|
```
|
|
|
|
Then, register the module in your `nuxt.config.js`:
|
|
|
|
```js
|
|
import { defineNuxtConfig } from 'nuxt3'
|
|
|
|
export default defineNuxtConfig({
|
|
buildModules: [
|
|
'@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"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Options
|
|
|
|
- `primary`
|
|
|
|
Define the primary variant. Defaults to `indigo`. You can specify your own object of colors like here:
|
|
|
|
**Example:**
|
|
|
|
```js
|
|
import { defineNuxtConfig } from 'nuxt3'
|
|
|
|
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 'nuxt3'
|
|
|
|
export default defineNuxtConfig({
|
|
buildModules: [
|
|
'@nuxthq/ui'
|
|
],
|
|
ui: {
|
|
prefix: 'tw'
|
|
}
|
|
})
|
|
```
|