@assistant-ui/mcp-docs-server 0.1.17 → 0.1.19
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 +518 -234
- package/.docs/organized/code-examples/{with-ai-sdk-v5.md → with-ai-sdk-v6.md} +476 -189
- package/.docs/organized/code-examples/with-assistant-transport.md +503 -301
- package/.docs/organized/code-examples/with-cloud.md +524 -226
- package/.docs/organized/code-examples/with-custom-thread-list.md +433 -146
- package/.docs/organized/code-examples/with-elevenlabs-scribe.md +2241 -0
- package/.docs/organized/code-examples/with-external-store.md +517 -231
- package/.docs/organized/code-examples/with-ffmpeg.md +500 -220
- package/.docs/organized/code-examples/with-langgraph.md +630 -319
- package/.docs/organized/code-examples/with-parent-id-grouping.md +517 -231
- package/.docs/organized/code-examples/with-react-hook-form.md +517 -233
- package/.docs/organized/code-examples/with-react-router.md +2167 -0
- package/.docs/organized/code-examples/{store-example.md → with-store.md} +18 -22
- package/.docs/organized/code-examples/with-tanstack.md +23 -41
- package/.docs/raw/blog/2025-01-31-changelog/index.mdx +0 -2
- package/.docs/raw/docs/{about-assistantui.mdx → (docs)/about-assistantui.mdx} +2 -1
- package/.docs/raw/docs/{architecture.mdx → (docs)/architecture.mdx} +3 -2
- package/.docs/raw/docs/{cli.mdx → (docs)/cli.mdx} +1 -19
- package/.docs/raw/docs/{copilots → (docs)/copilots}/make-assistant-readable.mdx +1 -0
- package/.docs/raw/docs/{copilots → (docs)/copilots}/make-assistant-tool-ui.mdx +2 -1
- package/.docs/raw/docs/{copilots → (docs)/copilots}/make-assistant-tool.mdx +2 -1
- package/.docs/raw/docs/{copilots → (docs)/copilots}/model-context.mdx +1 -0
- package/.docs/raw/docs/{copilots → (docs)/copilots}/motivation.mdx +1 -0
- package/.docs/raw/docs/{copilots → (docs)/copilots}/use-assistant-instructions.mdx +1 -0
- package/.docs/raw/docs/{devtools.mdx → (docs)/devtools.mdx} +4 -4
- package/.docs/raw/docs/{guides/Attachments.mdx → (docs)/guides/attachments.mdx} +4 -5
- package/.docs/raw/docs/{guides/Branching.mdx → (docs)/guides/branching.mdx} +2 -1
- package/.docs/raw/docs/{guides → (docs)/guides}/context-api.mdx +1 -0
- package/.docs/raw/docs/(docs)/guides/dictation.mdx +370 -0
- package/.docs/raw/docs/{guides/Editing.mdx → (docs)/guides/editing.mdx} +1 -0
- package/.docs/raw/docs/{guides/Latex.mdx → (docs)/guides/latex.mdx} +1 -2
- package/.docs/raw/docs/{guides/Speech.mdx → (docs)/guides/speech.mdx} +9 -10
- package/.docs/raw/docs/{guides/ToolUI.mdx → (docs)/guides/tool-ui.mdx} +15 -14
- package/.docs/raw/docs/{guides/Tools.mdx → (docs)/guides/tools.mdx} +10 -7
- package/.docs/raw/docs/{getting-started.mdx → (docs)/index.mdx} +17 -22
- package/.docs/raw/docs/{mcp-docs-server.mdx → (docs)/mcp-docs-server.mdx} +1 -2
- package/.docs/raw/docs/{api-reference/context-providers/AssistantRuntimeProvider.mdx → (reference)/api-reference/context-providers/assistant-runtime-provider.mdx} +2 -1
- package/.docs/raw/docs/{api-reference/context-providers/TextMessagePartProvider.mdx → (reference)/api-reference/context-providers/text-message-part-provider.mdx} +2 -1
- package/.docs/raw/docs/{api-reference → (reference)/api-reference}/integrations/react-data-stream.mdx +2 -1
- package/.docs/raw/docs/{api-reference → (reference)/api-reference}/integrations/react-hook-form.mdx +2 -1
- package/.docs/raw/docs/{api-reference → (reference)/api-reference}/integrations/vercel-ai-sdk.mdx +2 -2
- package/.docs/raw/docs/{api-reference → (reference)/api-reference}/overview.mdx +1 -1
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +327 -0
- package/.docs/raw/docs/{api-reference/primitives/ActionBar.mdx → (reference)/api-reference/primitives/action-bar.mdx} +3 -1
- package/.docs/raw/docs/{api-reference/primitives/AssistantIf.mdx → (reference)/api-reference/primitives/assistant-if.mdx} +2 -2
- package/.docs/raw/docs/{api-reference/primitives/AssistantModal.mdx → (reference)/api-reference/primitives/assistant-modal.mdx} +3 -1
- package/.docs/raw/docs/{api-reference/primitives/Attachment.mdx → (reference)/api-reference/primitives/attachment.mdx} +3 -2
- package/.docs/raw/docs/{api-reference/primitives/BranchPicker.mdx → (reference)/api-reference/primitives/branch-picker.mdx} +2 -1
- package/.docs/raw/docs/{api-reference/primitives/Composer.mdx → (reference)/api-reference/primitives/composer.mdx} +101 -2
- package/.docs/raw/docs/{api-reference → (reference)/api-reference}/primitives/composition.mdx +1 -0
- package/.docs/raw/docs/{api-reference/primitives/Error.mdx → (reference)/api-reference/primitives/error.mdx} +2 -1
- package/.docs/raw/docs/{api-reference/primitives/MessagePart.mdx → (reference)/api-reference/primitives/message-part.mdx} +2 -2
- package/.docs/raw/docs/{api-reference/primitives/Message.mdx → (reference)/api-reference/primitives/message.mdx} +2 -1
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +221 -0
- package/.docs/raw/docs/{api-reference/primitives/ThreadListItem.mdx → (reference)/api-reference/primitives/thread-list-item.mdx} +2 -1
- package/.docs/raw/docs/{api-reference/primitives/ThreadList.mdx → (reference)/api-reference/primitives/thread-list.mdx} +2 -1
- package/.docs/raw/docs/{api-reference/primitives/Thread.mdx → (reference)/api-reference/primitives/thread.mdx} +2 -1
- package/.docs/raw/docs/{api-reference/runtimes/AssistantRuntime.mdx → (reference)/api-reference/runtimes/assistant-runtime.mdx} +2 -1
- package/.docs/raw/docs/{api-reference/runtimes/AttachmentRuntime.mdx → (reference)/api-reference/runtimes/attachment-runtime.mdx} +3 -2
- package/.docs/raw/docs/{api-reference/runtimes/ComposerRuntime.mdx → (reference)/api-reference/runtimes/composer-runtime.mdx} +2 -1
- package/.docs/raw/docs/{api-reference/runtimes/MessagePartRuntime.mdx → (reference)/api-reference/runtimes/message-part-runtime.mdx} +3 -2
- package/.docs/raw/docs/{api-reference/runtimes/MessageRuntime.mdx → (reference)/api-reference/runtimes/message-runtime.mdx} +3 -2
- package/.docs/raw/docs/{api-reference/runtimes/ThreadListItemRuntime.mdx → (reference)/api-reference/runtimes/thread-list-item-runtime.mdx} +2 -1
- package/.docs/raw/docs/{api-reference/runtimes/ThreadListRuntime.mdx → (reference)/api-reference/runtimes/thread-list-runtime.mdx} +2 -1
- package/.docs/raw/docs/{api-reference/runtimes/ThreadRuntime.mdx → (reference)/api-reference/runtimes/thread-runtime.mdx} +3 -5
- package/.docs/raw/docs/{legacy/styled/AssistantModal.mdx → (reference)/legacy/styled/assistant-modal.mdx} +2 -3
- package/.docs/raw/docs/{legacy/styled/Decomposition.mdx → (reference)/legacy/styled/decomposition.mdx} +1 -0
- package/.docs/raw/docs/{legacy/styled/Markdown.mdx → (reference)/legacy/styled/markdown.mdx} +2 -4
- package/.docs/raw/docs/{legacy/styled/Scrollbar.mdx → (reference)/legacy/styled/scrollbar.mdx} +2 -1
- package/.docs/raw/docs/{legacy/styled/ThreadWidth.mdx → (reference)/legacy/styled/thread-width.mdx} +1 -0
- package/.docs/raw/docs/{legacy/styled/Thread.mdx → (reference)/legacy/styled/thread.mdx} +2 -3
- package/.docs/raw/docs/{migrations → (reference)/migrations}/deprecation-policy.mdx +1 -0
- package/.docs/raw/docs/{migrations → (reference)/migrations}/react-langgraph-v0-7.mdx +1 -2
- package/.docs/raw/docs/{migrations → (reference)/migrations}/v0-11.mdx +1 -0
- package/.docs/raw/docs/{migrations → (reference)/migrations}/v0-12.mdx +1 -0
- package/.docs/raw/docs/{react-compatibility.mdx → (reference)/react-compatibility.mdx} +2 -3
- package/.docs/raw/docs/cloud/authorization.mdx +1 -0
- package/.docs/raw/docs/cloud/overview.mdx +1 -0
- package/.docs/raw/docs/cloud/persistence/ai-sdk.mdx +2 -3
- package/.docs/raw/docs/cloud/persistence/langgraph.mdx +5 -7
- package/.docs/raw/docs/runtimes/ai-sdk/use-chat.mdx +9 -8
- package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +2 -3
- package/.docs/raw/docs/runtimes/assistant-transport.mdx +7 -6
- package/.docs/raw/docs/runtimes/custom/custom-thread-list.mdx +38 -3
- package/.docs/raw/docs/runtimes/custom/external-store.mdx +6 -8
- package/.docs/raw/docs/runtimes/custom/local.mdx +43 -16
- package/.docs/raw/docs/runtimes/data-stream.mdx +32 -4
- package/.docs/raw/docs/runtimes/helicone.mdx +1 -0
- package/.docs/raw/docs/runtimes/langgraph/index.mdx +3 -3
- package/.docs/raw/docs/runtimes/langgraph/tutorial/index.mdx +1 -0
- package/.docs/raw/docs/runtimes/langgraph/tutorial/introduction.mdx +1 -0
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-1.mdx +1 -0
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +1 -0
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-3.mdx +2 -1
- package/.docs/raw/docs/runtimes/langserve.mdx +2 -2
- package/.docs/raw/docs/runtimes/mastra/full-stack-integration.mdx +4 -5
- package/.docs/raw/docs/runtimes/mastra/overview.mdx +1 -0
- package/.docs/raw/docs/runtimes/mastra/separate-server-integration.mdx +3 -4
- package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +2 -4
- package/.docs/raw/docs/ui/assistant-modal.mdx +163 -0
- package/.docs/raw/docs/ui/assistant-sidebar.mdx +90 -0
- package/.docs/raw/docs/ui/attachment.mdx +227 -0
- package/.docs/raw/docs/ui/{Markdown.mdx → markdown.mdx} +11 -6
- package/.docs/raw/docs/ui/{Mermaid.mdx → mermaid.mdx} +12 -5
- package/.docs/raw/docs/ui/{PartGrouping.mdx → part-grouping.mdx} +4 -6
- package/.docs/raw/docs/ui/reasoning.mdx +148 -0
- package/.docs/raw/docs/ui/{Scrollbar.mdx → scrollbar.mdx} +9 -7
- package/.docs/raw/docs/ui/sources.mdx +87 -0
- package/.docs/raw/docs/ui/{SyntaxHighlighting.mdx → syntax-highlighting.mdx} +9 -5
- package/.docs/raw/docs/ui/thread-list.mdx +275 -0
- package/.docs/raw/docs/ui/{Thread.mdx → thread.mdx} +5 -6
- package/.docs/raw/docs/ui/tool-fallback.mdx +112 -0
- package/.docs/raw/docs/ui/tool-group.mdx +214 -0
- package/dist/constants.d.ts +10 -0
- package/dist/constants.d.ts.map +1 -0
- package/dist/constants.js +14 -0
- package/dist/constants.js.map +1 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +33 -1
- package/dist/index.js.map +1 -0
- package/dist/prepare-docs/code-examples.d.ts +2 -0
- package/dist/prepare-docs/code-examples.d.ts.map +1 -0
- package/dist/prepare-docs/code-examples.js +129 -0
- package/dist/prepare-docs/code-examples.js.map +1 -0
- package/dist/prepare-docs/copy-raw.d.ts +2 -0
- package/dist/prepare-docs/copy-raw.d.ts.map +1 -0
- package/dist/prepare-docs/copy-raw.js +50 -0
- package/dist/prepare-docs/copy-raw.js.map +1 -0
- package/dist/prepare-docs/prepare.d.ts +2 -0
- package/dist/prepare-docs/prepare.d.ts.map +1 -0
- package/dist/prepare-docs/prepare.js +18 -195
- package/dist/prepare-docs/prepare.js.map +1 -0
- package/dist/stdio.d.ts +3 -0
- package/dist/stdio.d.ts.map +1 -0
- package/dist/stdio.js +4 -5
- package/dist/stdio.js.map +1 -0
- package/dist/tools/docs.d.ts +23 -0
- package/dist/tools/docs.d.ts.map +1 -0
- package/dist/tools/docs.js +168 -0
- package/dist/tools/docs.js.map +1 -0
- package/dist/tools/examples.d.ts +23 -0
- package/dist/tools/examples.d.ts.map +1 -0
- package/dist/tools/examples.js +95 -0
- package/dist/tools/examples.js.map +1 -0
- package/dist/tools/tests/test-setup.d.ts +4 -0
- package/dist/tools/tests/test-setup.d.ts.map +1 -0
- package/dist/tools/tests/test-setup.js +36 -0
- package/dist/tools/tests/test-setup.js.map +1 -0
- package/dist/utils/logger.d.ts +7 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +20 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/utils/mcp-format.d.ts +7 -0
- package/dist/utils/mcp-format.d.ts.map +1 -0
- package/dist/utils/mcp-format.js +11 -0
- package/dist/utils/mcp-format.js.map +1 -0
- package/dist/utils/mdx.d.ts +9 -0
- package/dist/utils/mdx.d.ts.map +1 -0
- package/dist/utils/mdx.js +27 -0
- package/dist/utils/mdx.js.map +1 -0
- package/dist/utils/paths.d.ts +8 -0
- package/dist/utils/paths.d.ts.map +1 -0
- package/dist/utils/paths.js +84 -0
- package/dist/utils/paths.js.map +1 -0
- package/dist/utils/security.d.ts +2 -0
- package/dist/utils/security.d.ts.map +1 -0
- package/dist/utils/security.js +43 -0
- package/dist/utils/security.js.map +1 -0
- package/package.json +37 -19
- package/src/constants.ts +22 -0
- package/src/index.ts +51 -0
- package/src/prepare-docs/code-examples.ts +158 -0
- package/src/prepare-docs/copy-raw.ts +55 -0
- package/src/prepare-docs/prepare.ts +24 -0
- package/src/stdio.ts +7 -0
- package/src/tools/docs.ts +207 -0
- package/src/tools/examples.ts +107 -0
- package/src/tools/tests/docs.test.ts +124 -0
- package/src/tools/tests/examples.test.ts +94 -0
- package/src/tools/tests/integration.test.ts +46 -0
- package/src/tools/tests/json-parsing.test.ts +23 -0
- package/src/tools/tests/mcp-protocol.test.ts +133 -0
- package/src/tools/tests/path-traversal.test.ts +81 -0
- package/src/tools/tests/test-setup.ts +40 -0
- package/src/utils/logger.ts +20 -0
- package/src/utils/mcp-format.ts +12 -0
- package/src/utils/mdx.ts +39 -0
- package/src/utils/paths.ts +114 -0
- package/src/utils/security.ts +52 -0
- package/src/utils/tests/security.test.ts +119 -0
- package/.docs/raw/docs/index.mdx +0 -7
- package/.docs/raw/docs/ui/AssistantModal.mdx +0 -45
- package/.docs/raw/docs/ui/AssistantSidebar.mdx +0 -41
- package/.docs/raw/docs/ui/Attachment.mdx +0 -84
- package/.docs/raw/docs/ui/Reasoning.mdx +0 -152
- package/.docs/raw/docs/ui/ThreadList.mdx +0 -90
- package/.docs/raw/docs/ui/ToolFallback.mdx +0 -63
- package/.docs/raw/docs/ui/ToolGroup.mdx +0 -96
- package/dist/chunk-M2RKUM66.js +0 -38
- package/dist/chunk-NVNFQ5ZO.js +0 -423
- /package/.docs/raw/docs/{copilots → (docs)/copilots}/assistant-frame.mdx +0 -0
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ThreadListItemMorePrimitive
|
|
3
|
+
description: Dropdown menu for additional thread actions like archive and delete.
|
|
4
|
+
---
|
|
5
|
+
|
|
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
|
+
|
|
8
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
9
|
+
|
|
10
|
+
## Anatomy
|
|
11
|
+
|
|
12
|
+
```tsx
|
|
13
|
+
import {
|
|
14
|
+
ThreadListItemPrimitive,
|
|
15
|
+
ThreadListItemMorePrimitive
|
|
16
|
+
} from "@assistant-ui/react";
|
|
17
|
+
|
|
18
|
+
const ThreadListItemMore = () => (
|
|
19
|
+
<ThreadListItemMorePrimitive.Root>
|
|
20
|
+
<ThreadListItemMorePrimitive.Trigger>
|
|
21
|
+
More options
|
|
22
|
+
</ThreadListItemMorePrimitive.Trigger>
|
|
23
|
+
<ThreadListItemMorePrimitive.Content>
|
|
24
|
+
<ThreadListItemPrimitive.Archive asChild>
|
|
25
|
+
<ThreadListItemMorePrimitive.Item>
|
|
26
|
+
Archive
|
|
27
|
+
</ThreadListItemMorePrimitive.Item>
|
|
28
|
+
</ThreadListItemPrimitive.Archive>
|
|
29
|
+
<ThreadListItemMorePrimitive.Separator />
|
|
30
|
+
<ThreadListItemPrimitive.Delete asChild>
|
|
31
|
+
<ThreadListItemMorePrimitive.Item>
|
|
32
|
+
Delete
|
|
33
|
+
</ThreadListItemMorePrimitive.Item>
|
|
34
|
+
</ThreadListItemPrimitive.Delete>
|
|
35
|
+
</ThreadListItemMorePrimitive.Content>
|
|
36
|
+
</ThreadListItemMorePrimitive.Root>
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## API Reference
|
|
41
|
+
|
|
42
|
+
### Root
|
|
43
|
+
|
|
44
|
+
Contains all parts of the dropdown menu. Wraps Radix UI's `DropdownMenu.Root`.
|
|
45
|
+
|
|
46
|
+
<ParametersTable
|
|
47
|
+
type="ThreadListItemMorePrimitiveRootProps"
|
|
48
|
+
parameters={[
|
|
49
|
+
{
|
|
50
|
+
name: "open",
|
|
51
|
+
type: "boolean",
|
|
52
|
+
description: "The controlled open state of the dropdown menu.",
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
name: "defaultOpen",
|
|
56
|
+
type: "boolean",
|
|
57
|
+
description: "The open state of the dropdown menu when it is initially rendered.",
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
name: "onOpenChange",
|
|
61
|
+
type: "(open: boolean) => void",
|
|
62
|
+
description: "Event handler called when the open state changes.",
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
name: "modal",
|
|
66
|
+
type: "boolean",
|
|
67
|
+
default: "true",
|
|
68
|
+
description: "Whether the dropdown menu should be modal.",
|
|
69
|
+
},
|
|
70
|
+
]}
|
|
71
|
+
/>
|
|
72
|
+
|
|
73
|
+
### Trigger
|
|
74
|
+
|
|
75
|
+
The button that toggles the dropdown menu. Wraps Radix UI's `DropdownMenu.Trigger`.
|
|
76
|
+
|
|
77
|
+
This primitive renders a `<button>` element unless `asChild` is set.
|
|
78
|
+
|
|
79
|
+
<ParametersTable
|
|
80
|
+
type="ThreadListItemMorePrimitiveTriggerProps"
|
|
81
|
+
parameters={[
|
|
82
|
+
{
|
|
83
|
+
name: "asChild",
|
|
84
|
+
},
|
|
85
|
+
]}
|
|
86
|
+
/>
|
|
87
|
+
|
|
88
|
+
### Content
|
|
89
|
+
|
|
90
|
+
The container for the dropdown menu items. Wraps Radix UI's `DropdownMenu.Portal` and `DropdownMenu.Content`.
|
|
91
|
+
|
|
92
|
+
<ParametersTable
|
|
93
|
+
type="ThreadListItemMorePrimitiveContentProps"
|
|
94
|
+
parameters={[
|
|
95
|
+
{
|
|
96
|
+
name: "side",
|
|
97
|
+
type: '"top" | "right" | "bottom" | "left"',
|
|
98
|
+
default: '"bottom"',
|
|
99
|
+
description: "The preferred side of the trigger to render against.",
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
name: "sideOffset",
|
|
103
|
+
type: "number",
|
|
104
|
+
default: "4",
|
|
105
|
+
description: "The distance in pixels from the trigger.",
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
name: "align",
|
|
109
|
+
type: '"start" | "center" | "end"',
|
|
110
|
+
default: '"center"',
|
|
111
|
+
description: "The preferred alignment against the trigger.",
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
name: "alignOffset",
|
|
115
|
+
type: "number",
|
|
116
|
+
default: "0",
|
|
117
|
+
description: "An offset in pixels from the align option.",
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
name: "portalProps",
|
|
121
|
+
type: "PortalProps",
|
|
122
|
+
description: "Props to pass to the Portal component.",
|
|
123
|
+
},
|
|
124
|
+
]}
|
|
125
|
+
/>
|
|
126
|
+
|
|
127
|
+
### Item
|
|
128
|
+
|
|
129
|
+
A menu item within the dropdown. Wraps Radix UI's `DropdownMenu.Item`.
|
|
130
|
+
|
|
131
|
+
This primitive renders a `<div>` element unless `asChild` is set.
|
|
132
|
+
|
|
133
|
+
<ParametersTable
|
|
134
|
+
type="ThreadListItemMorePrimitiveItemProps"
|
|
135
|
+
parameters={[
|
|
136
|
+
{
|
|
137
|
+
name: "asChild",
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
name: "disabled",
|
|
141
|
+
type: "boolean",
|
|
142
|
+
description: "Whether the item is disabled.",
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
name: "onSelect",
|
|
146
|
+
type: "(event: Event) => void",
|
|
147
|
+
description: "Event handler called when the user selects an item.",
|
|
148
|
+
},
|
|
149
|
+
]}
|
|
150
|
+
/>
|
|
151
|
+
|
|
152
|
+
### Separator
|
|
153
|
+
|
|
154
|
+
A visual separator between menu items. Wraps Radix UI's `DropdownMenu.Separator`.
|
|
155
|
+
|
|
156
|
+
<ParametersTable
|
|
157
|
+
type="ThreadListItemMorePrimitiveSeparatorProps"
|
|
158
|
+
parameters={[
|
|
159
|
+
{
|
|
160
|
+
name: "asChild",
|
|
161
|
+
},
|
|
162
|
+
]}
|
|
163
|
+
/>
|
|
164
|
+
|
|
165
|
+
## Examples
|
|
166
|
+
|
|
167
|
+
### With Icons
|
|
168
|
+
|
|
169
|
+
```tsx
|
|
170
|
+
import { ArchiveIcon, TrashIcon, MoreHorizontalIcon } from "lucide-react";
|
|
171
|
+
|
|
172
|
+
const ThreadListItemMore = () => (
|
|
173
|
+
<ThreadListItemMorePrimitive.Root>
|
|
174
|
+
<ThreadListItemMorePrimitive.Trigger asChild>
|
|
175
|
+
<button className="icon-button">
|
|
176
|
+
<MoreHorizontalIcon />
|
|
177
|
+
</button>
|
|
178
|
+
</ThreadListItemMorePrimitive.Trigger>
|
|
179
|
+
<ThreadListItemMorePrimitive.Content
|
|
180
|
+
side="bottom"
|
|
181
|
+
align="start"
|
|
182
|
+
className="dropdown-content"
|
|
183
|
+
>
|
|
184
|
+
<ThreadListItemPrimitive.Archive asChild>
|
|
185
|
+
<ThreadListItemMorePrimitive.Item className="dropdown-item">
|
|
186
|
+
<ArchiveIcon className="icon" />
|
|
187
|
+
Archive
|
|
188
|
+
</ThreadListItemMorePrimitive.Item>
|
|
189
|
+
</ThreadListItemPrimitive.Archive>
|
|
190
|
+
</ThreadListItemMorePrimitive.Content>
|
|
191
|
+
</ThreadListItemMorePrimitive.Root>
|
|
192
|
+
);
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Complete Thread List Item with More Menu
|
|
196
|
+
|
|
197
|
+
```tsx
|
|
198
|
+
const ThreadListItem = () => (
|
|
199
|
+
<ThreadListItemPrimitive.Root className="thread-item">
|
|
200
|
+
<ThreadListItemPrimitive.Trigger className="thread-trigger">
|
|
201
|
+
<ThreadListItemPrimitive.Title fallback="New Chat" />
|
|
202
|
+
</ThreadListItemPrimitive.Trigger>
|
|
203
|
+
|
|
204
|
+
<ThreadListItemMorePrimitive.Root>
|
|
205
|
+
<ThreadListItemMorePrimitive.Trigger asChild>
|
|
206
|
+
<button className="more-button">
|
|
207
|
+
<MoreHorizontalIcon />
|
|
208
|
+
</button>
|
|
209
|
+
</ThreadListItemMorePrimitive.Trigger>
|
|
210
|
+
<ThreadListItemMorePrimitive.Content>
|
|
211
|
+
<ThreadListItemPrimitive.Archive asChild>
|
|
212
|
+
<ThreadListItemMorePrimitive.Item>
|
|
213
|
+
<ArchiveIcon />
|
|
214
|
+
Archive
|
|
215
|
+
</ThreadListItemMorePrimitive.Item>
|
|
216
|
+
</ThreadListItemPrimitive.Archive>
|
|
217
|
+
</ThreadListItemMorePrimitive.Content>
|
|
218
|
+
</ThreadListItemMorePrimitive.Root>
|
|
219
|
+
</ThreadListItemPrimitive.Root>
|
|
220
|
+
);
|
|
221
|
+
```
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: ThreadListItemPrimitive
|
|
3
|
+
description: Individual thread item with title, archive, and delete controls.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
6
|
A single thread item within a thread list.
|
|
6
7
|
|
|
7
|
-
import { ParametersTable } from "@/components/docs";
|
|
8
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
8
9
|
|
|
9
10
|
## Anatomy
|
|
10
11
|
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: ThreadListPrimitive
|
|
3
|
+
description: Display and manage multiple conversation threads with create and archive actions.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
6
|
Displays a list of conversation threads.
|
|
6
7
|
|
|
7
|
-
import { ParametersTable } from "@/components/docs";
|
|
8
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
8
9
|
|
|
9
10
|
## Anatomy
|
|
10
11
|
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: ThreadPrimitive
|
|
3
|
+
description: Primitives for the message list, viewport, and welcome screen.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
6
|
A conversation between a user and an assistant.
|
|
6
7
|
|
|
7
|
-
import { ParametersTable } from "@/components/docs";
|
|
8
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
8
9
|
|
|
9
10
|
## Anatomy
|
|
10
11
|
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: AssistantRuntime
|
|
3
|
+
description: Root runtime for managing threads, tool UIs, and assistant state.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import { ParametersTable } from "@/components/docs";
|
|
6
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
6
7
|
import { AssistantRuntime, AssistantToolUIsState } from "@/generated/typeDocs";
|
|
7
8
|
|
|
8
9
|
The `AssistantRuntime` is the root runtime of the application.
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: AttachmentRuntime
|
|
3
|
+
description: Hooks for accessing attachment state in composer and messages.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import { ParametersTable } from "@/components/docs";
|
|
6
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
6
7
|
import {
|
|
7
8
|
ComposerAttachmentState,
|
|
8
9
|
MessageAttachmentState,
|
|
9
|
-
} from "@/components/docs/parameters/context";
|
|
10
|
+
} from "@/components/docs/tables/parameters/context";
|
|
10
11
|
|
|
11
12
|
### `useAttachment`
|
|
12
13
|
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: ComposerRuntime
|
|
3
|
+
description: Runtime for programmatically controlling the message composer.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
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.
|
|
6
7
|
|
|
7
|
-
import { ParametersTable } from "@/components/docs";
|
|
8
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
8
9
|
import { ComposerRuntime, ThreadComposerRuntime, ThreadComposerState, EditComposerState } from "@/generated/typeDocs";
|
|
9
10
|
|
|
10
11
|
### `useComposerRuntime`
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: MessagePartRuntime
|
|
3
|
+
description: Hook for accessing message part state within parts.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import { ParametersTable } from "@/components/docs";
|
|
6
|
-
import { MessagePartState } from "@/components/docs/parameters/context";
|
|
6
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
7
|
+
import { MessagePartState } from "@/components/docs/tables/parameters/context";
|
|
7
8
|
|
|
8
9
|
### `useMessagePart`
|
|
9
10
|
|
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: MessageRuntime
|
|
3
|
+
description: Hooks for accessing message state, utilities, and edit composer.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import { ParametersTable } from "@/components/docs";
|
|
6
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
6
7
|
import {
|
|
7
8
|
MessageState,
|
|
8
9
|
MessageUtilsState,
|
|
9
10
|
EditComposerState,
|
|
10
|
-
} from "@/components/docs/parameters/context";
|
|
11
|
+
} from "@/components/docs/tables/parameters/context";
|
|
11
12
|
|
|
12
13
|
### `useMessage`
|
|
13
14
|
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: ThreadListItemRuntime
|
|
3
|
+
description: Runtime for managing individual thread list items.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import { ParametersTable } from "@/components/docs";
|
|
6
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
6
7
|
import {
|
|
7
8
|
ThreadListItemRuntime,
|
|
8
9
|
ThreadListItemState,
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: ThreadListRuntime
|
|
3
|
+
description: Runtime for accessing and managing the list of threads.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import { ParametersTable } from "@/components/docs";
|
|
6
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
6
7
|
import { ThreadListRuntime, ThreadListState } from "@/generated/typeDocs";
|
|
7
8
|
|
|
8
9
|
### Access via `useAssistantRuntime`
|
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: ThreadRuntime
|
|
3
|
+
description: Runtime for thread state, messages, and viewport management.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import { ParametersTable } from "@/components/docs";
|
|
6
|
+
import { ParametersTable } from "@/components/docs/tables/ParametersTable";
|
|
6
7
|
import { ThreadRuntime, ThreadState } from "@/generated/typeDocs";
|
|
7
|
-
import {
|
|
8
|
-
ThreadMessagesState,
|
|
9
|
-
ThreadViewportState,
|
|
10
|
-
} from "@/components/docs/parameters/context";
|
|
8
|
+
import { ThreadMessagesState, ThreadViewportState } from "@/components/docs/tables/parameters/context";
|
|
11
9
|
|
|
12
10
|
### `useThreadRuntime`
|
|
13
11
|
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: AssistantModal
|
|
3
|
+
description: Chat bubble component for support or Q&A use cases.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import {
|
|
6
|
-
import { Tabs, Tab } from "fumadocs-ui/components/tabs";
|
|
7
|
-
import { InstallCommand } from "@/components/docs/install-command";
|
|
6
|
+
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
8
7
|
|
|
9
8
|
## Overview
|
|
10
9
|
|
package/.docs/raw/docs/{legacy/styled/Markdown.mdx → (reference)/legacy/styled/markdown.mdx}
RENAMED
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Markdown
|
|
3
|
+
description: Enable rich text formatting for assistant messages using markdown.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
6
|
Allow the assistant to display rich text using markdown.
|
|
6
7
|
|
|
7
|
-
import {
|
|
8
|
-
import { Callout } from "fumadocs-ui/components/callout";
|
|
9
|
-
import { Tabs } from "fumadocs-ui/components/tabs";
|
|
10
|
-
import { InstallCommand } from "@/components/docs/install-command";
|
|
8
|
+
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
11
9
|
|
|
12
10
|
## Enabling markdown support
|
|
13
11
|
|
package/.docs/raw/docs/{legacy/styled/Scrollbar.mdx → (reference)/legacy/styled/scrollbar.mdx}
RENAMED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Custom Scrollbar
|
|
3
|
+
description: Integrate custom scrollbar UI using Radix UI Scroll Area.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
6
|
If you want to show a custom scrollbar UI of the Thread.Viewport in place of the system default, you can integrate `@radix-ui/react-scroll-area`.
|
|
@@ -32,7 +33,7 @@ Add the following CSS to your `globals.css`:
|
|
|
32
33
|
|
|
33
34
|
## Integration
|
|
34
35
|
|
|
35
|
-
- Decompose `Thread` into `MyThread` (see [Decomposition](/docs/legacy/styled/
|
|
36
|
+
- Decompose `Thread` into `MyThread` (see [Decomposition](/docs/legacy/styled/decomposition))
|
|
36
37
|
- Wrap `Thread.Root` with `<ScrollAreaPrimitive.Root asChild>`
|
|
37
38
|
- Wrap `Thread.Viewport` with `<ScrollAreaPrimitive.Viewport asChild>`
|
|
38
39
|
- Add shadcn's `<ScrollBar />` to `Thread.Root`
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Thread
|
|
3
|
+
description: Full-screen message list and composer UI for chat interfaces.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import {
|
|
6
|
-
import { Tabs, Tab } from "fumadocs-ui/components/tabs";
|
|
7
|
-
import { InstallCommand } from "@/components/docs/install-command";
|
|
6
|
+
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
8
7
|
|
|
9
8
|
## Overview
|
|
10
9
|
|
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Migrating to react-langgraph v0.7
|
|
3
|
+
description: Guide to upgrading to the simplified LangGraph integration API.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import { Callout } from "fumadocs-ui/components/callout";
|
|
6
|
-
import { Steps, Step } from "fumadocs-ui/components/steps";
|
|
7
6
|
|
|
8
7
|
## Overview
|
|
9
8
|
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Using old React versions
|
|
3
|
-
description:
|
|
3
|
+
description: Compatibility notes for React 18, 17, and 16.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import {
|
|
7
|
-
import { InstallCommand } from "@/components/docs/install-command";
|
|
6
|
+
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
8
7
|
|
|
9
8
|
<Callout type="warning" title="Older React Versions">
|
|
10
9
|
Older React versions are not continuously tested. If you encounter any issues
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: User Authorization
|
|
3
|
+
description: Configure workspace auth tokens and integrate with auth providers.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
6
|
The assistant-ui API can be directly accessed by your frontend. This elliminates the need for a backend server from your side, except for authorization of your users.
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Overview
|
|
3
|
+
description: Hosted service for thread management, chat history, and user authentication.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
6
|
Assistant Cloud is a hosted service built for assistant-ui frontends that offers comprehensive thread management and message history. It automatically persists threads, supports human-in-the-loop workflows, and integrates with common auth providers to seamlessly allow users to resume conversations at any point.
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Chat History for AI SDK
|
|
3
|
+
description: Integrate cloud persistence and thread management with Vercel AI SDK.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import {
|
|
6
|
-
import { Callout } from 'fumadocs-ui/components/callout';
|
|
7
|
-
import { InstallCommand } from "@/components/docs/install-command";
|
|
6
|
+
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
8
7
|
|
|
9
8
|
## Overview
|
|
10
9
|
|
|
@@ -1,11 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Chat History for LangGraph Cloud
|
|
3
|
+
description: Integrate cloud persistence and thread management with LangGraph Cloud.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import {
|
|
6
|
-
import { Callout } from "fumadocs-ui/components/callout";
|
|
7
|
-
import { Tab, Tabs } from "fumadocs-ui/components/tabs";
|
|
8
|
-
import { InstallCommand } from "@/components/docs/install-command";
|
|
6
|
+
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
9
7
|
|
|
10
8
|
## Overview
|
|
11
9
|
|
|
@@ -224,14 +222,14 @@ npx assistant-ui@latest add thread-list
|
|
|
224
222
|
<Tab>
|
|
225
223
|
|
|
226
224
|
```sh
|
|
227
|
-
npx shadcn@latest add
|
|
225
|
+
npx shadcn@latest add https://r.assistant-ui.com/thread-list.json
|
|
228
226
|
```
|
|
229
227
|
|
|
230
228
|
</Tab>
|
|
231
229
|
<Tab>
|
|
232
230
|
|
|
233
231
|
```sh
|
|
234
|
-
npx shadcn@latest add
|
|
232
|
+
npx shadcn@latest add https://r.assistant-ui.com/thread-list.json
|
|
235
233
|
```
|
|
236
234
|
|
|
237
235
|
</Tab>
|
|
@@ -269,5 +267,5 @@ For other authentication providers or custom implementations, see the [Cloud Aut
|
|
|
269
267
|
## Next Steps
|
|
270
268
|
|
|
271
269
|
- Learn about [LangGraph runtime setup](/docs/runtimes/langgraph) for your application
|
|
272
|
-
- Explore [ThreadListRuntime](/docs/api-reference/runtimes/
|
|
270
|
+
- Explore [ThreadListRuntime](/docs/api-reference/runtimes/thread-list-runtime) for advanced thread management
|
|
273
271
|
- Check out the [LangGraph example](https://github.com/assistant-ui/assistant-ui/tree/main/examples/with-langgraph) on GitHub
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: AI SDK v5
|
|
3
|
+
description: Integrate Vercel AI SDK v5 with useChatRuntime for streaming chat.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import {
|
|
6
|
-
import { InstallCommand } from "@/components/docs/install-command";
|
|
6
|
+
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
7
7
|
|
|
8
8
|
## Overview
|
|
9
9
|
|
|
@@ -12,7 +12,6 @@ This provides a streamlined way to integrate AI SDK v5 features including the ne
|
|
|
12
12
|
|
|
13
13
|
## Getting Started
|
|
14
14
|
|
|
15
|
-
import { Steps, Step } from "fumadocs-ui/components/steps";
|
|
16
15
|
|
|
17
16
|
<Steps>
|
|
18
17
|
<Step>
|
|
@@ -39,7 +38,7 @@ cd my-app
|
|
|
39
38
|
|
|
40
39
|
```tsx
|
|
41
40
|
import { openai } from "@ai-sdk/openai";
|
|
42
|
-
import { streamText, UIMessage, convertToModelMessages, tool } from "ai";
|
|
41
|
+
import { streamText, UIMessage, convertToModelMessages, tool, zodSchema } from "ai";
|
|
43
42
|
import { frontendTools } from "@assistant-ui/react-ai-sdk";
|
|
44
43
|
import { z } from "zod";
|
|
45
44
|
|
|
@@ -67,9 +66,11 @@ export async function POST(req: Request) {
|
|
|
67
66
|
// Backend tools
|
|
68
67
|
get_current_weather: tool({
|
|
69
68
|
description: "Get the current weather",
|
|
70
|
-
inputSchema:
|
|
71
|
-
|
|
72
|
-
|
|
69
|
+
inputSchema: zodSchema(
|
|
70
|
+
z.object({
|
|
71
|
+
city: z.string(),
|
|
72
|
+
}),
|
|
73
|
+
),
|
|
73
74
|
execute: async ({ city }) => {
|
|
74
75
|
return `The weather in ${city} is sunny`;
|
|
75
76
|
},
|
|
@@ -215,4 +216,4 @@ const runtime = useAISDKRuntime(chat);
|
|
|
215
216
|
|
|
216
217
|
## Example
|
|
217
218
|
|
|
218
|
-
For a complete example, check out the [AI SDK
|
|
219
|
+
For a complete example, check out the [AI SDK v6 example](https://github.com/assistant-ui/assistant-ui/tree/main/examples/with-ai-sdk-v6) in our repository.
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: AI SDK v4 (Legacy)
|
|
3
|
+
description: Legacy integration for Vercel AI SDK v4 using data stream runtime.
|
|
3
4
|
---
|
|
4
5
|
|
|
5
|
-
import {
|
|
6
|
-
import { InstallCommand } from "@/components/docs/install-command";
|
|
6
|
+
import { InstallCommand } from "@/components/docs/fumadocs/install/install-command";
|
|
7
7
|
|
|
8
8
|
## Overview
|
|
9
9
|
|
|
@@ -18,7 +18,6 @@ If you're using AI SDK v4 (legacy), you can integrate with assistant-ui using th
|
|
|
18
18
|
|
|
19
19
|
## Getting Started
|
|
20
20
|
|
|
21
|
-
import { Steps, Step } from "fumadocs-ui/components/steps";
|
|
22
21
|
|
|
23
22
|
### Option 1: Using @assistant-ui/react-data-stream (Recommended)
|
|
24
23
|
|