@assistant-ui/mcp-docs-server 0.1.31 → 0.1.32
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/waterfall.md +8 -8
- package/.docs/organized/code-examples/with-a2a.md +10 -10
- package/.docs/organized/code-examples/with-ag-ui.md +11 -11
- package/.docs/organized/code-examples/with-ai-sdk-v6.md +13 -13
- package/.docs/organized/code-examples/with-artifacts.md +13 -13
- package/.docs/organized/code-examples/with-assistant-transport.md +10 -10
- package/.docs/organized/code-examples/with-browser-extension.md +345 -0
- package/.docs/organized/code-examples/with-chain-of-thought.md +54 -17
- package/.docs/organized/code-examples/with-cloud-standalone.md +13 -13
- package/.docs/organized/code-examples/with-cloud.md +13 -13
- package/.docs/organized/code-examples/with-custom-thread-list.md +13 -13
- package/.docs/organized/code-examples/with-elevenlabs-conversational.md +17 -16
- package/.docs/organized/code-examples/with-elevenlabs-scribe.md +17 -16
- package/.docs/organized/code-examples/with-expo.md +24 -24
- package/.docs/organized/code-examples/with-external-store.md +10 -10
- package/.docs/organized/code-examples/with-ffmpeg.md +13 -13
- package/.docs/organized/code-examples/with-generative-ui.md +210 -13
- package/.docs/organized/code-examples/with-google-adk.md +10 -10
- package/.docs/organized/code-examples/with-heat-graph.md +8 -8
- package/.docs/organized/code-examples/with-image-generation.md +454 -0
- package/.docs/organized/code-examples/with-interactables.md +13 -13
- package/.docs/organized/code-examples/with-langchain.md +12 -12
- package/.docs/organized/code-examples/with-langgraph.md +15 -12
- package/.docs/organized/code-examples/with-livekit.md +18 -17
- package/.docs/organized/code-examples/with-mcp.md +748 -0
- package/.docs/organized/code-examples/with-opencode.md +11 -11
- package/.docs/organized/code-examples/with-parent-id-grouping.md +11 -11
- package/.docs/organized/code-examples/with-react-hook-form.md +14 -14
- package/.docs/organized/code-examples/with-react-ink.md +4 -4
- package/.docs/organized/code-examples/with-react-router.md +15 -15
- package/.docs/organized/code-examples/with-resumable-stream.md +660 -0
- package/.docs/organized/code-examples/with-store.md +8 -8
- package/.docs/organized/code-examples/with-tanstack.md +14 -14
- package/.docs/organized/code-examples/with-tap-runtime.md +11 -10
- package/.docs/raw/docs/(docs)/cli.mdx +1 -0
- package/.docs/raw/docs/(docs)/index.mdx +2 -2
- package/.docs/raw/docs/(docs)/installation.mdx +1 -1
- package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +26 -24
- package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +20 -12
- package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +44 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +37 -16
- package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +12 -23
- package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +37 -8
- package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +11 -9
- package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +64 -0
- package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +52 -0
- package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +36 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +98 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +18 -13
- package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +18 -57
- package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +640 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +15 -28
- package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +64 -18
- package/.docs/raw/docs/(reference)/api-reference/hooks/utilities.mdx +434 -0
- package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +24 -0
- package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +11 -12
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +79 -0
- package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +52 -0
- package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/overview.mdx +110 -131
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +78 -221
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +127 -242
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +39 -20
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +66 -87
- package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +50 -58
- package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +80 -48
- package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +67 -0
- package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +323 -461
- package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +36 -43
- package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +29 -24
- package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +63 -245
- package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +175 -591
- package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +65 -0
- package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +35 -22
- package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +57 -140
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +70 -161
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +84 -108
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +77 -96
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +173 -349
- package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +9 -21
- package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +10 -21
- package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +15 -70
- package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +18 -13
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +25 -28
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +11 -63
- package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +11 -48
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +10 -47
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +18 -30
- package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +68 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +39 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +79 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +42 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +92 -0
- package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +48 -0
- package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +62 -0
- package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +19 -0
- package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +131 -0
- package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +54 -0
- package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +36 -0
- package/.docs/raw/docs/cloud/ai-sdk.mdx +1 -1
- package/.docs/raw/docs/cloud/index.mdx +2 -2
- package/.docs/raw/docs/guides/attachments.mdx +4 -4
- package/.docs/raw/docs/guides/branching.mdx +1 -1
- package/.docs/raw/docs/guides/chain-of-thought.mdx +5 -5
- package/.docs/raw/docs/guides/context-api.mdx +4 -4
- package/.docs/raw/docs/guides/dictation.mdx +2 -2
- package/.docs/raw/docs/guides/editing.mdx +1 -1
- package/.docs/raw/docs/guides/generative-ui.mdx +142 -0
- package/.docs/raw/docs/guides/image-generation.mdx +74 -0
- package/.docs/raw/docs/guides/index.mdx +2 -2
- package/.docs/raw/docs/guides/interactables.mdx +2 -2
- package/.docs/raw/docs/guides/latex.mdx +2 -2
- package/.docs/raw/docs/guides/mcp-apps.mdx +231 -0
- package/.docs/raw/docs/guides/mentions.mdx +2 -2
- package/.docs/raw/docs/guides/message-timing.mdx +38 -5
- package/.docs/raw/docs/guides/multi-agent.mdx +2 -2
- package/.docs/raw/docs/guides/quoting.mdx +1 -1
- package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +212 -0
- package/.docs/raw/docs/guides/resumable-stream-stores.mdx +152 -0
- package/.docs/raw/docs/guides/resumable-streams.mdx +210 -0
- package/.docs/raw/docs/guides/slash-commands.mdx +1 -1
- package/.docs/raw/docs/guides/speech.mdx +2 -2
- package/.docs/raw/docs/guides/suggestions.mdx +88 -4
- package/.docs/raw/docs/guides/tool-ui.mdx +2 -2
- package/.docs/raw/docs/guides/tools.mdx +66 -5
- package/.docs/raw/docs/guides/voice.mdx +2 -2
- package/.docs/raw/docs/ink/adapters.mdx +37 -1
- package/.docs/raw/docs/ink/custom-backend.mdx +59 -8
- package/.docs/raw/docs/ink/index.mdx +10 -11
- package/.docs/raw/docs/ink/primitives.mdx +349 -8
- package/.docs/raw/docs/integrations/auth/better-auth.mdx +1 -1
- package/.docs/raw/docs/integrations/auth/clerk.mdx +1 -1
- package/.docs/raw/docs/integrations/auth/next-auth.mdx +1 -1
- package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +2 -2
- package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +282 -0
- package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +2 -2
- package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +1 -1
- package/.docs/raw/docs/integrations/gateways/index.mdx +9 -4
- package/.docs/raw/docs/integrations/index.mdx +15 -3
- package/.docs/raw/docs/integrations/observability/langfuse.mdx +8 -1
- package/.docs/raw/docs/integrations/observability/langsmith.mdx +8 -4
- package/.docs/raw/docs/integrations/tools/react-mcp.mdx +337 -0
- package/.docs/raw/docs/primitives/composer.mdx +53 -0
- package/.docs/raw/docs/primitives/index.mdx +2 -2
- package/.docs/raw/docs/primitives/suggestion.mdx +9 -0
- package/.docs/raw/docs/react-native/hooks.mdx +2 -2
- package/.docs/raw/docs/react-native/index.mdx +4 -4
- package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +4 -4
- package/.docs/raw/docs/runtimes/a2a/overview.mdx +2 -2
- package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +2 -2
- package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +32 -1
- package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +2 -2
- package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +7 -2
- package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +1 -1
- package/.docs/raw/docs/runtimes/ai-sdk/v6.mdx +7 -0
- package/.docs/raw/docs/runtimes/custom/data-stream.mdx +27 -2
- package/.docs/raw/docs/runtimes/custom/external-store.mdx +9 -1
- package/.docs/raw/docs/runtimes/custom/overview.mdx +2 -2
- package/.docs/raw/docs/runtimes/google-adk/overview.mdx +2 -2
- package/.docs/raw/docs/runtimes/langchain.mdx +2 -2
- package/.docs/raw/docs/runtimes/langgraph/overview.mdx +2 -2
- package/.docs/raw/docs/runtimes/opencode/overview.mdx +2 -2
- package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +1 -1
- package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +12 -5
- package/.docs/raw/docs/ui/composer-trigger-popover.mdx +11 -1
- package/.docs/raw/docs/ui/mcp-config.mdx +102 -0
- package/.docs/raw/docs/ui/model-selector.mdx +8 -8
- package/.docs/raw/docs/ui/sources.mdx +17 -0
- package/.docs/raw/docs/ui/streamdown.mdx +34 -2
- package/.docs/raw/docs/ui/thread-list.mdx +2 -2
- package/.docs/raw/docs/ui/thread.mdx +2 -2
- package/README.md +14 -72
- package/dist/constants.d.ts +12 -9
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +13 -9
- package/dist/constants.js.map +1 -1
- package/dist/index.d.ts +7 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +25 -24
- package/dist/index.js.map +1 -1
- package/dist/prepare-docs/code-examples.d.ts +4 -1
- package/dist/prepare-docs/code-examples.d.ts.map +1 -1
- package/dist/prepare-docs/code-examples.js +109 -121
- package/dist/prepare-docs/code-examples.js.map +1 -1
- package/dist/prepare-docs/copy-raw.d.ts +4 -1
- package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
- package/dist/prepare-docs/copy-raw.js +45 -42
- package/dist/prepare-docs/copy-raw.js.map +1 -1
- package/dist/prepare-docs/prepare.d.ts +1 -2
- package/dist/prepare-docs/prepare.js +17 -17
- package/dist/prepare-docs/prepare.js.map +1 -1
- package/dist/stdio.d.ts +1 -3
- package/dist/stdio.js +6 -3
- package/dist/stdio.js.map +1 -1
- package/dist/tools/docs.d.ts +20 -15
- package/dist/tools/docs.d.ts.map +1 -1
- package/dist/tools/docs.js +140 -161
- package/dist/tools/docs.js.map +1 -1
- package/dist/tools/examples.d.ts +20 -15
- package/dist/tools/examples.d.ts.map +1 -1
- package/dist/tools/examples.js +74 -86
- package/dist/tools/examples.js.map +1 -1
- package/dist/tools/tests/test-setup.d.ts +5 -2
- package/dist/tools/tests/test-setup.d.ts.map +1 -1
- package/dist/tools/tests/test-setup.js +21 -28
- package/dist/tools/tests/test-setup.js.map +1 -1
- package/dist/utils/logger.d.ts +8 -5
- package/dist/utils/logger.d.ts.map +1 -1
- package/dist/utils/logger.js +17 -17
- package/dist/utils/logger.js.map +1 -1
- package/dist/utils/mcp-format.d.ts +8 -5
- package/dist/utils/mcp-format.d.ts.map +1 -1
- package/dist/utils/mcp-format.js +9 -9
- package/dist/utils/mcp-format.js.map +1 -1
- package/dist/utils/mdx.d.ts +8 -6
- package/dist/utils/mdx.d.ts.map +1 -1
- package/dist/utils/mdx.js +22 -22
- package/dist/utils/mdx.js.map +1 -1
- package/dist/utils/paths.d.ts +9 -6
- package/dist/utils/paths.d.ts.map +1 -1
- package/dist/utils/paths.js +66 -76
- package/dist/utils/paths.js.map +1 -1
- package/dist/utils/security.d.ts +4 -1
- package/dist/utils/security.d.ts.map +1 -1
- package/dist/utils/security.js +19 -40
- package/dist/utils/security.js.map +1 -1
- package/package.json +5 -5
- package/.docs/raw/docs/(reference)/api-reference/adapters/feedback-speech.mdx +0 -41
- package/.docs/raw/docs/(reference)/api-reference/context-providers/text-message-part-provider.mdx +0 -40
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -260
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-hook-form.mdx +0 -103
- package/.docs/raw/docs/(reference)/api-reference/integrations/vercel-ai-sdk.mdx +0 -254
- package/dist/prepare-docs/prepare.d.ts.map +0 -1
- package/dist/stdio.d.ts.map +0 -1
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/deprecation-policy.mdx +0 -0
- /package/.docs/raw/docs/{(reference) → migrations}/react-compatibility.mdx +0 -0
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/react-langgraph-v0-7.mdx +0 -0
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-11.mdx +0 -0
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-12.mdx +0 -0
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-14.mdx +0 -0
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: ThreadListItemPrimitive
|
|
3
|
-
description:
|
|
3
|
+
description: Thread list item primitives for rendering selectable conversation rows with titles, archive controls, delete actions, and menus.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
import { ThreadListItemPrimitiveArchiveProps, ThreadListItemPrimitiveDeleteProps, ThreadListItemPrimitiveRootProps, ThreadListItemPrimitiveTitleProps, ThreadListItemPrimitiveTriggerProps, ThreadListItemPrimitiveUnarchiveProps } from "@/generated/typeDocs";
|
|
7
|
+
import { ThreadListItemPrimitive as ThreadListItemPrimitiveDocs } from "@/generated/primitiveDocs";
|
|
7
8
|
|
|
9
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
10
|
+
{/* Do not edit manually. */}
|
|
8
11
|
|
|
12
|
+
{/* api-manual:start */}
|
|
9
13
|
## Anatomy
|
|
10
14
|
|
|
11
15
|
```tsx
|
|
@@ -22,141 +26,113 @@ const ThreadListItem = () => (
|
|
|
22
26
|
</ThreadListItemPrimitive.Root>
|
|
23
27
|
);
|
|
24
28
|
```
|
|
29
|
+
{/* api-manual:end */}
|
|
30
|
+
|
|
31
|
+
{/* api-reference:start */}
|
|
32
|
+
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
33
|
+
{/* Do not edit this block manually. */}
|
|
25
34
|
|
|
26
35
|
## API Reference
|
|
27
36
|
|
|
28
37
|
### Root
|
|
29
38
|
|
|
30
|
-
|
|
39
|
+
{ThreadListItemPrimitiveDocs.Root?.deprecated && (
|
|
40
|
+
<Callout type="warn">
|
|
41
|
+
<strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Root.deprecated}
|
|
42
|
+
</Callout>
|
|
43
|
+
)}
|
|
31
44
|
|
|
32
|
-
|
|
45
|
+
{ThreadListItemPrimitiveDocs.Root?.description}
|
|
33
46
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
{
|
|
38
|
-
name: "asChild",
|
|
39
|
-
},
|
|
40
|
-
]}
|
|
41
|
-
/>
|
|
47
|
+
{ThreadListItemPrimitiveDocs.Root?.element && (
|
|
48
|
+
<p>This primitive renders a <code>{`<${ThreadListItemPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
49
|
+
)}
|
|
42
50
|
|
|
43
|
-
|
|
51
|
+
<ParametersTable {...ThreadListItemPrimitiveRootProps} />
|
|
44
52
|
|
|
45
|
-
|
|
53
|
+
{/* api-manual:ThreadListItemPrimitive.Root:start */}
|
|
54
|
+
| Data attribute | Values |
|
|
55
|
+
| --- | --- |
|
|
56
|
+
| `[data-active]` | Present when this is the current thread. |
|
|
57
|
+
{/* api-manual:ThreadListItemPrimitive.Root:end */}
|
|
46
58
|
|
|
47
|
-
|
|
59
|
+
### Archive
|
|
48
60
|
|
|
49
|
-
|
|
50
|
-
type="
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
},
|
|
55
|
-
]}
|
|
56
|
-
/>
|
|
61
|
+
{ThreadListItemPrimitiveDocs.Archive?.deprecated && (
|
|
62
|
+
<Callout type="warn">
|
|
63
|
+
<strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Archive.deprecated}
|
|
64
|
+
</Callout>
|
|
65
|
+
)}
|
|
57
66
|
|
|
58
|
-
|
|
67
|
+
{ThreadListItemPrimitiveDocs.Archive?.description}
|
|
59
68
|
|
|
60
|
-
|
|
69
|
+
{ThreadListItemPrimitiveDocs.Archive?.element && (
|
|
70
|
+
<p>This primitive renders a <code>{`<${ThreadListItemPrimitiveDocs.Archive?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
71
|
+
)}
|
|
61
72
|
|
|
62
|
-
|
|
73
|
+
<ParametersTable {...ThreadListItemPrimitiveArchiveProps} />
|
|
63
74
|
|
|
64
|
-
|
|
65
|
-
type="ThreadListItemPrimitiveTitleProps"
|
|
66
|
-
parameters={[
|
|
67
|
-
{
|
|
68
|
-
name: "fallback",
|
|
69
|
-
type: "ReactNode",
|
|
70
|
-
description: "Content to display when the thread has no title.",
|
|
71
|
-
},
|
|
72
|
-
]}
|
|
73
|
-
/>
|
|
75
|
+
### Unarchive
|
|
74
76
|
|
|
75
|
-
|
|
77
|
+
{ThreadListItemPrimitiveDocs.Unarchive?.deprecated && (
|
|
78
|
+
<Callout type="warn">
|
|
79
|
+
<strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Unarchive.deprecated}
|
|
80
|
+
</Callout>
|
|
81
|
+
)}
|
|
76
82
|
|
|
77
|
-
|
|
83
|
+
{ThreadListItemPrimitiveDocs.Unarchive?.description}
|
|
78
84
|
|
|
79
|
-
|
|
85
|
+
{ThreadListItemPrimitiveDocs.Unarchive?.element && (
|
|
86
|
+
<p>This primitive renders a <code>{`<${ThreadListItemPrimitiveDocs.Unarchive?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
87
|
+
)}
|
|
80
88
|
|
|
81
|
-
<ParametersTable
|
|
82
|
-
type="ThreadListItemPrimitiveArchiveProps"
|
|
83
|
-
parameters={[
|
|
84
|
-
{
|
|
85
|
-
name: "asChild",
|
|
86
|
-
},
|
|
87
|
-
]}
|
|
88
|
-
/>
|
|
89
|
+
<ParametersTable {...ThreadListItemPrimitiveUnarchiveProps} />
|
|
89
90
|
|
|
90
|
-
###
|
|
91
|
+
### Delete
|
|
91
92
|
|
|
92
|
-
|
|
93
|
+
{ThreadListItemPrimitiveDocs.Delete?.deprecated && (
|
|
94
|
+
<Callout type="warn">
|
|
95
|
+
<strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Delete.deprecated}
|
|
96
|
+
</Callout>
|
|
97
|
+
)}
|
|
93
98
|
|
|
94
|
-
|
|
99
|
+
{ThreadListItemPrimitiveDocs.Delete?.description}
|
|
95
100
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
{
|
|
100
|
-
name: "asChild",
|
|
101
|
-
},
|
|
102
|
-
]}
|
|
103
|
-
/>
|
|
101
|
+
{ThreadListItemPrimitiveDocs.Delete?.element && (
|
|
102
|
+
<p>This primitive renders a <code>{`<${ThreadListItemPrimitiveDocs.Delete?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
103
|
+
)}
|
|
104
104
|
|
|
105
|
-
|
|
105
|
+
<ParametersTable {...ThreadListItemPrimitiveDeleteProps} />
|
|
106
106
|
|
|
107
|
-
|
|
107
|
+
### Trigger
|
|
108
108
|
|
|
109
|
-
|
|
109
|
+
{ThreadListItemPrimitiveDocs.Trigger?.deprecated && (
|
|
110
|
+
<Callout type="warn">
|
|
111
|
+
<strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Trigger.deprecated}
|
|
112
|
+
</Callout>
|
|
113
|
+
)}
|
|
110
114
|
|
|
111
|
-
|
|
112
|
-
type="ThreadListItemPrimitiveDeleteProps"
|
|
113
|
-
parameters={[
|
|
114
|
-
{
|
|
115
|
-
name: "asChild",
|
|
116
|
-
},
|
|
117
|
-
]}
|
|
118
|
-
/>
|
|
115
|
+
{ThreadListItemPrimitiveDocs.Trigger?.description}
|
|
119
116
|
|
|
120
|
-
|
|
117
|
+
{ThreadListItemPrimitiveDocs.Trigger?.element && (
|
|
118
|
+
<p>This primitive renders a <code>{`<${ThreadListItemPrimitiveDocs.Trigger?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
119
|
+
)}
|
|
121
120
|
|
|
122
|
-
|
|
121
|
+
<ParametersTable {...ThreadListItemPrimitiveTriggerProps} />
|
|
123
122
|
|
|
124
|
-
|
|
125
|
-
const MyThreadListItem = () => {
|
|
126
|
-
return (
|
|
127
|
-
<ThreadListItemPrimitive.Root className="thread-item">
|
|
128
|
-
<ThreadListItemPrimitive.Trigger className="thread-trigger">
|
|
129
|
-
<ThreadListItemPrimitive.Title />
|
|
130
|
-
</ThreadListItemPrimitive.Trigger>
|
|
131
|
-
<div className="thread-actions">
|
|
132
|
-
<ThreadListItemPrimitive.Archive>
|
|
133
|
-
Archive
|
|
134
|
-
</ThreadListItemPrimitive.Archive>
|
|
135
|
-
<ThreadListItemPrimitive.Delete>
|
|
136
|
-
Delete
|
|
137
|
-
</ThreadListItemPrimitive.Delete>
|
|
138
|
-
</div>
|
|
139
|
-
</ThreadListItemPrimitive.Root>
|
|
140
|
-
);
|
|
141
|
-
};
|
|
142
|
-
```
|
|
123
|
+
### Title
|
|
143
124
|
|
|
144
|
-
|
|
125
|
+
{ThreadListItemPrimitiveDocs.Title?.deprecated && (
|
|
126
|
+
<Callout type="warn">
|
|
127
|
+
<strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Title.deprecated}
|
|
128
|
+
</Callout>
|
|
129
|
+
)}
|
|
145
130
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
Restore
|
|
155
|
-
</ThreadListItemPrimitive.Unarchive>
|
|
156
|
-
<ThreadListItemPrimitive.Delete>
|
|
157
|
-
Delete Permanently
|
|
158
|
-
</ThreadListItemPrimitive.Delete>
|
|
159
|
-
</ThreadListItemPrimitive.Root>
|
|
160
|
-
);
|
|
161
|
-
};
|
|
162
|
-
```
|
|
131
|
+
{ThreadListItemPrimitiveDocs.Title?.description}
|
|
132
|
+
|
|
133
|
+
{ThreadListItemPrimitiveDocs.Title?.element && (
|
|
134
|
+
<p>This primitive renders a <code>{`<${ThreadListItemPrimitiveDocs.Title?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
135
|
+
)}
|
|
136
|
+
|
|
137
|
+
<ParametersTable {...ThreadListItemPrimitiveTitleProps} />
|
|
138
|
+
{/* api-reference:end */}
|
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: ThreadListPrimitive
|
|
3
|
-
description:
|
|
3
|
+
description: Thread list primitives for rendering conversation navigation, new thread actions, and custom assistant sidebars.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
import { ThreadListPrimitiveItemByIndexProps, ThreadListPrimitiveItemsProps, ThreadListPrimitiveLoadMoreProps, ThreadListPrimitiveNewProps, ThreadListPrimitiveRootProps } from "@/generated/typeDocs";
|
|
7
|
+
import { ThreadListPrimitive as ThreadListPrimitiveDocs } from "@/generated/primitiveDocs";
|
|
7
8
|
|
|
9
|
+
{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
|
|
10
|
+
{/* Do not edit manually. */}
|
|
8
11
|
|
|
12
|
+
For examples and usage patterns, see [ThreadList](/docs/primitives/thread-list).
|
|
13
|
+
|
|
14
|
+
{/* api-manual:start */}
|
|
9
15
|
## Anatomy
|
|
10
16
|
|
|
11
17
|
```tsx
|
|
@@ -20,122 +26,97 @@ const ThreadList = () => (
|
|
|
20
26
|
</ThreadListPrimitive.Root>
|
|
21
27
|
);
|
|
22
28
|
```
|
|
29
|
+
{/* api-manual:end */}
|
|
30
|
+
|
|
31
|
+
{/* api-reference:start */}
|
|
32
|
+
{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
|
|
33
|
+
{/* Do not edit this block manually. */}
|
|
23
34
|
|
|
24
35
|
## API Reference
|
|
25
36
|
|
|
26
37
|
### Root
|
|
27
38
|
|
|
28
|
-
|
|
39
|
+
{ThreadListPrimitiveDocs.Root?.deprecated && (
|
|
40
|
+
<Callout type="warn">
|
|
41
|
+
<strong>Deprecated.</strong> {ThreadListPrimitiveDocs.Root.deprecated}
|
|
42
|
+
</Callout>
|
|
43
|
+
)}
|
|
44
|
+
|
|
45
|
+
{ThreadListPrimitiveDocs.Root?.description}
|
|
29
46
|
|
|
30
|
-
|
|
47
|
+
{ThreadListPrimitiveDocs.Root?.element && (
|
|
48
|
+
<p>This primitive renders a <code>{`<${ThreadListPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
49
|
+
)}
|
|
31
50
|
|
|
32
|
-
<ParametersTable
|
|
33
|
-
type="ThreadListPrimitiveRootProps"
|
|
34
|
-
parameters={[
|
|
35
|
-
{
|
|
36
|
-
name: "asChild",
|
|
37
|
-
},
|
|
38
|
-
]}
|
|
39
|
-
/>
|
|
51
|
+
<ParametersTable {...ThreadListPrimitiveRootProps} />
|
|
40
52
|
|
|
41
53
|
### New
|
|
42
54
|
|
|
43
|
-
|
|
55
|
+
{ThreadListPrimitiveDocs.New?.deprecated && (
|
|
56
|
+
<Callout type="warn">
|
|
57
|
+
<strong>Deprecated.</strong> {ThreadListPrimitiveDocs.New.deprecated}
|
|
58
|
+
</Callout>
|
|
59
|
+
)}
|
|
44
60
|
|
|
45
|
-
|
|
61
|
+
{ThreadListPrimitiveDocs.New?.description}
|
|
46
62
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
63
|
+
{ThreadListPrimitiveDocs.New?.element && (
|
|
64
|
+
<p>This primitive renders a <code>{`<${ThreadListPrimitiveDocs.New?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
65
|
+
)}
|
|
66
|
+
|
|
67
|
+
<ParametersTable {...ThreadListPrimitiveNewProps} />
|
|
68
|
+
|
|
69
|
+
{/* api-manual:ThreadListPrimitive.New:start */}
|
|
70
|
+
| Data attribute | Values |
|
|
71
|
+
| --- | --- |
|
|
72
|
+
| `[data-active]` | Present when the new-thread button represents the current fresh thread. |
|
|
73
|
+
{/* api-manual:ThreadListPrimitive.New:end */}
|
|
55
74
|
|
|
56
75
|
### Items
|
|
57
76
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
<
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
type: "ThreadListItemComponents",
|
|
72
|
-
required: true,
|
|
73
|
-
description: "The components to render for each thread list item.",
|
|
74
|
-
children: [
|
|
75
|
-
{
|
|
76
|
-
type: "ThreadListItemComponents",
|
|
77
|
-
parameters: [
|
|
78
|
-
{
|
|
79
|
-
name: "ThreadListItem",
|
|
80
|
-
type: "ComponentType",
|
|
81
|
-
required: true,
|
|
82
|
-
description: "The component to render for each thread in the list.",
|
|
83
|
-
},
|
|
84
|
-
],
|
|
85
|
-
},
|
|
86
|
-
],
|
|
87
|
-
},
|
|
88
|
-
]}
|
|
89
|
-
/>
|
|
77
|
+
{ThreadListPrimitiveDocs.Items?.deprecated && (
|
|
78
|
+
<Callout type="warn">
|
|
79
|
+
<strong>Deprecated.</strong> {ThreadListPrimitiveDocs.Items.deprecated}
|
|
80
|
+
</Callout>
|
|
81
|
+
)}
|
|
82
|
+
|
|
83
|
+
{ThreadListPrimitiveDocs.Items?.description}
|
|
84
|
+
|
|
85
|
+
{ThreadListPrimitiveDocs.Items?.element && (
|
|
86
|
+
<p>This primitive renders a <code>{`<${ThreadListPrimitiveDocs.Items?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
87
|
+
)}
|
|
88
|
+
|
|
89
|
+
<ParametersTable {...ThreadListPrimitiveItemsProps} />
|
|
90
90
|
|
|
91
91
|
### ItemByIndex
|
|
92
92
|
|
|
93
|
-
|
|
93
|
+
{ThreadListPrimitiveDocs.ItemByIndex?.deprecated && (
|
|
94
|
+
<Callout type="warn">
|
|
95
|
+
<strong>Deprecated.</strong> {ThreadListPrimitiveDocs.ItemByIndex.deprecated}
|
|
96
|
+
</Callout>
|
|
97
|
+
)}
|
|
94
98
|
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
}}
|
|
101
|
-
/>
|
|
102
|
-
```
|
|
99
|
+
{ThreadListPrimitiveDocs.ItemByIndex?.description}
|
|
100
|
+
|
|
101
|
+
{ThreadListPrimitiveDocs.ItemByIndex?.element && (
|
|
102
|
+
<p>This primitive renders a <code>{`<${ThreadListPrimitiveDocs.ItemByIndex?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
103
|
+
)}
|
|
103
104
|
|
|
104
|
-
<ParametersTable
|
|
105
|
-
type="ThreadListPrimitive.ItemByIndex.Props"
|
|
106
|
-
parameters={[
|
|
107
|
-
{
|
|
108
|
-
name: "index",
|
|
109
|
-
type: "number",
|
|
110
|
-
required: true,
|
|
111
|
-
description: "The index of the thread list item to render.",
|
|
112
|
-
},
|
|
113
|
-
{
|
|
114
|
-
name: "archived",
|
|
115
|
-
type: "boolean",
|
|
116
|
-
default: "false",
|
|
117
|
-
description: "Whether to render from archived threads instead of active threads.",
|
|
118
|
-
},
|
|
119
|
-
{
|
|
120
|
-
name: "components",
|
|
121
|
-
type: "ThreadListItemComponents",
|
|
122
|
-
required: true,
|
|
123
|
-
description: "The components to render for the thread list item.",
|
|
124
|
-
},
|
|
125
|
-
]}
|
|
126
|
-
/>
|
|
105
|
+
<ParametersTable {...ThreadListPrimitiveItemByIndexProps} />
|
|
127
106
|
|
|
128
107
|
### LoadMore
|
|
129
108
|
|
|
130
|
-
|
|
109
|
+
{ThreadListPrimitiveDocs.LoadMore?.deprecated && (
|
|
110
|
+
<Callout type="warn">
|
|
111
|
+
<strong>Deprecated.</strong> {ThreadListPrimitiveDocs.LoadMore.deprecated}
|
|
112
|
+
</Callout>
|
|
113
|
+
)}
|
|
114
|
+
|
|
115
|
+
{ThreadListPrimitiveDocs.LoadMore?.description}
|
|
131
116
|
|
|
132
|
-
|
|
117
|
+
{ThreadListPrimitiveDocs.LoadMore?.element && (
|
|
118
|
+
<p>This primitive renders a <code>{`<${ThreadListPrimitiveDocs.LoadMore?.element}>`}</code> element unless <code>asChild</code> is set.</p>
|
|
119
|
+
)}
|
|
133
120
|
|
|
134
|
-
<ParametersTable
|
|
135
|
-
|
|
136
|
-
parameters={[
|
|
137
|
-
{
|
|
138
|
-
name: "asChild",
|
|
139
|
-
},
|
|
140
|
-
]}
|
|
141
|
-
/>
|
|
121
|
+
<ParametersTable {...ThreadListPrimitiveLoadMoreProps} />
|
|
122
|
+
{/* api-reference:end */}
|