You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/contributing/documentation.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -127,6 +127,14 @@ links:
127
127
---
128
128
```
129
129
130
+
Optional `keywords` feed the docs search and the MCP `search-components` tool. Use alternate names from other ecosystems, not words already in the title or description:
131
+
132
+
```yaml
133
+
keywords:
134
+
- segmented control
135
+
- button group
136
+
```
137
+
130
138
For Reka UI based components, add the Reka UI link:
Copy file name to clipboardExpand all lines: docs/content/blog/how-to-build-an-ai-chat.md
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ Check out the [`Nuxt`](https://github.com/nuxt-ui-templates/chat) and [`Vue`](ht
36
36
37
37
Before we start, make sure you have:
38
38
39
-
- Node.js 20+ installed
39
+
- Node.js 22.19+ or 24.11+ installed
40
40
- A [Vercel AI Gateway](https://vercel.com/docs/ai-gateway) API key (provides access to multiple AI providers through a single endpoint)
41
41
42
42
## Project setup
@@ -191,7 +191,7 @@ This section covers integrating AI on the server. The following API endpoints ha
191
191
192
192
### Creating a chat
193
193
194
-
First, create the endpoint that initializes a new chat and saves the first message to the database. This uses the [`UIMessage`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/ui-message) type from the AI SDK:
194
+
First, create the endpoint that initializes a new chat and saves the first message to the database. This uses the [`UIMessage`](https://ai-sdk.dev/docs/reference/ai-sdk-core/ui-message) type from the AI SDK:
Nuxt UI provides purpose-built components for AI chat interfaces: [`UChatPrompt`](/docs/components/chat-prompt) for the input area and [`UChatMessages`](/docs/components/chat-messages) for displaying the conversation.
410
410
@@ -509,7 +509,7 @@ html.dark .shiki span {
509
509
510
510
## Creating the chat page
511
511
512
-
The chat page is where the actual conversation happens. It integrates the AI SDK's [`Chat`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/chat)class and [`DefaultChatTransport`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/default-chat-transport) for real-time streaming.
512
+
The chat page is where the actual conversation happens. It integrates the AI SDK's [`useChat`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat)composable and [`DefaultChatTransport`](https://ai-sdk.dev/docs/ai-sdk-ui/transport#default-transport) for real-time streaming.
The [`useChat`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) composable from `@ai-sdk/vue` manages the entire conversation state. It handles:
638
638
- Message history with `messages`
@@ -641,7 +641,7 @@ The [`useChat`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) composable
641
641
- Stopping generation with `stop()`
642
642
- Regenerating responses with `regenerate()`
643
643
644
-
The `onData` callback receives [custom data events](https://ai-sdk.dev/docs/ai-sdk-ui/streaming-data) from the server (like `data-chat-title`), allowing you to react to server-side events during streaming.
644
+
The `onData` callback receives [custom data events](https://ai-sdk.dev/docs/ai-sdk-ui/streaming-data) from the server (like `data-chat-title`), so you can react to server-side events during streaming.
@@ -1141,7 +1141,9 @@ Then, in the Vercel dashboard:
1141
1141
- Enable **AI Gateway** and add credits so requests can be processed.
1142
1142
- Add a **Turso** database from the Vercel Marketplace and connect it to your project (it will provision the database and add the required environment variables automatically).
1143
1143
1144
-
> Note: On Vercel, you **don’t need to manually add `AI_GATEWAY_API_KEY`** — Vercel handles the gateway configuration for deployments. Keep using `.env` locally for development.
1144
+
::note
1145
+
On Vercel you don't need to manually add `AI_GATEWAY_API_KEY`. Vercel handles the gateway configuration for deployments. Keep using `.env` locally for development.
Copy file name to clipboardExpand all lines: docs/content/docs/1.getting-started/2.installation/2.vue.md
+56-3Lines changed: 56 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,7 +140,7 @@ These declaration files are only written when Vite runs. The default `create-vue
140
140
::
141
141
142
142
::tip
143
-
Internally, Nuxt UI relies on custom alias to resolve the theme types. If you're using TypeScript, you should add an alias to your `tsconfig` to enable auto-completion in your `vite.config.ts`.
143
+
Internally, Nuxt UI relies on custom aliases to resolve the theme types. If you're using TypeScript, add these aliases to your `tsconfig` files to enable auto-completion in your `vite.config.ts`.
144
144
145
145
```json [tsconfig.node.json]
146
146
{
@@ -268,7 +268,7 @@ Import the CSS file in your entrypoint.
268
268
269
269
:::code-group{sync="vite"}
270
270
271
-
```ts [src/main.ts]{1}
271
+
```ts [src/main.ts (Vite)]{1}
272
272
import'./assets/css/main.css'
273
273
274
274
import { createApp } from'vue'
@@ -560,7 +560,7 @@ export default defineConfig({
560
560
561
561
### `ui`
562
562
563
-
Use the `ui` option to provide configuration for Nuxt UI.
563
+
Use the `ui` option to provide configuration for Nuxt UI. This is the Vue equivalent of the `ui` key in Nuxt's `app.config.ts`.
Use the `dts` option to enable or disable the generation of declaration files for auto-imported components and composables.
588
+
589
+
- Default: `true`{lang="ts-type"}
590
+
591
+
```ts [vite.config.ts] {9}
592
+
import { defineConfig } from'vite'
593
+
importvuefrom'@vitejs/plugin-vue'
594
+
importuifrom'@nuxt/ui/vite'
595
+
596
+
exportdefaultdefineConfig({
597
+
plugins: [
598
+
vue(),
599
+
ui({
600
+
dts: false
601
+
})
602
+
]
603
+
})
604
+
```
605
+
606
+
### `icon`
607
+
608
+
Use the `icon` option to set default props for the [Icon](/docs/components/icon) component (`size`, `mode`, `customize`) and to configure build-time icon bundling through `clientBundle`. Bundling of Nuxt UI's own icons is enabled by default when their collection is installed. Set `clientBundle: false` to opt out.
Copy file name to clipboardExpand all lines: docs/content/docs/1.getting-started/3.migration/1.v4.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ links:
12
12
Nuxt UI v4 marks a major milestone: **Nuxt UI and Nuxt UI Pro are now unified into a single, fully open-source and free library**. You now have access to 125+ production-ready components, all available in the `@nuxt/ui` package.
13
13
14
14
::note
15
-
Nuxt UI v4 requires **Nuxt 4** due to some dependencies. Make sure to upgrade to Nuxt 4 before migrating to Nuxt UI v4.
15
+
Nuxt UI v4 requires **Nuxt 4.1 or later** due to some dependencies. Make sure to upgrade before migrating to Nuxt UI v4.
16
16
::
17
17
18
18
This guide provides step-by-step instructions to migrate your application from v3 to v4.
2. The `useChat` composable API changed —`input` and `handleSubmit` were removed in favor of `sendMessage`, and `messages` is now a ref you set directly:
390
+
2. The `useChat` composable API changed:`input` and `handleSubmit` were removed in favor of `sendMessage`, and `messages` is now a ref you set directly:
0 commit comments