mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 12:14:41 +01:00
chore: use ui.nuxt.com url
This commit is contained in:
16
README.md
16
README.md
@@ -11,31 +11,31 @@
|
||||
[![License][license-src]][license-href]
|
||||
[![Nuxt][nuxt-src]][nuxt-href]
|
||||
|
||||
We're thrilled to introduce Nuxt UI v3, a significant upgrade to our UI library that delivers extensive improvements and robust new capabilities. This major update harnesses the combined strengths of [Reka UI](https://reka-ui.com/), [Tailwind CSS v4](https://tailwindcss.com/), and [Tailwind Variants](https://www.tailwind-variants.org/) to offer developers an unparalleled set of tools for creating sophisticated, accessible, and highly performant user interfaces.
|
||||
Nuxt UI harnesses the combined strengths of [Reka UI](https://reka-ui.com/), [Tailwind CSS](https://tailwindcss.com/), and [Tailwind Variants](https://www.tailwind-variants.org/) to offer developers an unparalleled set of tools for creating sophisticated, accessible, and highly performant user interfaces.
|
||||
|
||||
> [!NOTE]
|
||||
> You are on the `v3` development branch, check out the [v2 branch](https://github.com/nuxt/ui/tree/v2) for Nuxt UI v2.
|
||||
|
||||
## Documentation
|
||||
|
||||
Visit https://ui3.nuxt.dev to explore the documentation.
|
||||
Visit https://ui.nuxt.com to explore the documentation.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash [pnpm]
|
||||
pnpm add @nuxt/ui@next
|
||||
pnpm add @nuxt/ui
|
||||
```
|
||||
|
||||
```bash [yarn]
|
||||
yarn add @nuxt/ui@next
|
||||
yarn add @nuxt/ui
|
||||
```
|
||||
|
||||
```bash [npm]
|
||||
npm install @nuxt/ui@next
|
||||
npm install @nuxt/ui
|
||||
```
|
||||
|
||||
```bash [bun]
|
||||
bun add @nuxt/ui@next
|
||||
bun add @nuxt/ui
|
||||
```
|
||||
|
||||
### Nuxt
|
||||
@@ -55,7 +55,7 @@ export default defineNuxtConfig({
|
||||
@import "@nuxt/ui";
|
||||
```
|
||||
|
||||
Learn more in the [installation guide](https://ui3.nuxt.dev/getting-started/installation/nuxt).
|
||||
Learn more in the [installation guide](https://ui.nuxt.com/getting-started/installation/nuxt).
|
||||
|
||||
### Vue
|
||||
|
||||
@@ -102,7 +102,7 @@ app.mount('#app')
|
||||
@import "@nuxt/ui";
|
||||
```
|
||||
|
||||
Learn more in the [installation guide](https://ui3.nuxt.dev/getting-started/installation/vue).
|
||||
Learn more in the [installation guide](https://ui.nuxt.com/getting-started/installation/vue).
|
||||
|
||||
## Credits
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/nuxt/ui.git"
|
||||
},
|
||||
"homepage": "https://ui3.nuxt.dev",
|
||||
"homepage": "https://ui.nuxt.com",
|
||||
"type": "module",
|
||||
"license": "MIT",
|
||||
"exports": {
|
||||
|
||||
@@ -9,40 +9,40 @@ export interface ModuleOptions {
|
||||
/**
|
||||
* Prefix for components
|
||||
* @defaultValue `U`
|
||||
* @link https://ui3.nuxt.dev/getting-started/installation/nuxt#prefix
|
||||
* @link https://ui.nuxt.com/getting-started/installation/nuxt#prefix
|
||||
*/
|
||||
prefix?: string
|
||||
|
||||
/**
|
||||
* Enable or disable `@nuxt/fonts` module
|
||||
* @defaultValue `true`
|
||||
* @link https://ui3.nuxt.dev/getting-started/installation/nuxt#fonts
|
||||
* @link https://ui.nuxt.com/getting-started/installation/nuxt#fonts
|
||||
*/
|
||||
fonts?: boolean
|
||||
|
||||
/**
|
||||
* Enable or disable `@nuxtjs/color-mode` module
|
||||
* @defaultValue `true`
|
||||
* @link https://ui3.nuxt.dev/getting-started/installation/nuxt#colormode
|
||||
* @link https://ui.nuxt.com/getting-started/installation/nuxt#colormode
|
||||
*/
|
||||
colorMode?: boolean
|
||||
|
||||
/**
|
||||
* Customize how the theme is generated
|
||||
* @link https://ui3.nuxt.dev/getting-started/theme
|
||||
* @link https://ui.nuxt.com/getting-started/theme
|
||||
*/
|
||||
theme?: {
|
||||
/**
|
||||
* Define the color aliases available for components
|
||||
* @defaultValue `['primary', 'secondary', 'success', 'info', 'warning', 'error']`
|
||||
* @link https://ui3.nuxt.dev/getting-started/installation/nuxt#themecolors
|
||||
* @link https://ui.nuxt.com/getting-started/installation/nuxt#themecolors
|
||||
*/
|
||||
colors?: string[]
|
||||
|
||||
/**
|
||||
* Enable or disable transitions on components
|
||||
* @defaultValue `true`
|
||||
* @link https://ui3.nuxt.dev/getting-started/installation/nuxt#themetransitions
|
||||
* @link https://ui.nuxt.com/getting-started/installation/nuxt#themetransitions
|
||||
*/
|
||||
transitions?: boolean
|
||||
}
|
||||
@@ -55,7 +55,7 @@ export default defineNuxtModule<ModuleOptions>({
|
||||
compatibility: {
|
||||
nuxt: '>=3.16.0'
|
||||
},
|
||||
docs: 'https://ui3.nuxt.dev/getting-started/installation/nuxt'
|
||||
docs: 'https://ui.nuxt.com/getting-started/installation/nuxt'
|
||||
},
|
||||
defaults: defaultOptions,
|
||||
async setup(options, nuxt) {
|
||||
|
||||
@@ -124,7 +124,7 @@ declare module '@nuxt/schema' {
|
||||
interface AppConfigInput {
|
||||
/**
|
||||
* Nuxt UI theme configuration
|
||||
* @see https://ui3.nuxt.dev/getting-started/theme#customize-theme
|
||||
* @see https://ui.nuxt.com/getting-started/theme#customize-theme
|
||||
*/
|
||||
ui?: AppConfigUI
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user