Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ body:
attributes:
label: Package
options:
- v4.0.0-alpha.x
- v4.x
- v3.x
- v2.x
default: 1
Expand All @@ -48,7 +48,7 @@ body:
id: version
attributes:
label: Version
placeholder: v3.3.2
placeholder: v4.0.0
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ body:
attributes:
label: Package
options:
- v4.0.0-alpha.x
- v4.x
- v3.x
- v2.x
default: 1
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ body:
attributes:
label: Package
options:
- v4.0.0-alpha.x
- v4.x
- v3.x
- v2.x
default: 1
Expand Down
2 changes: 1 addition & 1 deletion .github/advanced-issue-labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ policy:
block-list: []
label:
- name: 'v4'
keys: ['v4.0.0-alpha.x']
keys: ['v4.x']
- name: 'v3'
keys: ['v3.x']
- name: 'v2'
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Nuxt UI harnesses the combined strengths of [Reka UI](https://reka-ui.com/), [Ta

## Documentation

Visit https://ui4.nuxt.com to explore the documentation.
Visit https://ui.nuxt.com to explore the documentation.

## Templates

Kickstart your project with one of our ready-to-use Nuxt UI templates or follow the [Installation Guide](https://ui4.nuxt.com/getting-started/installation/nuxt). Explore all available templates on the [official templates page](https://ui4.nuxt.com/templates).
Kickstart your project with one of our ready-to-use Nuxt UI templates or follow the [Installation Guide](https://ui.nuxt.com/getting-started/installation/nuxt). Explore all available templates on the [official templates page](https://ui.nuxt.com/templates).

- [Starter](https://github.com/nuxt-ui-templates/starter) β€” A minimal template to get started with Nuxt UI.
- [Landing](https://github.com/nuxt-ui-templates/landing) β€” A modern landing page template powered by Nuxt Content.
Expand All @@ -36,19 +36,19 @@ Kickstart your project with one of our ready-to-use Nuxt UI templates or follow
## Installation

```bash [pnpm]
pnpm add @nuxt/ui@alpha
pnpm add @nuxt/ui
```

```bash [yarn]
yarn add @nuxt/ui@alpha
yarn add @nuxt/ui
```

```bash [npm]
npm install @nuxt/ui@alpha
npm install @nuxt/ui
```

```bash [bun]
bun add @nuxt/ui@alpha
bun add @nuxt/ui
```

### Nuxt
Expand All @@ -68,7 +68,7 @@ export default defineNuxtConfig({
@import "@nuxt/ui";
```

Learn more in the [installation guide](https://ui4.nuxt.com/docs/getting-started/installation/nuxt).
Learn more in the [installation guide](https://ui.nuxt.com/docs/getting-started/installation/nuxt).

### Vue

Expand Down Expand Up @@ -115,18 +115,18 @@ app.mount('#app')
@import "@nuxt/ui";
```

Learn more in the [installation guide](https://ui4.nuxt.com/docs/getting-started/installation/vue).
Learn more in the [installation guide](https://ui.nuxt.com/docs/getting-started/installation/vue).

## Contribution

Thank you for considering contributing to Nuxt UI. Here are a few ways you can get involved:

- Reporting Bugs: If you come across any bugs or issues, please check out the reporting bugs guide to learn how to submit a bug report.
- Suggestions: Have any thoughts to enhance Nuxt UI? We'd love to hear them! Check out the [contribution guide](https://ui4.nuxt.com/docs/getting-started/contribution) to share your suggestions.
- Suggestions: Have any thoughts to enhance Nuxt UI? We'd love to hear them! Check out the [contribution guide](https://ui.nuxt.com/docs/getting-started/contribution) to share your suggestions.

## Local Development

Follow the docs to [set up your local development environment](https://ui4.nuxt.com/docs/getting-started/contribution#local-development) and contribute.
Follow the docs to [set up your local development environment](https://ui.nuxt.com/docs/getting-started/contribution#local-development) and contribute.

## Credits

Expand All @@ -143,7 +143,7 @@ Follow the docs to [set up your local development environment](https://ui4.nuxt.
Licensed under the [MIT license](https://github.com/nuxt/ui/blob/v4/LICENSE.md).

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/ui/alpha.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/ui.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt/ui

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/ui.svg?style=flat&colorA=18181B&colorB=28CF8D
Expand Down
2 changes: 1 addition & 1 deletion docs/app/app.vue
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ useHead({
],
link: [
// { rel: 'icon', type: 'image/svg+xml', href: '/icon.svg' },
{ rel: 'canonical', href: `https://ui4.nuxt.com${withoutTrailingSlash(route.path)}` }
{ rel: 'canonical', href: `https://ui.nuxt.com${withoutTrailingSlash(route.path)}` }
],
style: [
{ innerHTML: radius, id: 'nuxt-ui-radius', tagPriority: -2 },
Expand Down
2 changes: 1 addition & 1 deletion docs/app/components/VersionMenu.vue
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const config = useRuntimeConfig().public
const items = computed(() => {
return [
{ label: `v${config.version}`, active: true, color: 'primary' as const, checked: true, type: 'checkbox' as const },
{ label: 'v3.x', to: 'https://ui.nuxt.com' },
{ label: 'v3.x', to: 'https://ui3.nuxt.com' },
{ label: 'v2.x', to: 'https://ui2.nuxt.com' }
]
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ We are thrilled to introduce Nuxt UI v3, a comprehensive redesign of our UI libr

Read the blog post announcement: https://nuxt.com/blog/nuxt-ui-v3

**[Get started with Nuxt UI v3 β†’](https://ui.nuxt.com/docs/getting-started/installation/nuxt)**
**[Get started with Nuxt UI v3 β†’](https://ui3.nuxt.com/getting-started/installation/nuxt)**

### 🧩 Reka UI: A New Foundation

Expand Down Expand Up @@ -38,7 +38,7 @@ We want to be transparent: migrating from Nuxt UI v2 to v3 requires significant

To upgrade your project:

1. Read our detailed [migration guide](https://ui.nuxt.com/docs/getting-started/migration/v3)
1. Read our detailed [migration guide](https://ui3.nuxt.com/getting-started/migration)
2. Review the new documentation and components before attempting to upgrade
3. Report any issues on our [GitHub repository](https://github.com/nuxt/ui/issues)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ Looking for the **Vue** version?
::code-group{sync="pm"}

```bash [pnpm]
pnpm add @nuxt/ui@alpha
pnpm add @nuxt/ui
```

```bash [yarn]
yarn add @nuxt/ui@alpha
yarn add @nuxt/ui
```

```bash [npm]
npm install @nuxt/ui@alpha
npm install @nuxt/ui
```

```bash [bun]
bun add @nuxt/ui@alpha
bun add @nuxt/ui
```

::
Expand Down
8 changes: 4 additions & 4 deletions docs/content/docs/1.getting-started/2.installation/2.vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ Looking for the **Nuxt** version?
::code-group{sync="pm"}

```bash [pnpm]
pnpm add @nuxt/ui@alpha
pnpm add @nuxt/ui
```

```bash [yarn]
yarn add @nuxt/ui@alpha
yarn add @nuxt/ui
```

```bash [npm]
npm install @nuxt/ui@alpha
npm install @nuxt/ui
```

```bash [bun]
bun add @nuxt/ui@alpha
bun add @nuxt/ui
```

::
Expand Down
16 changes: 8 additions & 8 deletions docs/content/docs/1.getting-started/3.migration/1.v4.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,22 @@ This guide provides step-by-step instructions to migrate your application from v

```bash [pnpm]
pnpm remove @nuxt/ui-pro
pnpm add @nuxt/ui@alpha
pnpm add @nuxt/ui
```

```bash [yarn]
yarn remove @nuxt/ui-pro
yarn add @nuxt/ui@alpha
yarn add @nuxt/ui
```

```bash [npm]
npm uninstall @nuxt/ui-pro
npm install @nuxt/ui@alpha
npm install @nuxt/ui
```

```bash [bun]
bun remove @nuxt/ui-pro
bun add @nuxt/ui@alpha
bun add @nuxt/ui
```

::
Expand Down Expand Up @@ -191,19 +191,19 @@ export default defineConfig({
::code-group{sync="pm"}

```bash [pnpm]
pnpm add @nuxt/ui@alpha
pnpm add @nuxt/ui
```

```bash [yarn]
yarn add @nuxt/ui@alpha
yarn add @nuxt/ui
```

```bash [npm]
npm install @nuxt/ui@alpha
npm install @nuxt/ui
```

```bash [bun]
bun add @nuxt/ui@alpha
bun add @nuxt/ui
```

::
Expand Down
6 changes: 3 additions & 3 deletions docs/content/docs/1.getting-started/4.contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation.icon: 'i-lucide-handshake'
Nuxt UI thrives thanks to its incredible community ❀️. We welcome all contributions through bug reports, pull requests, and feedback to help make this library even better.

::caution
Before reporting a bug or requesting a feature, make sure that you have read through our [documentation](https://ui.nuxt.com/) and existing [issues](https://github.com/nuxt/ui/issues?q=is%3Aissue%20is%3Aopen%20sort%3Aupdated-desc%20label%3Av3).
Before reporting a bug or requesting a feature, make sure that you have read through our [documentation](https://ui.nuxt.com/) and existing [issues](https://github.com/nuxt/ui/issues?q=is%3Aissue%20is%3Aopen%20sort%3Aupdated-desc).
::

## Project structure
Expand All @@ -16,7 +16,7 @@ Here's an overview of the key directories and files in the Nuxt UI project struc

### Documentation

The documentation lives in the `docs` folder as a Nuxt app using `@nuxt/content` v3 to generate pages from Markdown files. See the [Nuxt Content documentation](https://content.nuxt.com/docs/getting-started) for details on how it works. Here's a breakdown of its structure:
The documentation lives in the `docs` folder as a Nuxt app using `@nuxt/content` to generate pages from Markdown files. See the [Nuxt Content documentation](https://content.nuxt.com/docs/getting-started) for details on how it works. Here's a breakdown of its structure:

```bash
β”œβ”€β”€ app/
Expand Down Expand Up @@ -130,7 +130,7 @@ To begin local development, follow these steps:
#### Clone the `nuxt/ui` repository to your local machine

```sh
git clone -b v3 https://github.com/nuxt/ui.git
git clone -b v4 https://github.com/nuxt/ui.git
```

#### Enable [Corepack](https://github.com/nodejs/corepack)
Expand Down
16 changes: 8 additions & 8 deletions docs/content/docs/1.getting-started/7.ai/1.mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Follow these steps to set up Nuxt UI as a connector within ChatGPT:

3. **In the Connectors tab, Create a new connector:**
- Give it a name: `Nuxt UI`
- MCP server URL: `https://ui4.nuxt.com/mcp`
- MCP server URL: `https://ui.nuxt.com/mcp`
- Authentication: `None`

4. **Click Create**
Expand All @@ -99,7 +99,7 @@ The Nuxt UI connector will appear in the composer's "Developer mode" tool later
Add the server using the CLI command:

```bash
claude mcp add --transport http nuxt-ui-remote https://ui4.nuxt.com/mcp
claude mcp add --transport http nuxt-ui-remote https://ui.nuxt.com/mcp
```

### Cursor
Expand All @@ -110,7 +110,7 @@ Click the button below to install the Nuxt UI MCP server directly in Cursor:

::u-button
---
to: "https://cursor.com/en/install-mcp?name=nuxt-ui&config=eyJ0eXBlIjoiaHR0cCIsInVybCI6Imh0dHBzOi8vdWk0Lm51eHQuY29tL21jcCJ9"
to: "cursor://anysphere.cursor-deeplink/mcp/install?name=nuxt-ui&config=eyJ0eXBlIjoiaHR0cCIsInVybCI6Imh0dHBzOi8vdWkubnV4dC5jb20vbWNwIn0%3D"
label: Install MCP Server
color: neutral
icon: i-custom-cursor
Expand All @@ -130,7 +130,7 @@ Or manually create/update `.cursor/mcp.json` in your project root:
"mcpServers": {
"nuxt-ui": {
"type": "http",
"url": "https://ui4.nuxt.com/mcp"
"url": "https://ui.nuxt.com/mcp"
}
}
}
Expand All @@ -144,7 +144,7 @@ Or manually create/update `.cursor/mcp.json` in your project root:
2. Click on "Add Connector" button, then select "Custom MCP Connector"
3. Create your Custom MCP Connector:
- Connector Name : `NuxtUI`
- Connector Server : `https://ui4.nuxt.com/mcp`
- Connector Server : `https://ui.nuxt.com/mcp`

### Visual Studio Code

Expand All @@ -164,7 +164,7 @@ Or manually create/update `.cursor/mcp.json` in your project root:
"servers": {
"nuxt-ui": {
"type": "http",
"url": "https://ui4.nuxt.com/mcp"
"url": "https://ui.nuxt.com/mcp"
}
}
}
Expand All @@ -183,7 +183,7 @@ Or manually create/update `.cursor/mcp.json` in your project root:
"mcpServers": {
"nuxt-ui": {
"type": "http",
"url": "https://ui4.nuxt.com/mcp"
"url": "https://ui.nuxt.com/mcp"
}
}
}
Expand All @@ -203,7 +203,7 @@ Or manually create/update `.cursor/mcp.json` in your project root:
"nuxt-ui": {
"source": "custom",
"type": "http",
"url": "https://ui4.nuxt.com/mcp"
"url": "https://ui.nuxt.com/mcp"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/2.components/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ const props = defineProps<{
```

::tip
You might want to replicate the code of your `app.vue` inside your `error.vue` file to have the same layout and features, here is an example: <https://github.com/nuxt/ui/blob/v3/docs/app/error.vue>
You might want to replicate the code of your `app.vue` inside your `error.vue` file to have the same layout and features, here is an example: <https://github.com/nuxt/ui/blob/v4/docs/app/error.vue>
::

::note
Expand Down
4 changes: 2 additions & 2 deletions docs/content/docs/4.typography/badge.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ Use markdown in the default slot of the `badge` component to display a [Badge](/
::code-preview

:::badge
**v3.0.0**
**v4.0.0**
:::

#code

```mdc
::badge
**v3.0.0**
**v4.0.0**
::
```

Expand Down
Loading
Loading