chore: migrate to https://ui.nuxt.com and @nuxt/ui (#616)

This commit is contained in:
Benjamin Canac
2023-09-07 14:26:12 +02:00
parent 9f9d8f5cec
commit 22f7536154
58 changed files with 112 additions and 113 deletions

View File

@@ -4,20 +4,20 @@ description: 'Learn how to install and configure the module in your Nuxt app.'
## Quick Start
1. Install `@nuxthq/ui` dependency to your project:
1. Install `@nuxt/ui` dependency to your project:
::code-group
```sh [pnpm]
pnpm i -D @nuxthq/ui
pnpm i -D @nuxt/ui
```
```bash [yarn]
yarn add -D @nuxthq/ui
yarn add -D @nuxt/ui
```
```bash [npm]
npm install -D @nuxthq/ui
npm install -D @nuxt/ui
```
::
@@ -26,7 +26,7 @@ npm install -D @nuxthq/ui
```ts [nuxt.config]
export default defineNuxtConfig({
modules: ['@nuxthq/ui']
modules: ['@nuxt/ui']
})
```
@@ -128,7 +128,7 @@ Configure options in your `nuxt.config.ts` as such:
```ts [nuxt.config.ts]
export default defineNuxtConfig({
modules: ['@nuxthq/ui'],
modules: ['@nuxt/ui'],
ui: {
global: true,
icons: ['mdi', 'simple-icons']
@@ -138,14 +138,14 @@ export default defineNuxtConfig({
## Edge
To use the latest updates pushed on the [`dev`](https://github.com/nuxtlabs/ui/tree/dev) branch, you can use `@nuxthq/ui-edge`.
To use the latest updates pushed on the [`dev`](https://github.com/nuxt/ui/tree/dev) branch, you can use `@nuxt/ui-edge`.
Update your `package.json` to the following:
```json [package.json]
{
"devDependencies": {
"@nuxthq/ui": "npm:@nuxthq/ui-edge@latest"
"@nuxt/ui": "npm:@nuxt/ui-edge@latest"
}
}
```

View File

@@ -79,7 +79,7 @@ This can also happen when you bind a dynamic color to a component: `<UBadge :col
### `app.config.ts`
Components are styled with Tailwind CSS but classes are all defined in the default [app.config.ts](https://github.com/nuxtlabs/ui/blob/dev/src/runtime/app.config.ts) file. You can override those in your own `app.config.ts`.
Components are styled with Tailwind CSS but classes are all defined in the default [app.config.ts](https://github.com/nuxt/ui/blob/dev/src/runtime/app.config.ts) file. You can override those in your own `app.config.ts`.
```ts [app.config.ts]
export default defineAppConfig({

View File

@@ -4,7 +4,7 @@ description: Discover some real-life examples of components you can build.
---
::callout{icon="i-heroicons-wrench-screwdriver"}
If you have any ideas of examples you'd like to see, please comment on [this issue](https://github.com/nuxtlabs/ui/issues/297).
If you have any ideas of examples you'd like to see, please comment on [this issue](https://github.com/nuxt/ui/issues/297).
::
## Components
@@ -147,7 +147,7 @@ padding: false
:table-example-advanced
::
::callout{icon="i-simple-icons-github" to="https://github.com/nuxtlabs/ui/blob/dev/docs/components/content/examples/TableExampleAdvanced.vue"}
::callout{icon="i-simple-icons-github" to="https://github.com/nuxt/ui/blob/dev/docs/components/content/examples/TableExampleAdvanced.vue"}
Take a look at the component!
::
@@ -170,7 +170,7 @@ padding: false
:command-palette-theme-algolia{class="max-h-[480px] rounded-md"}
::
::callout{icon="i-simple-icons-github" to="https://github.com/nuxtlabs/ui/blob/dev/docs/components/content/themes/CommandPaletteThemeAlgolia.vue#L23"}
::callout{icon="i-simple-icons-github" to="https://github.com/nuxt/ui/blob/dev/docs/components/content/themes/CommandPaletteThemeAlgolia.vue#L23"}
Take a look at the component!
::
@@ -185,7 +185,7 @@ padding: false
:command-palette-theme-raycast{class="max-h-[480px] rounded-md"}
::
::callout{icon="i-simple-icons-github" to="https://github.com/nuxtlabs/ui/blob/dev/docs/components/content/themes/CommandPaletteThemeRaycast.vue#L30"}
::callout{icon="i-simple-icons-github" to="https://github.com/nuxt/ui/blob/dev/docs/components/content/themes/CommandPaletteThemeRaycast.vue#L30"}
Take a look at the component!
::
@@ -278,6 +278,6 @@ Here are some examples of how components look like in RTL mode.
:pagination-example-r-t-l
::
::callout{icon="i-simple-icons-github" to="https://github.com/nuxtlabs/ui/blob/dev/docs/components/content/examples/PaginationExampleRTL.vue"}
::callout{icon="i-simple-icons-github" to="https://github.com/nuxt/ui/blob/dev/docs/components/content/examples/PaginationExampleRTL.vue"}
Take a look at the component!
::

View File

@@ -1,6 +1,6 @@
---
title: Roadmap
description: Discover our Volta board for @nuxthq/ui development status.
description: Discover our Volta board for @nuxt/ui development status.
toc: false
---