@assistant-ui/mcp-docs-server 0.1.20 → 0.1.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/code-examples/with-ag-ui.md +112 -16
- package/.docs/organized/code-examples/with-ai-sdk-v6.md +5 -5
- package/.docs/organized/code-examples/with-assistant-transport.md +3 -3
- package/.docs/organized/code-examples/with-cloud.md +5 -5
- package/.docs/organized/code-examples/with-custom-thread-list.md +5 -5
- package/.docs/organized/code-examples/with-elevenlabs-scribe.md +8 -8
- package/.docs/organized/code-examples/with-external-store.md +4 -4
- package/.docs/organized/code-examples/with-ffmpeg.md +5 -5
- package/.docs/organized/code-examples/with-langgraph.md +3 -3
- package/.docs/organized/code-examples/with-parent-id-grouping.md +4 -4
- package/.docs/organized/code-examples/with-react-hook-form.md +6 -6
- package/.docs/organized/code-examples/with-react-router.md +4 -4
- package/.docs/organized/code-examples/with-store.md +3 -3
- package/.docs/organized/code-examples/with-tanstack.md +6 -6
- package/.docs/organized/code-examples/with-tap-runtime.md +812 -0
- package/.docs/raw/docs/(docs)/copilots/make-assistant-tool-ui.mdx +0 -1
- package/.docs/raw/docs/(docs)/copilots/make-assistant-tool.mdx +0 -1
- package/.docs/raw/docs/(docs)/devtools.mdx +0 -1
- package/.docs/raw/docs/(docs)/guides/attachments.mdx +0 -1
- package/.docs/raw/docs/(docs)/installation.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/context-providers/text-message-part-provider.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +1 -2
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-hook-form.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/integrations/vercel-ai-sdk.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +13 -45
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +12 -35
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +3 -11
- package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +0 -3
- package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +5 -16
- package/.docs/raw/docs/(reference)/api-reference/primitives/composition.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +1 -2
- package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +1 -2
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +1 -2
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +1 -2
- package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +2 -3
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +1 -2
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +1 -2
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +0 -1
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +1 -2
- package/.docs/raw/docs/(reference)/legacy/styled/assistant-modal.mdx +0 -1
- package/.docs/raw/docs/(reference)/legacy/styled/markdown.mdx +0 -1
- package/.docs/raw/docs/(reference)/legacy/styled/thread.mdx +0 -1
- package/.docs/raw/docs/(reference)/react-compatibility.mdx +0 -1
- package/.docs/raw/docs/cloud/persistence/ai-sdk.mdx +0 -1
- package/.docs/raw/docs/cloud/persistence/langgraph.mdx +0 -1
- package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +0 -1
- package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +118 -0
- package/.docs/raw/docs/runtimes/ai-sdk/v6.mdx +198 -0
- package/.docs/raw/docs/runtimes/custom/custom-thread-list.mdx +0 -1
- package/.docs/raw/docs/runtimes/custom/external-store.mdx +9 -11
- package/.docs/raw/docs/runtimes/custom/local.mdx +0 -2
- package/.docs/raw/docs/runtimes/data-stream.mdx +0 -1
- package/.docs/raw/docs/runtimes/langgraph/index.mdx +1 -2
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-3.mdx +0 -1
- package/.docs/raw/docs/runtimes/langserve.mdx +0 -1
- package/.docs/raw/docs/runtimes/mastra/full-stack-integration.mdx +0 -1
- package/.docs/raw/docs/runtimes/mastra/separate-server-integration.mdx +0 -1
- package/.docs/raw/docs/ui/accordion.mdx +0 -2
- package/.docs/raw/docs/ui/assistant-modal.mdx +1 -3
- package/.docs/raw/docs/ui/assistant-sidebar.mdx +1 -3
- package/.docs/raw/docs/ui/attachment.mdx +0 -2
- package/.docs/raw/docs/ui/badge.mdx +0 -2
- package/.docs/raw/docs/ui/diff-viewer.mdx +279 -0
- package/.docs/raw/docs/ui/file.mdx +0 -1
- package/.docs/raw/docs/ui/image.mdx +0 -1
- package/.docs/raw/docs/ui/markdown.mdx +0 -1
- package/.docs/raw/docs/ui/mermaid.mdx +0 -1
- package/.docs/raw/docs/ui/model-selector.mdx +0 -2
- package/.docs/raw/docs/ui/part-grouping.mdx +2 -3
- package/.docs/raw/docs/ui/reasoning.mdx +2 -3
- package/.docs/raw/docs/ui/scrollbar.mdx +26 -9
- package/.docs/raw/docs/ui/select.mdx +0 -2
- package/.docs/raw/docs/ui/sources.mdx +0 -1
- package/.docs/raw/docs/ui/syntax-highlighting.mdx +8 -63
- package/.docs/raw/docs/ui/tabs.mdx +0 -2
- package/.docs/raw/docs/ui/thread-list.mdx +98 -16
- package/.docs/raw/docs/ui/thread.mdx +1 -3
- package/.docs/raw/docs/ui/tool-fallback.mdx +0 -1
- package/.docs/raw/docs/ui/tool-group.mdx +1 -3
- package/package.json +2 -2
- package/.docs/raw/docs/runtimes/ai-sdk/use-chat.mdx +0 -219
|
@@ -3,7 +3,6 @@ title: makeAssistantToolUI
|
|
|
3
3
|
description: Register custom UI components to render tool executions and their status.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
6
|
|
|
8
7
|
The `makeAssistantToolUI` utility is used to register a tool UI component with the Assistant.
|
|
9
8
|
|
|
@@ -3,7 +3,6 @@ title: makeAssistantTool
|
|
|
3
3
|
description: Create React components that provide reusable tools to the assistant.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
6
|
|
|
8
7
|
`makeAssistantTool` creates a React component that provides a tool to the assistant. This is useful for defining reusable tools that can be composed into your application.
|
|
9
8
|
|
|
@@ -3,7 +3,6 @@ title: DevTools
|
|
|
3
3
|
description: Inspect runtime state, context, and events in the browser.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
7
6
|
|
|
8
7
|
Hey, the assistant-ui DevTools allows you to debug the assistant-ui state and context, and events without resorting to `console.log`. It's an easy way to see how data flows to the assistant-ui's runtime layer.
|
|
9
8
|
|
|
@@ -4,7 +4,6 @@ description: Let users attach files, images, and documents to messages.
|
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
import { AttachmentSample } from "@/components/docs/samples/attachment";
|
|
7
|
-
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
8
7
|
|
|
9
8
|
Enable users to attach files to their messages, enhancing conversations with images, documents, and other content.
|
|
10
9
|
|
package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx
CHANGED
|
@@ -3,7 +3,6 @@ title: <AssistantRuntimeProvider />
|
|
|
3
3
|
description: Root provider that connects your runtime to assistant-ui components.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
6
|
import { AssistantRuntimeProvider } from "@/generated/typeDocs";
|
|
8
7
|
|
|
9
8
|
The `AssistantRuntimeProvider` provides data and APIs used by assistant-ui components.
|
package/.docs/raw/docs/(reference)/api-reference/context-providers/text-message-part-provider.mdx
CHANGED
|
@@ -3,7 +3,6 @@ title: <TextMessagePartProvider />
|
|
|
3
3
|
description: Context provider for reusing text components outside of message content.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
6
|
import { AssistantRuntimeProvider } from "@/generated/typeDocs";
|
|
8
7
|
|
|
9
8
|
The `TextMessagePartProvider` provides data and APIs for `TextMessagePart` components.
|
|
@@ -5,7 +5,6 @@ description: Hooks for connecting to data stream protocol endpoints and Assistan
|
|
|
5
5
|
|
|
6
6
|
Data Stream protocol integration for assistant-ui.
|
|
7
7
|
|
|
8
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
9
8
|
|
|
10
9
|
## API Reference
|
|
11
10
|
|
|
@@ -238,4 +237,4 @@ By default, filters out disabled tools and backend-only tools. Use the `filter`
|
|
|
238
237
|
const allTools = toToolsJSONSchema(tools, {
|
|
239
238
|
filter: () => true, // Include all tools
|
|
240
239
|
});
|
|
241
|
-
```
|
|
240
|
+
```
|
|
@@ -5,7 +5,6 @@ description: Vercel AI SDK v5 integration with chat runtime hooks and transport
|
|
|
5
5
|
|
|
6
6
|
Vercel AI SDK integration for assistant-ui.
|
|
7
7
|
|
|
8
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
9
8
|
|
|
10
9
|
<Callout type="info">
|
|
11
10
|
This package provides integration with AI SDK v5. For AI SDK v4, see the [AI
|
|
@@ -4,9 +4,6 @@ title: ActionBarMorePrimitive
|
|
|
4
4
|
|
|
5
5
|
A dropdown menu for additional actions that don't fit in the main action bar.
|
|
6
6
|
|
|
7
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
8
|
-
import { DataAttributesTable } from "@/components/docs/tables/DataAttributesTable";
|
|
9
|
-
import { Code } from "@radix-ui/themes";
|
|
10
7
|
|
|
11
8
|
## Anatomy
|
|
12
9
|
|
|
@@ -97,18 +94,10 @@ This primitive renders a `<button>` element unless `asChild` is set.
|
|
|
97
94
|
]}
|
|
98
95
|
/>
|
|
99
96
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
values: <Code>"open" | "closed"</Code>,
|
|
105
|
-
},
|
|
106
|
-
{
|
|
107
|
-
attribute: "[data-disabled]",
|
|
108
|
-
values: "Present when disabled",
|
|
109
|
-
},
|
|
110
|
-
]}
|
|
111
|
-
/>
|
|
97
|
+
| Data attribute | Values |
|
|
98
|
+
| --- | --- |
|
|
99
|
+
| `[data-state]` | `"open" \| "closed"` |
|
|
100
|
+
| `[data-disabled]` | Present when disabled |
|
|
112
101
|
|
|
113
102
|
### Content
|
|
114
103
|
|
|
@@ -154,22 +143,11 @@ This primitive renders a `<div>` element unless `asChild` is set.
|
|
|
154
143
|
]}
|
|
155
144
|
/>
|
|
156
145
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
},
|
|
163
|
-
{
|
|
164
|
-
attribute: "[data-side]",
|
|
165
|
-
values: <Code>"top" | "right" | "bottom" | "left"</Code>,
|
|
166
|
-
},
|
|
167
|
-
{
|
|
168
|
-
attribute: "[data-align]",
|
|
169
|
-
values: <Code>"start" | "center" | "end"</Code>,
|
|
170
|
-
},
|
|
171
|
-
]}
|
|
172
|
-
/>
|
|
146
|
+
| Data attribute | Values |
|
|
147
|
+
| --- | --- |
|
|
148
|
+
| `[data-state]` | `"open" \| "closed"` |
|
|
149
|
+
| `[data-side]` | `"top" \| "right" \| "bottom" \| "left"` |
|
|
150
|
+
| `[data-align]` | `"start" \| "center" \| "end"` |
|
|
173
151
|
|
|
174
152
|
Refer to Radix UI's Documentation for [DropdownMenu.Content](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#content) for more details.
|
|
175
153
|
|
|
@@ -205,18 +183,10 @@ This primitive renders a `<div>` element unless `asChild` is set.
|
|
|
205
183
|
]}
|
|
206
184
|
/>
|
|
207
185
|
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
values: "Present when disabled",
|
|
213
|
-
},
|
|
214
|
-
{
|
|
215
|
-
attribute: "[data-highlighted]",
|
|
216
|
-
values: "Present when highlighted",
|
|
217
|
-
},
|
|
218
|
-
]}
|
|
219
|
-
/>
|
|
186
|
+
| Data attribute | Values |
|
|
187
|
+
| --- | --- |
|
|
188
|
+
| `[data-disabled]` | Present when disabled |
|
|
189
|
+
| `[data-highlighted]` | Present when highlighted |
|
|
220
190
|
|
|
221
191
|
Refer to Radix UI's Documentation for [DropdownMenu.Item](https://www.radix-ui.com/primitives/docs/components/dropdown-menu#item) for more details.
|
|
222
192
|
|
|
@@ -323,5 +293,3 @@ const MoreActionsWithHooks = () => {
|
|
|
323
293
|
);
|
|
324
294
|
};
|
|
325
295
|
```
|
|
326
|
-
|
|
327
|
-
|
|
@@ -5,9 +5,6 @@ description: Buttons for message actions like copy, edit, reload, speak, and fee
|
|
|
5
5
|
|
|
6
6
|
Buttons to interact with the message.
|
|
7
7
|
|
|
8
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
9
|
-
import { DataAttributesTable } from "@/components/docs/tables/DataAttributesTable";
|
|
10
|
-
import { Code } from "@radix-ui/themes";
|
|
11
8
|
|
|
12
9
|
## Anatomy
|
|
13
10
|
|
|
@@ -93,14 +90,9 @@ This primitive renders a `<div>` element unless `asChild` is set.
|
|
|
93
90
|
]}
|
|
94
91
|
/>
|
|
95
92
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
attribute: "[data-floating]",
|
|
100
|
-
values: "Present when floating",
|
|
101
|
-
},
|
|
102
|
-
]}
|
|
103
|
-
/>
|
|
93
|
+
| Data attribute | Values |
|
|
94
|
+
| --- | --- |
|
|
95
|
+
| `[data-floating]` | Present when floating |
|
|
104
96
|
|
|
105
97
|
### Edit
|
|
106
98
|
|
|
@@ -154,14 +146,9 @@ This primitive renders a `<button>` element unless `asChild` is set.
|
|
|
154
146
|
]}
|
|
155
147
|
/>
|
|
156
148
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
attribute: "[data-copied]",
|
|
161
|
-
values: "Present when the message was recently copied.",
|
|
162
|
-
},
|
|
163
|
-
]}
|
|
164
|
-
/>
|
|
149
|
+
| Data attribute | Values |
|
|
150
|
+
| --- | --- |
|
|
151
|
+
| `[data-copied]` | Present when the message was recently copied. |
|
|
165
152
|
|
|
166
153
|
#### Copied state
|
|
167
154
|
|
|
@@ -232,14 +219,9 @@ This primitive renders a `<button>` element unless `asChild` is set.
|
|
|
232
219
|
]}
|
|
233
220
|
/>
|
|
234
221
|
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
attribute: "[data-submitted]",
|
|
239
|
-
values: "Present when positive feedback was submitted.",
|
|
240
|
-
},
|
|
241
|
-
]}
|
|
242
|
-
/>
|
|
222
|
+
| Data attribute | Values |
|
|
223
|
+
| --- | --- |
|
|
224
|
+
| `[data-submitted]` | Present when positive feedback was submitted. |
|
|
243
225
|
|
|
244
226
|
### Feedback Negative
|
|
245
227
|
|
|
@@ -256,14 +238,9 @@ This primitive renders a `<button>` element unless `asChild` is set.
|
|
|
256
238
|
]}
|
|
257
239
|
/>
|
|
258
240
|
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
attribute: "[data-submitted]",
|
|
263
|
-
values: "Present when negative feedback was submitted.",
|
|
264
|
-
},
|
|
265
|
-
]}
|
|
266
|
-
/>
|
|
241
|
+
| Data attribute | Values |
|
|
242
|
+
| --- | --- |
|
|
243
|
+
| `[data-submitted]` | Present when negative feedback was submitted. |
|
|
267
244
|
|
|
268
245
|
### ExportMarkdown
|
|
269
246
|
|
|
@@ -5,9 +5,6 @@ description: A popover chat interface for floating assistant UI in the corner of
|
|
|
5
5
|
|
|
6
6
|
A modal chat UI usually displayed in the bottom right corner of the screen.
|
|
7
7
|
|
|
8
|
-
import { Code } from "@radix-ui/themes";
|
|
9
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
10
|
-
import { DataAttributesTable } from "@/components/docs/tables/DataAttributesTable";
|
|
11
8
|
|
|
12
9
|
## Anatomy
|
|
13
10
|
|
|
@@ -79,14 +76,9 @@ This primitive renders a `<button>` element unless `asChild` is set.
|
|
|
79
76
|
]}
|
|
80
77
|
/>
|
|
81
78
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
attribute: "[data-state]",
|
|
86
|
-
values: <Code>"open" | "closed"</Code>,
|
|
87
|
-
},
|
|
88
|
-
]}
|
|
89
|
-
/>
|
|
79
|
+
| Data attribute | Values |
|
|
80
|
+
| --- | --- |
|
|
81
|
+
| `[data-state]` | `"open" \| "closed"` |
|
|
90
82
|
|
|
91
83
|
### Anchor
|
|
92
84
|
|
|
@@ -5,9 +5,6 @@ description: Components for displaying and managing file attachments in messages
|
|
|
5
5
|
|
|
6
6
|
Buttons to interact with attachments.
|
|
7
7
|
|
|
8
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
9
|
-
import { DataAttributesTable } from "@/components/docs/tables/DataAttributesTable";
|
|
10
|
-
import { Code } from "@radix-ui/themes";
|
|
11
8
|
|
|
12
9
|
<Callout>
|
|
13
10
|
**Dual Use!** Attachments can appear in both messages and composers.
|
|
@@ -6,9 +6,6 @@ description: Primitives for the text input, send button, and attachments.
|
|
|
6
6
|
The user interface to add new messages or edit existing ones.
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
10
|
-
import { KeyboardTable } from "@/components/docs/tables/KeyboardTable";
|
|
11
|
-
import { Code } from "@radix-ui/themes";
|
|
12
9
|
|
|
13
10
|
<Callout>
|
|
14
11
|
**Dual Use!** A Composer placed directly inside a `Thread` will compose new
|
|
@@ -88,18 +85,10 @@ This primitive renders a `<textarea>` element unless `asChild` is set.
|
|
|
88
85
|
|
|
89
86
|
#### Keyboard Shortcuts
|
|
90
87
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
description: "Sends the message.",
|
|
96
|
-
},
|
|
97
|
-
{
|
|
98
|
-
keys: ["Escape"],
|
|
99
|
-
description: "Sends a cancel action.",
|
|
100
|
-
},
|
|
101
|
-
]}
|
|
102
|
-
/>
|
|
88
|
+
| Key | Description |
|
|
89
|
+
| --- | --- |
|
|
90
|
+
| <Kbd>Enter</Kbd> | Sends the message. |
|
|
91
|
+
| <Kbd>Escape</Kbd> | Sends a cancel action. |
|
|
103
92
|
|
|
104
93
|
### Send
|
|
105
94
|
|
|
@@ -126,7 +115,7 @@ This primitive renders a `<button>` element unless `asChild` is set.
|
|
|
126
115
|
|
|
127
116
|
Sends a cancel action.
|
|
128
117
|
|
|
129
|
-
In edit composers, this action exits the edit mode.
|
|
118
|
+
In edit composers, this action exits the edit mode.
|
|
130
119
|
In thread composers, this action stops the current run.
|
|
131
120
|
|
|
132
121
|
This primitive renders a `<button>` element unless `asChild` is set.
|
|
@@ -3,7 +3,6 @@ title: Composition
|
|
|
3
3
|
description: How to compose primitives with custom components using asChild.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { Code } from "@radix-ui/themes";
|
|
7
6
|
|
|
8
7
|
`assistant-ui` primitives are composable. This means that all props are forwarded, classes are merged, and event handlers are chained.
|
|
9
8
|
|
|
@@ -3,7 +3,6 @@ title: MessagePartPrimitive
|
|
|
3
3
|
description: Primitives for text, images, tool calls, and other message content.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
6
|
import {
|
|
8
7
|
MessagePartRuntime,
|
|
9
8
|
TextMessagePartState,
|
|
@@ -11,7 +10,7 @@ import {
|
|
|
11
10
|
ToolCallMessagePartState,
|
|
12
11
|
} from "@/generated/typeDocs";
|
|
13
12
|
|
|
14
|
-
Each message can have any number of message parts.
|
|
13
|
+
Each message can have any number of message parts.
|
|
15
14
|
Message parts are usually one of text, reasoning, audio or tool-call.
|
|
16
15
|
|
|
17
16
|
## Message part Types
|
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
title: SuggestionPrimitive
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
6
5
|
|
|
7
6
|
Primitives for rendering individual suggestions. These primitives must be used within a suggestion context provided by `ThreadPrimitive.Suggestions`.
|
|
8
7
|
|
|
@@ -5,7 +5,6 @@ description: Dropdown menu for additional thread actions like archive and delete
|
|
|
5
5
|
|
|
6
6
|
A dropdown menu for displaying additional actions on a thread list item. Built on top of [Radix UI Dropdown Menu](https://www.radix-ui.com/primitives/docs/components/dropdown-menu).
|
|
7
7
|
|
|
8
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
9
8
|
|
|
10
9
|
## Anatomy
|
|
11
10
|
|
|
@@ -5,7 +5,6 @@ description: Individual thread item with title, archive, and delete controls.
|
|
|
5
5
|
|
|
6
6
|
A single thread item within a thread list.
|
|
7
7
|
|
|
8
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
9
8
|
|
|
10
9
|
## Anatomy
|
|
11
10
|
|
|
@@ -158,4 +157,4 @@ const ArchivedThreadListItem = () => {
|
|
|
158
157
|
</ThreadListItemPrimitive.Root>
|
|
159
158
|
);
|
|
160
159
|
};
|
|
161
|
-
```
|
|
160
|
+
```
|
|
@@ -5,7 +5,6 @@ description: Display and manage multiple conversation threads with create and ar
|
|
|
5
5
|
|
|
6
6
|
Displays a list of conversation threads.
|
|
7
7
|
|
|
8
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
9
8
|
|
|
10
9
|
## Anatomy
|
|
11
10
|
|
|
@@ -126,4 +125,4 @@ Renders a single thread list item at the specified index.
|
|
|
126
125
|
description: "The components to render for the thread list item.",
|
|
127
126
|
},
|
|
128
127
|
]}
|
|
129
|
-
/>
|
|
128
|
+
/>
|
|
@@ -3,7 +3,6 @@ title: AssistantRuntime
|
|
|
3
3
|
description: Root runtime for managing threads, tool UIs, and assistant state.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
6
|
import { AssistantRuntime, AssistantToolUIsState } from "@/generated/typeDocs";
|
|
8
7
|
|
|
9
8
|
The `AssistantRuntime` is the root runtime of the application.
|
|
@@ -3,11 +3,10 @@ title: AttachmentRuntime
|
|
|
3
3
|
description: Hooks for accessing attachment state in composer and messages.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
6
|
import {
|
|
8
7
|
ComposerAttachmentState,
|
|
9
8
|
MessageAttachmentState,
|
|
10
|
-
} from "@/components/docs/
|
|
9
|
+
} from "@/components/docs/parameters-table.context";
|
|
11
10
|
|
|
12
11
|
### `useAttachment`
|
|
13
12
|
|
|
@@ -5,7 +5,6 @@ description: Runtime for programmatically controlling the message composer.
|
|
|
5
5
|
|
|
6
6
|
The composer runtime allows you to view or edit anything related to how new information is added and sent. For instance you can use the composer runtime to read the state, add attachments, update text, send a message, etc.
|
|
7
7
|
|
|
8
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
9
8
|
import { ComposerRuntime, ThreadComposerRuntime, ThreadComposerState, EditComposerState } from "@/generated/typeDocs";
|
|
10
9
|
|
|
11
10
|
### `useComposerRuntime`
|
|
@@ -21,7 +20,7 @@ const composerRuntime = useComposerRuntime();
|
|
|
21
20
|
// set the text
|
|
22
21
|
composerRuntime.setText("Hello from the composer runtime");
|
|
23
22
|
|
|
24
|
-
// send whatever is in the composer
|
|
23
|
+
// send whatever is in the composer
|
|
25
24
|
composerRuntime.send();
|
|
26
25
|
|
|
27
26
|
// get the current text in the composer state
|
|
@@ -45,7 +44,7 @@ const threadComposerRuntime = useThreadComposer();
|
|
|
45
44
|
// set the text
|
|
46
45
|
threadComposerRuntime.setText("Hello from the thread composer runtime");
|
|
47
46
|
|
|
48
|
-
// send whatever is in the thread composer
|
|
47
|
+
// send whatever is in the thread composer
|
|
49
48
|
threadComposerRuntime.send();
|
|
50
49
|
|
|
51
50
|
// get the current text in the composer state
|
|
@@ -3,8 +3,7 @@ title: MessagePartRuntime
|
|
|
3
3
|
description: Hook for accessing message part state within parts.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import {
|
|
7
|
-
import { MessagePartState } from "@/components/docs/tables/parameters/context";
|
|
6
|
+
import { MessagePartState } from "@/components/docs/parameters-table.context";
|
|
8
7
|
|
|
9
8
|
### `useMessagePart`
|
|
10
9
|
|
|
@@ -3,12 +3,11 @@ title: MessageRuntime
|
|
|
3
3
|
description: Hooks for accessing message state, utilities, and edit composer.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
6
|
import {
|
|
8
7
|
MessageState,
|
|
9
8
|
MessageUtilsState,
|
|
10
9
|
EditComposerState,
|
|
11
|
-
} from "@/components/docs/
|
|
10
|
+
} from "@/components/docs/parameters-table.context";
|
|
12
11
|
|
|
13
12
|
### `useMessage`
|
|
14
13
|
|
|
@@ -3,7 +3,6 @@ title: ThreadListRuntime
|
|
|
3
3
|
description: Runtime for accessing and managing the list of threads.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
6
|
import { ThreadListRuntime, ThreadListState } from "@/generated/typeDocs";
|
|
8
7
|
|
|
9
8
|
### Access via `useAssistantRuntime`
|
|
@@ -3,9 +3,8 @@ title: ThreadRuntime
|
|
|
3
3
|
description: Runtime for thread state, messages, and viewport management.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
6
|
import { ThreadRuntime, ThreadState } from "@/generated/typeDocs";
|
|
8
|
-
import {
|
|
7
|
+
import { ThreadViewportState } from "@/components/docs/parameters-table.context";
|
|
9
8
|
|
|
10
9
|
### `useThreadRuntime`
|
|
11
10
|
|
|
@@ -3,7 +3,6 @@ title: Using old React versions
|
|
|
3
3
|
description: Compatibility notes for React 18, 17, and 16.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
7
6
|
|
|
8
7
|
<Callout type="warning" title="Older React Versions">
|
|
9
8
|
Older React versions are not continuously tested. If you encounter any issues
|