@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,17 @@
1
1
  ---
2
2
  title: AssistantModalPrimitive
3
- description: A popover chat interface for floating assistant UI in the corner of the screen.
3
+ description: Floating assistant modal primitives for building support chat, copilot, and embedded assistant experiences.
4
4
  ---
5
5
 
6
- A modal chat UI usually displayed in the bottom right corner of the screen.
6
+ import { AssistantModalPrimitiveAnchorProps, AssistantModalPrimitiveContentProps, AssistantModalPrimitiveRootProps, AssistantModalPrimitiveTriggerProps } from "@/generated/typeDocs";
7
+ import { AssistantModalPrimitive as AssistantModalPrimitiveDocs } 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 [AssistantModal](/docs/primitives/assistant-modal).
13
+
14
+ {/* api-manual:start */}
9
15
  ## Anatomy
10
16
 
11
17
  ```tsx
@@ -22,108 +28,81 @@ const AssistantModal = () => (
22
28
  </AssistantModalPrimitive.Root>
23
29
  );
24
30
  ```
31
+ {/* api-manual:end */}
32
+
33
+ {/* api-reference:start */}
34
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
35
+ {/* Do not edit this block manually. */}
25
36
 
26
37
  ## API Reference
27
38
 
28
39
  ### Root
29
40
 
30
- Contains all parts of the assistant modal.
31
-
32
- <ParametersTable
33
- type="AssistantModalPrimitiveRootProps"
34
- parameters={[
35
- {
36
- name: "defaultOpen",
37
- type: "boolean",
38
- default: "false",
39
- description:
40
- "The open state of the assistant modal when it is initially rendered. Use when you do not need to control its open state.",
41
- },
42
- {
43
- name: "open",
44
- type: "boolean",
45
- description:
46
- "Not recommended. The controlled open state of the assistant modal. Must be used in conjunction with onOpenChange.",
47
- },
48
- {
49
- name: "onOpenChange",
50
- type: "(open: boolean) => void",
51
- description:
52
- "Event handler called when the open state of the assistant modal changes.",
53
- },
54
- {
55
- name: "modal",
56
- type: "boolean",
57
- default: "false",
58
- description:
59
- "The modality of the assistant modal. When set to true, interaction with outside elements will be disabled and only modal content will be visible to screen readers.",
60
- },
61
- ]}
62
- />
41
+ {AssistantModalPrimitiveDocs.Root?.deprecated && (
42
+ <Callout type="warn">
43
+ <strong>Deprecated.</strong> {AssistantModalPrimitiveDocs.Root.deprecated}
44
+ </Callout>
45
+ )}
46
+
47
+ {AssistantModalPrimitiveDocs.Root?.description}
48
+
49
+ {AssistantModalPrimitiveDocs.Root?.element && (
50
+ <p>This primitive renders a <code>{`<${AssistantModalPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
51
+ )}
52
+
53
+ <ParametersTable {...AssistantModalPrimitiveRootProps} />
63
54
 
64
55
  ### Trigger
65
56
 
66
- A button that toggles the open state of the assistant modal. `AssistantModalPrimitive.Content` will position itself against this button.
57
+ {AssistantModalPrimitiveDocs.Trigger?.deprecated && (
58
+ <Callout type="warn">
59
+ <strong>Deprecated.</strong> {AssistantModalPrimitiveDocs.Trigger.deprecated}
60
+ </Callout>
61
+ )}
62
+
63
+ {AssistantModalPrimitiveDocs.Trigger?.description}
67
64
 
68
- This primitive renders a `<button>` element unless `asChild` is set.
65
+ {AssistantModalPrimitiveDocs.Trigger?.element && (
66
+ <p>This primitive renders a <code>{`<${AssistantModalPrimitiveDocs.Trigger?.element}>`}</code> element unless <code>asChild</code> is set.</p>
67
+ )}
69
68
 
70
- <ParametersTable
71
- type="AssistantModalPrimitiveTriggerProps"
72
- parameters={[
73
- {
74
- name: "asChild",
75
- },
76
- ]}
77
- />
69
+ <ParametersTable {...AssistantModalPrimitiveTriggerProps} />
78
70
 
71
+ {/* api-manual:AssistantModalPrimitive.Trigger:start */}
79
72
  | Data attribute | Values |
80
73
  | --- | --- |
81
74
  | `[data-state]` | `"open" \| "closed"` |
75
+ {/* api-manual:AssistantModalPrimitive.Trigger:end */}
76
+
77
+ ### Content
78
+
79
+ {AssistantModalPrimitiveDocs.Content?.deprecated && (
80
+ <Callout type="warn">
81
+ <strong>Deprecated.</strong> {AssistantModalPrimitiveDocs.Content.deprecated}
82
+ </Callout>
83
+ )}
84
+
85
+ {AssistantModalPrimitiveDocs.Content?.description}
86
+
87
+ {AssistantModalPrimitiveDocs.Content?.element && (
88
+ <p>This primitive renders a <code>{`<${AssistantModalPrimitiveDocs.Content?.element}>`}</code> element unless <code>asChild</code> is set.</p>
89
+ )}
90
+
91
+ <ParametersTable {...AssistantModalPrimitiveContentProps} />
82
92
 
83
93
  ### Anchor
84
94
 
85
- The anchor element that the assistant modal is attached to. Defaults to the `Trigger` element.
95
+ {AssistantModalPrimitiveDocs.Anchor?.deprecated && (
96
+ <Callout type="warn">
97
+ <strong>Deprecated.</strong> {AssistantModalPrimitiveDocs.Anchor.deprecated}
98
+ </Callout>
99
+ )}
86
100
 
87
- This primitive renders a `<div>` element unless `asChild` is set.
101
+ {AssistantModalPrimitiveDocs.Anchor?.description}
88
102
 
89
- ### Content
103
+ {AssistantModalPrimitiveDocs.Anchor?.element && (
104
+ <p>This primitive renders a <code>{`<${AssistantModalPrimitiveDocs.Anchor?.element}>`}</code> element unless <code>asChild</code> is set.</p>
105
+ )}
90
106
 
91
- The component that pops out when the assistant modal is open.
92
-
93
- This primitive renders a `<div>` element unless `asChild` is set.
94
-
95
- <ParametersTable
96
- type="AssistantModalPrimitiveContentProps"
97
- parameters={[
98
- {
99
- name: "asChild",
100
- },
101
- {
102
- name: "side",
103
- type: "'top' | 'right' | 'bottom' | 'left'",
104
- default: "'top'",
105
- description: "The side of the assistant modal to position against.",
106
- },
107
- {
108
- name: "align",
109
- type: "'start' | 'center' | 'end'",
110
- default: "'end'",
111
- description: "The alignment of the assistant modal to position against.",
112
- },
113
- {
114
- name: "dissmissOnInteractOutside",
115
- type: "boolean",
116
- default: "false",
117
- description:
118
- "Dismiss the assistant modal when the user interacts outside of it.",
119
- },
120
- {
121
- name: "portalProps",
122
- type: "{ container?: HTMLElement | null; forceMount?: true }",
123
- description:
124
- "Props to pass to the underlying Radix UI Popover.Portal. Use container to render the modal into a specific DOM node, or forceMount to keep it mounted for animation control.",
125
- },
126
- ]}
127
- />
128
-
129
- Refer to Radix UI's Documentation for [Popover.Content](https://www.radix-ui.com/primitives/docs/components/popover#content) for more details.
107
+ <ParametersTable {...AssistantModalPrimitiveAnchorProps} />
108
+ {/* api-reference:end */}
@@ -1,15 +1,17 @@
1
1
  ---
2
2
  title: AttachmentPrimitive
3
- description: Components for displaying and managing file attachments in messages and composer.
3
+ description: Attachment primitives for rendering file previews, names, thumbnails, and remove controls in assistant-ui messages and composers.
4
4
  ---
5
5
 
6
- Buttons to interact with attachments.
6
+ import { AttachmentPrimitiveRemoveProps, AttachmentPrimitiveRootProps } from "@/generated/typeDocs";
7
+ import { AttachmentPrimitive as AttachmentPrimitiveDocs } from "@/generated/primitiveDocs";
7
8
 
9
+ {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
10
+ {/* Do not edit manually. */}
8
11
 
9
- <Callout>
10
- **Dual Use!** Attachments can appear in both messages and composers.
11
- </Callout>
12
+ For examples and usage patterns, see [Attachment](/docs/primitives/attachment).
12
13
 
14
+ {/* api-manual:start */}
13
15
  ## Anatomy
14
16
 
15
17
  ```tsx
@@ -30,71 +32,61 @@ const MyComposerAttachment = () => (
30
32
  </AttachmentPrimitive.Root>
31
33
  );
32
34
  ```
35
+ {/* api-manual:end */}
36
+
37
+ {/* api-reference:start */}
38
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
39
+ {/* Do not edit this block manually. */}
33
40
 
34
41
  ## API Reference
35
42
 
36
43
  ### Root
37
44
 
38
- Contains all parts of the attachment.
39
-
40
- This primitive renders a `<div>` element unless `asChild` is set. Accepts all standard HTML div element props.
41
-
42
- <ParametersTable
43
- type="AttachmentPrimitiveRootProps"
44
- parameters={[
45
- {
46
- name: "asChild",
47
- },
48
- {
49
- name: "...props",
50
- type: "HTMLAttributes<HTMLDivElement>",
51
- description: "All standard div element props are forwarded to the underlying element.",
52
- },
53
- ]}
54
- />
55
-
56
- ### unstable_Thumb
57
-
58
- The thumbnail of the attachment.
59
-
60
- This primitive renders a `<div>` element unless `asChild` is set. Accepts all standard HTML div element props.
61
-
62
- <ParametersTable
63
- type="AttachmentPrimitiveThumbProps"
64
- parameters={[
65
- {
66
- name: "asChild",
67
- },
68
- {
69
- name: "...props",
70
- type: "HTMLAttributes<HTMLDivElement>",
71
- description: "All standard div element props are forwarded to the underlying element.",
72
- },
73
- ]}
74
- />
45
+ {AttachmentPrimitiveDocs.Root?.deprecated && (
46
+ <Callout type="warn">
47
+ <strong>Deprecated.</strong> {AttachmentPrimitiveDocs.Root.deprecated}
48
+ </Callout>
49
+ )}
50
+
51
+ {AttachmentPrimitiveDocs.Root?.description}
52
+
53
+ {AttachmentPrimitiveDocs.Root?.element && (
54
+ <p>This primitive renders a <code>{`<${AttachmentPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
55
+ )}
56
+
57
+ <ParametersTable {...AttachmentPrimitiveRootProps} />
75
58
 
76
59
  ### Name
77
60
 
78
- The name of the attachment.
61
+ {AttachmentPrimitiveDocs.Name?.deprecated && (
62
+ <Callout type="warn">
63
+ <strong>Deprecated.</strong> {AttachmentPrimitiveDocs.Name.deprecated}
64
+ </Callout>
65
+ )}
66
+
67
+ {AttachmentPrimitiveDocs.Name?.description}
79
68
 
80
- This primitive renders a text node with the attachment's file name. It accepts no props.
69
+ {AttachmentPrimitiveDocs.Name?.element && (
70
+ <p>This primitive renders a <code>{`<${AttachmentPrimitiveDocs.Name?.element}>`}</code> element unless <code>asChild</code> is set.</p>
71
+ )}
81
72
 
82
- <ParametersTable
83
- type="AttachmentPrimitiveNameProps"
84
- parameters={[]}
85
- />
73
+ {AttachmentPrimitiveDocs.Name?.props && (
74
+ <ParametersTable type={AttachmentPrimitiveDocs.Name?.element} parameters={AttachmentPrimitiveDocs.Name.props} />
75
+ )}
86
76
 
87
77
  ### Remove
88
78
 
89
- Removes the attachment.
79
+ {AttachmentPrimitiveDocs.Remove?.deprecated && (
80
+ <Callout type="warn">
81
+ <strong>Deprecated.</strong> {AttachmentPrimitiveDocs.Remove.deprecated}
82
+ </Callout>
83
+ )}
84
+
85
+ {AttachmentPrimitiveDocs.Remove?.description}
90
86
 
91
- This primitive renders a `<button>` element unless `asChild` is set.
87
+ {AttachmentPrimitiveDocs.Remove?.element && (
88
+ <p>This primitive renders a <code>{`<${AttachmentPrimitiveDocs.Remove?.element}>`}</code> element unless <code>asChild</code> is set.</p>
89
+ )}
92
90
 
93
- <ParametersTable
94
- type="AttachmentPrimitiveRemoveProps"
95
- parameters={[
96
- {
97
- name: "asChild",
98
- },
99
- ]}
100
- />
91
+ <ParametersTable {...AttachmentPrimitiveRemoveProps} />
92
+ {/* api-reference:end */}
@@ -1,11 +1,17 @@
1
1
  ---
2
2
  title: BranchPickerPrimitive
3
- description: Navigate between conversation branches with previous/next controls.
3
+ description: Branch picker primitives for navigating regenerated assistant responses and alternate message paths inside a chat thread.
4
4
  ---
5
5
 
6
- View and switch between branches.
6
+ import { BranchPickerPrimitiveNextProps, BranchPickerPrimitivePreviousProps, BranchPickerPrimitiveRootProps } from "@/generated/typeDocs";
7
+ import { BranchPickerPrimitive as BranchPickerPrimitiveDocs } 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 [BranchPicker](/docs/primitives/branch-picker).
13
+
14
+ {/* api-manual:start */}
9
15
  ## Anatomy
10
16
 
11
17
  ```tsx
@@ -19,69 +25,95 @@ const BranchPicker = () => (
19
25
  </BranchPickerPrimitive.Root>
20
26
  );
21
27
  ```
28
+ {/* api-manual:end */}
29
+
30
+ {/* api-reference:start */}
31
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
32
+ {/* Do not edit this block manually. */}
22
33
 
23
34
  ## API Reference
24
35
 
25
36
  ### Root
26
37
 
27
- Contains all parts of the branch picker.
28
-
29
- This primitive renders a `<div>` element unless `asChild` is set.
30
-
31
- <ParametersTable
32
- type="BranchPickerPrimitiveRootProps"
33
- parameters={[
34
- {
35
- name: "asChild",
36
- },
37
- {
38
- name: "hideWhenSingleBranch",
39
- type: "boolean",
40
- default: "false",
41
- description:
42
- "Do not render the BranchPicker when there is only one branch at the current message.",
43
- },
44
- ]}
45
- />
38
+ {BranchPickerPrimitiveDocs.Root?.deprecated && (
39
+ <Callout type="warn">
40
+ <strong>Deprecated.</strong> {BranchPickerPrimitiveDocs.Root.deprecated}
41
+ </Callout>
42
+ )}
46
43
 
47
- ### Number
44
+ {BranchPickerPrimitiveDocs.Root?.description}
48
45
 
49
- The current branch number.
46
+ {BranchPickerPrimitiveDocs.Root?.element && (
47
+ <p>This primitive renders a <code>{`<${BranchPickerPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
48
+ )}
50
49
 
51
- This primitive renders the raw number as a string.
50
+ <ParametersTable {...BranchPickerPrimitiveRootProps} />
52
51
 
53
- ### Count
52
+ ### Next
54
53
 
55
- The total number of branches.
54
+ {BranchPickerPrimitiveDocs.Next?.deprecated && (
55
+ <Callout type="warn">
56
+ <strong>Deprecated.</strong> {BranchPickerPrimitiveDocs.Next.deprecated}
57
+ </Callout>
58
+ )}
56
59
 
57
- This primitive renders the raw number as a string.
60
+ {BranchPickerPrimitiveDocs.Next?.description}
61
+
62
+ {BranchPickerPrimitiveDocs.Next?.element && (
63
+ <p>This primitive renders a <code>{`<${BranchPickerPrimitiveDocs.Next?.element}>`}</code> element unless <code>asChild</code> is set.</p>
64
+ )}
65
+
66
+ <ParametersTable {...BranchPickerPrimitiveNextProps} />
58
67
 
59
68
  ### Previous
60
69
 
61
- Navigates to the previous branch.
70
+ {BranchPickerPrimitiveDocs.Previous?.deprecated && (
71
+ <Callout type="warn">
72
+ <strong>Deprecated.</strong> {BranchPickerPrimitiveDocs.Previous.deprecated}
73
+ </Callout>
74
+ )}
62
75
 
63
- This primitive renders a `<button>` element unless `asChild` is set.
76
+ {BranchPickerPrimitiveDocs.Previous?.description}
64
77
 
65
- <ParametersTable
66
- type="BranchPickerPrimitivePreviousProps"
67
- parameters={[
68
- {
69
- name: "asChild",
70
- },
71
- ]}
72
- />
78
+ {BranchPickerPrimitiveDocs.Previous?.element && (
79
+ <p>This primitive renders a <code>{`<${BranchPickerPrimitiveDocs.Previous?.element}>`}</code> element unless <code>asChild</code> is set.</p>
80
+ )}
73
81
 
74
- ### Next
82
+ <ParametersTable {...BranchPickerPrimitivePreviousProps} />
83
+
84
+ ### Count
85
+
86
+ {BranchPickerPrimitiveDocs.Count?.deprecated && (
87
+ <Callout type="warn">
88
+ <strong>Deprecated.</strong> {BranchPickerPrimitiveDocs.Count.deprecated}
89
+ </Callout>
90
+ )}
91
+
92
+ {BranchPickerPrimitiveDocs.Count?.description}
93
+
94
+ {BranchPickerPrimitiveDocs.Count?.element && (
95
+ <p>This primitive renders a <code>{`<${BranchPickerPrimitiveDocs.Count?.element}>`}</code> element unless <code>asChild</code> is set.</p>
96
+ )}
97
+
98
+ {BranchPickerPrimitiveDocs.Count?.props && (
99
+ <ParametersTable type={BranchPickerPrimitiveDocs.Count?.element} parameters={BranchPickerPrimitiveDocs.Count.props} />
100
+ )}
101
+
102
+ ### Number
103
+
104
+ {BranchPickerPrimitiveDocs.Number?.deprecated && (
105
+ <Callout type="warn">
106
+ <strong>Deprecated.</strong> {BranchPickerPrimitiveDocs.Number.deprecated}
107
+ </Callout>
108
+ )}
75
109
 
76
- Navigates to the next branch.
110
+ {BranchPickerPrimitiveDocs.Number?.description}
77
111
 
78
- This primitive renders a `<button>` element unless `asChild` is set.
112
+ {BranchPickerPrimitiveDocs.Number?.element && (
113
+ <p>This primitive renders a <code>{`<${BranchPickerPrimitiveDocs.Number?.element}>`}</code> element unless <code>asChild</code> is set.</p>
114
+ )}
79
115
 
80
- <ParametersTable
81
- type="BranchPickerPrimitiveNextProps"
82
- parameters={[
83
- {
84
- name: "asChild",
85
- },
86
- ]}
87
- />
116
+ {BranchPickerPrimitiveDocs.Number?.props && (
117
+ <ParametersTable type={BranchPickerPrimitiveDocs.Number?.element} parameters={BranchPickerPrimitiveDocs.Number.props} />
118
+ )}
119
+ {/* api-reference:end */}
@@ -0,0 +1,67 @@
1
+ ---
2
+ title: ChainOfThoughtPrimitive
3
+ description: Chain of thought primitives for rendering assistant reasoning, step lists, and collapsible disclosure UI in message content.
4
+ ---
5
+
6
+ import { ChainOfThoughtPrimitiveAccordionTriggerProps, ChainOfThoughtPrimitivePartsProps, ChainOfThoughtPrimitiveRootProps } from "@/generated/typeDocs";
7
+ import { ChainOfThoughtPrimitive as ChainOfThoughtPrimitiveDocs } from "@/generated/primitiveDocs";
8
+
9
+ {/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
10
+ {/* Do not edit manually. */}
11
+
12
+ For examples and usage patterns, see [ChainOfThought](/docs/primitives/chain-of-thought).
13
+
14
+ {/* api-reference:start */}
15
+ {/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
16
+ {/* Do not edit this block manually. */}
17
+
18
+ ## API Reference
19
+
20
+ ### Root
21
+
22
+ {ChainOfThoughtPrimitiveDocs.Root?.deprecated && (
23
+ <Callout type="warn">
24
+ <strong>Deprecated.</strong> {ChainOfThoughtPrimitiveDocs.Root.deprecated}
25
+ </Callout>
26
+ )}
27
+
28
+ {ChainOfThoughtPrimitiveDocs.Root?.description}
29
+
30
+ {ChainOfThoughtPrimitiveDocs.Root?.element && (
31
+ <p>This primitive renders a <code>{`<${ChainOfThoughtPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
32
+ )}
33
+
34
+ <ParametersTable {...ChainOfThoughtPrimitiveRootProps} />
35
+
36
+ ### AccordionTrigger
37
+
38
+ {ChainOfThoughtPrimitiveDocs.AccordionTrigger?.deprecated && (
39
+ <Callout type="warn">
40
+ <strong>Deprecated.</strong> {ChainOfThoughtPrimitiveDocs.AccordionTrigger.deprecated}
41
+ </Callout>
42
+ )}
43
+
44
+ {ChainOfThoughtPrimitiveDocs.AccordionTrigger?.description}
45
+
46
+ {ChainOfThoughtPrimitiveDocs.AccordionTrigger?.element && (
47
+ <p>This primitive renders a <code>{`<${ChainOfThoughtPrimitiveDocs.AccordionTrigger?.element}>`}</code> element unless <code>asChild</code> is set.</p>
48
+ )}
49
+
50
+ <ParametersTable {...ChainOfThoughtPrimitiveAccordionTriggerProps} />
51
+
52
+ ### Parts
53
+
54
+ {ChainOfThoughtPrimitiveDocs.Parts?.deprecated && (
55
+ <Callout type="warn">
56
+ <strong>Deprecated.</strong> {ChainOfThoughtPrimitiveDocs.Parts.deprecated}
57
+ </Callout>
58
+ )}
59
+
60
+ {ChainOfThoughtPrimitiveDocs.Parts?.description}
61
+
62
+ {ChainOfThoughtPrimitiveDocs.Parts?.element && (
63
+ <p>This primitive renders a <code>{`<${ChainOfThoughtPrimitiveDocs.Parts?.element}>`}</code> element unless <code>asChild</code> is set.</p>
64
+ )}
65
+
66
+ <ParametersTable {...ChainOfThoughtPrimitivePartsProps} />
67
+ {/* api-reference:end */}