@assistant-ui/mcp-docs-server 0.1.31 → 0.1.33

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.
Files changed (281) hide show
  1. package/.docs/organized/code-examples/waterfall.md +23 -25
  2. package/.docs/organized/code-examples/with-a2a.md +28 -28
  3. package/.docs/organized/code-examples/with-ag-ui.md +35 -30
  4. package/.docs/organized/code-examples/with-ai-sdk-v6.md +16 -14
  5. package/.docs/organized/code-examples/with-artifacts.md +44 -38
  6. package/.docs/organized/code-examples/with-assistant-transport.md +68 -56
  7. package/.docs/organized/code-examples/with-browser-extension.md +357 -0
  8. package/.docs/organized/code-examples/with-chain-of-thought.md +425 -90
  9. package/.docs/organized/code-examples/with-cloud-standalone.md +30 -29
  10. package/.docs/organized/code-examples/with-cloud.md +16 -14
  11. package/.docs/organized/code-examples/with-custom-thread-list.md +19 -17
  12. package/.docs/organized/code-examples/with-elevenlabs-conversational.md +29 -26
  13. package/.docs/organized/code-examples/with-elevenlabs-scribe.md +20 -18
  14. package/.docs/organized/code-examples/with-expo.md +37 -31
  15. package/.docs/organized/code-examples/with-external-store.md +13 -11
  16. package/.docs/organized/code-examples/with-ffmpeg.md +327 -290
  17. package/.docs/organized/code-examples/with-generative-ui.md +1195 -194
  18. package/.docs/organized/code-examples/with-google-adk.md +13 -11
  19. package/.docs/organized/code-examples/with-heat-graph.md +16 -14
  20. package/.docs/organized/code-examples/with-image-generation.md +456 -0
  21. package/.docs/organized/code-examples/with-interactables.md +322 -244
  22. package/.docs/organized/code-examples/with-langchain.md +18 -16
  23. package/.docs/organized/code-examples/with-langgraph.md +95 -88
  24. package/.docs/organized/code-examples/with-livekit.md +30 -27
  25. package/.docs/organized/code-examples/with-mcp.md +754 -0
  26. package/.docs/organized/code-examples/with-opencode.md +70 -70
  27. package/.docs/organized/code-examples/with-react-hook-form.md +24 -22
  28. package/.docs/organized/code-examples/with-react-ink.md +4 -4
  29. package/.docs/organized/code-examples/with-react-router.md +20 -18
  30. package/.docs/organized/code-examples/with-resumable-stream.md +661 -0
  31. package/.docs/organized/code-examples/with-store.md +22 -20
  32. package/.docs/organized/code-examples/with-tanstack.md +18 -19
  33. package/.docs/organized/code-examples/with-tap-runtime.md +31 -28
  34. package/.docs/raw/docs/(docs)/architecture.mdx +43 -2
  35. package/.docs/raw/docs/(docs)/cli.mdx +2 -2
  36. package/.docs/raw/docs/(docs)/copilots/model-context.mdx +34 -26
  37. package/.docs/raw/docs/(docs)/copilots/motivation.mdx +32 -26
  38. package/.docs/raw/docs/(docs)/index.mdx +2 -2
  39. package/.docs/raw/docs/(docs)/installation.mdx +2 -2
  40. package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +26 -24
  41. package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +20 -0
  42. package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +20 -12
  43. package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +44 -0
  44. package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +41 -16
  45. package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +12 -23
  46. package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +20 -0
  47. package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +37 -8
  48. package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +11 -9
  49. package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +64 -0
  50. package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +22 -0
  51. package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +52 -0
  52. package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +46 -0
  53. package/.docs/raw/docs/(reference)/api-reference/generative-ui/index.mdx +18 -0
  54. package/.docs/raw/docs/(reference)/api-reference/generative-ui/rendering.mdx +33 -0
  55. package/.docs/raw/docs/(reference)/api-reference/generative-ui/spec.mdx +45 -0
  56. package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +98 -0
  57. package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +18 -13
  58. package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +31 -52
  59. package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +640 -0
  60. package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +15 -28
  61. package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +64 -18
  62. package/.docs/raw/docs/(reference)/api-reference/hooks/utilities.mdx +434 -0
  63. package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +24 -0
  64. package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +11 -12
  65. package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +109 -0
  66. package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +58 -0
  67. package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +22 -0
  68. package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +20 -0
  69. package/.docs/raw/docs/(reference)/api-reference/overview.mdx +109 -132
  70. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +78 -221
  71. package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +127 -242
  72. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +39 -20
  73. package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +66 -87
  74. package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +50 -58
  75. package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +80 -48
  76. package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +67 -0
  77. package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +323 -461
  78. package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +36 -43
  79. package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +29 -24
  80. package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +63 -245
  81. package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +202 -588
  82. package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +65 -0
  83. package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +35 -22
  84. package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +57 -140
  85. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +70 -161
  86. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +84 -108
  87. package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +77 -96
  88. package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +173 -349
  89. package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +9 -21
  90. package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +10 -21
  91. package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +15 -70
  92. package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +18 -13
  93. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +25 -28
  94. package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +11 -63
  95. package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +20 -0
  96. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +11 -48
  97. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +10 -47
  98. package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +18 -30
  99. package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +85 -0
  100. package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +39 -0
  101. package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +127 -0
  102. package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +42 -0
  103. package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +91 -0
  104. package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +48 -0
  105. package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +62 -0
  106. package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +22 -0
  107. package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +19 -0
  108. package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +143 -0
  109. package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +22 -0
  110. package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +54 -0
  111. package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +36 -0
  112. package/.docs/raw/docs/cloud/ai-sdk.mdx +1 -3
  113. package/.docs/raw/docs/cloud/index.mdx +2 -2
  114. package/.docs/raw/docs/guides/attachments.mdx +4 -4
  115. package/.docs/raw/docs/guides/branching.mdx +1 -1
  116. package/.docs/raw/docs/guides/chain-of-thought.mdx +12 -14
  117. package/.docs/raw/docs/guides/context-api.mdx +6 -5
  118. package/.docs/raw/docs/guides/dictation.mdx +2 -2
  119. package/.docs/raw/docs/guides/editing.mdx +1 -1
  120. package/.docs/raw/docs/guides/image-generation.mdx +74 -0
  121. package/.docs/raw/docs/guides/index.mdx +5 -14
  122. package/.docs/raw/docs/guides/latex.mdx +2 -2
  123. package/.docs/raw/docs/guides/mentions.mdx +6 -6
  124. package/.docs/raw/docs/guides/message-timing.mdx +38 -5
  125. package/.docs/raw/docs/guides/quoting.mdx +1 -1
  126. package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +212 -0
  127. package/.docs/raw/docs/guides/resumable-stream-stores.mdx +152 -0
  128. package/.docs/raw/docs/guides/resumable-streams.mdx +210 -0
  129. package/.docs/raw/docs/guides/slash-commands.mdx +2 -2
  130. package/.docs/raw/docs/guides/speech.mdx +2 -2
  131. package/.docs/raw/docs/guides/suggestions.mdx +89 -5
  132. package/.docs/raw/docs/guides/voice.mdx +2 -2
  133. package/.docs/raw/docs/ink/adapters.mdx +37 -1
  134. package/.docs/raw/docs/ink/custom-backend.mdx +59 -8
  135. package/.docs/raw/docs/ink/hooks.mdx +98 -85
  136. package/.docs/raw/docs/ink/index.mdx +10 -11
  137. package/.docs/raw/docs/ink/migration.mdx +1 -1
  138. package/.docs/raw/docs/ink/primitives.mdx +350 -9
  139. package/.docs/raw/docs/integrations/auth/better-auth.mdx +1 -1
  140. package/.docs/raw/docs/integrations/auth/clerk.mdx +1 -1
  141. package/.docs/raw/docs/integrations/auth/next-auth.mdx +1 -1
  142. package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +3 -3
  143. package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +282 -0
  144. package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +2 -2
  145. package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +1 -1
  146. package/.docs/raw/docs/integrations/gateways/index.mdx +9 -4
  147. package/.docs/raw/docs/integrations/index.mdx +17 -5
  148. package/.docs/raw/docs/integrations/observability/langfuse.mdx +8 -1
  149. package/.docs/raw/docs/integrations/observability/langsmith.mdx +8 -4
  150. package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +17 -2
  151. package/.docs/raw/docs/migrations/toolkit-tools.mdx +226 -0
  152. package/.docs/raw/docs/primitives/chain-of-thought.mdx +10 -16
  153. package/.docs/raw/docs/primitives/composer.mdx +53 -0
  154. package/.docs/raw/docs/primitives/index.mdx +2 -2
  155. package/.docs/raw/docs/primitives/message.mdx +9 -10
  156. package/.docs/raw/docs/primitives/suggestion.mdx +9 -0
  157. package/.docs/raw/docs/react-native/hooks.mdx +57 -82
  158. package/.docs/raw/docs/react-native/index.mdx +4 -4
  159. package/.docs/raw/docs/react-native/migration.mdx +1 -1
  160. package/.docs/raw/docs/react-native/primitives.mdx +2 -2
  161. package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +7 -4
  162. package/.docs/raw/docs/runtimes/a2a/overview.mdx +2 -2
  163. package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +2 -2
  164. package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +32 -1
  165. package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +2 -2
  166. package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +7 -2
  167. package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +1 -1
  168. package/.docs/raw/docs/runtimes/ai-sdk/v6.mdx +129 -1
  169. package/.docs/raw/docs/runtimes/concepts/threads.mdx +7 -1
  170. package/.docs/raw/docs/runtimes/custom/data-stream.mdx +27 -2
  171. package/.docs/raw/docs/runtimes/custom/external-store.mdx +9 -1
  172. package/.docs/raw/docs/runtimes/custom/local-runtime.mdx +18 -7
  173. package/.docs/raw/docs/runtimes/custom/overview.mdx +2 -2
  174. package/.docs/raw/docs/runtimes/google-adk/hooks.mdx +108 -38
  175. package/.docs/raw/docs/runtimes/google-adk/overview.mdx +2 -2
  176. package/.docs/raw/docs/runtimes/langchain.mdx +2 -2
  177. package/.docs/raw/docs/runtimes/langgraph/generative-ui.mdx +2 -2
  178. package/.docs/raw/docs/runtimes/langgraph/overview.mdx +2 -2
  179. package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +1 -1
  180. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +64 -50
  181. package/.docs/raw/docs/runtimes/langgraph/tutorial/part-3.mdx +98 -86
  182. package/.docs/raw/docs/runtimes/opencode/overview.mdx +2 -2
  183. package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +1 -1
  184. package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +12 -5
  185. package/.docs/raw/docs/tools/backend.mdx +136 -0
  186. package/.docs/raw/docs/tools/defining-tools.mdx +413 -0
  187. package/.docs/raw/docs/tools/dynamic-tools.mdx +110 -0
  188. package/.docs/raw/docs/tools/generative-ui.mdx +214 -0
  189. package/.docs/raw/docs/tools/index.mdx +76 -0
  190. package/.docs/raw/docs/{guides → tools}/interactables.mdx +3 -3
  191. package/.docs/raw/docs/tools/mcp-apps.mdx +231 -0
  192. package/.docs/raw/docs/{integrations/tools → tools}/mcp.mdx +77 -50
  193. package/.docs/raw/docs/{guides → tools}/multi-agent.mdx +19 -21
  194. package/.docs/raw/docs/tools/tool-ui.mdx +967 -0
  195. package/.docs/raw/docs/tools/user-managed-mcp.mdx +337 -0
  196. package/.docs/raw/docs/ui/composer-trigger-popover.mdx +11 -1
  197. package/.docs/raw/docs/ui/directive-text.mdx +3 -3
  198. package/.docs/raw/docs/ui/mcp-config.mdx +102 -0
  199. package/.docs/raw/docs/ui/model-selector.mdx +8 -8
  200. package/.docs/raw/docs/ui/part-grouping.mdx +84 -50
  201. package/.docs/raw/docs/ui/reasoning.mdx +4 -5
  202. package/.docs/raw/docs/ui/sources.mdx +17 -0
  203. package/.docs/raw/docs/ui/streamdown.mdx +34 -2
  204. package/.docs/raw/docs/ui/thread-list.mdx +2 -2
  205. package/.docs/raw/docs/ui/thread.mdx +2 -2
  206. package/.docs/raw/docs/ui/tool-group.mdx +5 -6
  207. package/.docs/raw/docs/utilities/heat-graph.mdx +1 -1
  208. package/README.md +14 -72
  209. package/dist/constants.d.ts +12 -9
  210. package/dist/constants.d.ts.map +1 -1
  211. package/dist/constants.js +13 -9
  212. package/dist/constants.js.map +1 -1
  213. package/dist/index.d.ts +7 -3
  214. package/dist/index.d.ts.map +1 -1
  215. package/dist/index.js +25 -24
  216. package/dist/index.js.map +1 -1
  217. package/dist/prepare-docs/code-examples.d.ts +4 -1
  218. package/dist/prepare-docs/code-examples.d.ts.map +1 -1
  219. package/dist/prepare-docs/code-examples.js +109 -121
  220. package/dist/prepare-docs/code-examples.js.map +1 -1
  221. package/dist/prepare-docs/copy-raw.d.ts +4 -1
  222. package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
  223. package/dist/prepare-docs/copy-raw.js +45 -42
  224. package/dist/prepare-docs/copy-raw.js.map +1 -1
  225. package/dist/prepare-docs/prepare.d.ts +1 -2
  226. package/dist/prepare-docs/prepare.js +17 -17
  227. package/dist/prepare-docs/prepare.js.map +1 -1
  228. package/dist/stdio.d.ts +1 -3
  229. package/dist/stdio.js +6 -3
  230. package/dist/stdio.js.map +1 -1
  231. package/dist/tools/docs.d.ts +20 -15
  232. package/dist/tools/docs.d.ts.map +1 -1
  233. package/dist/tools/docs.js +140 -161
  234. package/dist/tools/docs.js.map +1 -1
  235. package/dist/tools/examples.d.ts +20 -15
  236. package/dist/tools/examples.d.ts.map +1 -1
  237. package/dist/tools/examples.js +74 -86
  238. package/dist/tools/examples.js.map +1 -1
  239. package/dist/tools/tests/test-setup.d.ts +5 -2
  240. package/dist/tools/tests/test-setup.d.ts.map +1 -1
  241. package/dist/tools/tests/test-setup.js +21 -28
  242. package/dist/tools/tests/test-setup.js.map +1 -1
  243. package/dist/utils/logger.d.ts +8 -5
  244. package/dist/utils/logger.d.ts.map +1 -1
  245. package/dist/utils/logger.js +17 -17
  246. package/dist/utils/logger.js.map +1 -1
  247. package/dist/utils/mcp-format.d.ts +8 -5
  248. package/dist/utils/mcp-format.d.ts.map +1 -1
  249. package/dist/utils/mcp-format.js +9 -9
  250. package/dist/utils/mcp-format.js.map +1 -1
  251. package/dist/utils/mdx.d.ts +8 -6
  252. package/dist/utils/mdx.d.ts.map +1 -1
  253. package/dist/utils/mdx.js +22 -22
  254. package/dist/utils/mdx.js.map +1 -1
  255. package/dist/utils/paths.d.ts +9 -6
  256. package/dist/utils/paths.d.ts.map +1 -1
  257. package/dist/utils/paths.js +66 -76
  258. package/dist/utils/paths.js.map +1 -1
  259. package/dist/utils/security.d.ts +4 -1
  260. package/dist/utils/security.d.ts.map +1 -1
  261. package/dist/utils/security.js +19 -40
  262. package/dist/utils/security.js.map +1 -1
  263. package/package.json +5 -5
  264. package/.docs/organized/code-examples/with-parent-id-grouping.md +0 -596
  265. package/.docs/raw/docs/(docs)/copilots/make-assistant-tool-ui.mdx +0 -151
  266. package/.docs/raw/docs/(docs)/copilots/make-assistant-tool.mdx +0 -230
  267. package/.docs/raw/docs/(reference)/api-reference/adapters/feedback-speech.mdx +0 -41
  268. package/.docs/raw/docs/(reference)/api-reference/context-providers/text-message-part-provider.mdx +0 -40
  269. package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -260
  270. package/.docs/raw/docs/(reference)/api-reference/integrations/react-hook-form.mdx +0 -103
  271. package/.docs/raw/docs/(reference)/api-reference/integrations/vercel-ai-sdk.mdx +0 -254
  272. package/.docs/raw/docs/guides/tool-ui.mdx +0 -858
  273. package/.docs/raw/docs/guides/tools.mdx +0 -675
  274. package/dist/prepare-docs/prepare.d.ts.map +0 -1
  275. package/dist/stdio.d.ts.map +0 -1
  276. /package/.docs/raw/docs/{(reference)/migrations → migrations}/deprecation-policy.mdx +0 -0
  277. /package/.docs/raw/docs/{(reference) → migrations}/react-compatibility.mdx +0 -0
  278. /package/.docs/raw/docs/{(reference)/migrations → migrations}/react-langgraph-v0-7.mdx +0 -0
  279. /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-11.mdx +0 -0
  280. /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-12.mdx +0 -0
  281. /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-14.mdx +0 -0
@@ -1,11 +1,15 @@
1
1
  ---
2
2
  title: ThreadListItemPrimitive
3
- description: Individual thread item with title, archive, and delete controls.
3
+ description: Thread list item primitives for rendering selectable conversation rows with titles, archive controls, delete actions, and menus.
4
4
  ---
5
5
 
6
- A single thread item within a thread list.
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
- Contains all parts of the thread list item.
39
+ {ThreadListItemPrimitiveDocs.Root?.deprecated && (
40
+ <Callout type="warn">
41
+ <strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Root.deprecated}
42
+ </Callout>
43
+ )}
31
44
 
32
- This primitive renders a `<div>` element unless `asChild` is set. It automatically adds `data-active="true"` and `aria-current="true"` attributes when the thread is the currently active thread.
45
+ {ThreadListItemPrimitiveDocs.Root?.description}
33
46
 
34
- <ParametersTable
35
- type="ThreadListItemPrimitiveRootProps"
36
- parameters={[
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
- ### Trigger
51
+ <ParametersTable {...ThreadListItemPrimitiveRootProps} />
44
52
 
45
- A button that switches to the thread when clicked.
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
- This primitive renders a `<button>` element unless `asChild` is set.
59
+ ### Archive
48
60
 
49
- <ParametersTable
50
- type="ThreadListItemPrimitiveTriggerProps"
51
- parameters={[
52
- {
53
- name: "asChild",
54
- },
55
- ]}
56
- />
61
+ {ThreadListItemPrimitiveDocs.Archive?.deprecated && (
62
+ <Callout type="warn">
63
+ <strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Archive.deprecated}
64
+ </Callout>
65
+ )}
57
66
 
58
- ### Title
67
+ {ThreadListItemPrimitiveDocs.Archive?.description}
59
68
 
60
- Displays the title of the thread.
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
- This primitive renders as a React Fragment with no wrapper DOM element. It outputs the thread's title text directly, or the `fallback` content if no title is available.
73
+ <ParametersTable {...ThreadListItemPrimitiveArchiveProps} />
63
74
 
64
- <ParametersTable
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
- ### Archive
77
+ {ThreadListItemPrimitiveDocs.Unarchive?.deprecated && (
78
+ <Callout type="warn">
79
+ <strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Unarchive.deprecated}
80
+ </Callout>
81
+ )}
76
82
 
77
- A button to archive the thread. Only shown for non-archived threads.
83
+ {ThreadListItemPrimitiveDocs.Unarchive?.description}
78
84
 
79
- This primitive renders a `<button>` element unless `asChild` is set.
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
- ### Unarchive
91
+ ### Delete
91
92
 
92
- A button to unarchive the thread. Only shown for archived threads.
93
+ {ThreadListItemPrimitiveDocs.Delete?.deprecated && (
94
+ <Callout type="warn">
95
+ <strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Delete.deprecated}
96
+ </Callout>
97
+ )}
93
98
 
94
- This primitive renders a `<button>` element unless `asChild` is set.
99
+ {ThreadListItemPrimitiveDocs.Delete?.description}
95
100
 
96
- <ParametersTable
97
- type="ThreadListItemPrimitiveUnarchiveProps"
98
- parameters={[
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
- ### Delete
105
+ <ParametersTable {...ThreadListItemPrimitiveDeleteProps} />
106
106
 
107
- A button to permanently delete the thread.
107
+ ### Trigger
108
108
 
109
- This primitive renders a `<button>` element unless `asChild` is set.
109
+ {ThreadListItemPrimitiveDocs.Trigger?.deprecated && (
110
+ <Callout type="warn">
111
+ <strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Trigger.deprecated}
112
+ </Callout>
113
+ )}
110
114
 
111
- <ParametersTable
112
- type="ThreadListItemPrimitiveDeleteProps"
113
- parameters={[
114
- {
115
- name: "asChild",
116
- },
117
- ]}
118
- />
115
+ {ThreadListItemPrimitiveDocs.Trigger?.description}
119
116
 
120
- ## Examples
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
- ### Basic Thread List Item
121
+ <ParametersTable {...ThreadListItemPrimitiveTriggerProps} />
123
122
 
124
- ```tsx
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
- ### Archived Thread List Item
125
+ {ThreadListItemPrimitiveDocs.Title?.deprecated && (
126
+ <Callout type="warn">
127
+ <strong>Deprecated.</strong> {ThreadListItemPrimitiveDocs.Title.deprecated}
128
+ </Callout>
129
+ )}
145
130
 
146
- ```tsx
147
- const ArchivedThreadListItem = () => {
148
- return (
149
- <ThreadListItemPrimitive.Root className="archived-thread-item">
150
- <ThreadListItemPrimitive.Trigger>
151
- <ThreadListItemPrimitive.Title />
152
- </ThreadListItemPrimitive.Trigger>
153
- <ThreadListItemPrimitive.Unarchive>
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: Display and manage multiple conversation threads with create and archive actions.
3
+ description: Thread list primitives for rendering conversation navigation, new thread actions, and custom assistant sidebars.
4
4
  ---
5
5
 
6
- Displays a list of conversation threads.
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
- Contains all parts of the thread list.
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
- This primitive renders a `<div>` element unless `asChild` is set.
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
- A button to create a new thread.
55
+ {ThreadListPrimitiveDocs.New?.deprecated && (
56
+ <Callout type="warn">
57
+ <strong>Deprecated.</strong> {ThreadListPrimitiveDocs.New.deprecated}
58
+ </Callout>
59
+ )}
44
60
 
45
- This primitive renders a `<button>` element unless `asChild` is set.
61
+ {ThreadListPrimitiveDocs.New?.description}
46
62
 
47
- <ParametersTable
48
- type="ThreadListPrimitiveNewProps"
49
- parameters={[
50
- {
51
- name: "asChild",
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
- Renders all items in the thread list.
59
-
60
- <ParametersTable
61
- type="ThreadListPrimitive.Items.Props"
62
- parameters={[
63
- {
64
- name: "archived",
65
- type: "boolean",
66
- default: "false",
67
- description: "Whether to show archived threads instead of active threads.",
68
- },
69
- {
70
- name: "components",
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
- Renders a single thread list item at the specified index.
93
+ {ThreadListPrimitiveDocs.ItemByIndex?.deprecated && (
94
+ <Callout type="warn">
95
+ <strong>Deprecated.</strong> {ThreadListPrimitiveDocs.ItemByIndex.deprecated}
96
+ </Callout>
97
+ )}
94
98
 
95
- ```tsx
96
- <ThreadListPrimitive.ItemByIndex
97
- index={0}
98
- components={{
99
- ThreadListItem: MyThreadListItem
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
- A button that calls `aui.threads().loadMore()` to append the next page. See the [LoadMore primitive reference](/docs/primitives/thread-list#loadmore) for usage and [Threads concepts](/docs/runtimes/concepts/threads#paginating-the-thread-list) for the adapter contract.
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
- This primitive renders a `<button>` element unless `asChild` is set.
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
- type="ThreadListPrimitiveLoadMoreProps"
136
- parameters={[
137
- {
138
- name: "asChild",
139
- },
140
- ]}
141
- />
121
+ <ParametersTable {...ThreadListPrimitiveLoadMoreProps} />
122
+ {/* api-reference:end */}