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

package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx

@@ -1,11 +1,17 @@
 ---
 title: ActionBarPrimitive
-description: Buttons for message actions like copy, edit, reload, speak, and feedback.
+description: Composable message action controls for copy, edit, reload, speech, and feedback in assistant-ui chat interfaces.
 ---
 
-Buttons to interact with the message.
+import { ActionBarPrimitiveCopyProps, ActionBarPrimitiveEditProps, ActionBarPrimitiveExportMarkdownProps, ActionBarPrimitiveFeedbackNegativeProps, ActionBarPrimitiveFeedbackPositiveProps, ActionBarPrimitiveReloadProps, ActionBarPrimitiveRootProps, ActionBarPrimitiveSpeakProps, ActionBarPrimitiveStopSpeakingProps } from "@/generated/typeDocs";
+import { ActionBarPrimitive as ActionBarPrimitiveDocs } from "@/generated/primitiveDocs";
 
+{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts */}
+{/* Do not edit manually. */}
 
+For examples and usage patterns, see [ActionBar](/docs/primitives/action-bar).
+
+{/* api-manual:start */}
 ## Anatomy
 
 ```tsx
@@ -25,300 +31,179 @@ const AssistantMessageBar = () => (
   </ActionBarPrimitive.Root>
 );
 ```
+{/* api-manual:end */}
+
+{/* api-reference:start */}
+{/* AUTO-GENERATED by scripts/generate-api-reference.mts */}
+{/* Do not edit this block manually. */}
 
 ## API Reference
 
 ### Root
 
-Contains all parts of the action bar.
-
-This primitive renders a `<div>` element unless `asChild` is set.
-
-<ParametersTable
-  type="ActionBarPrimitiveRootProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-    {
-      name: "hideWhenRunning",
-      type: "boolean",
-      default: "false",
-      description: (
-        <span>
-          Do not render the ActionBar when the thread is in running state.
-        </span>
-      ),
-    },
-    {
-      name: "autohide",
-      type: '"always" | "not-last" | "never"',
-      default: '"never"',
-      description: (
-        <span>
-          Do not render the ActionBar unless the mouse is hovering over the
-          message.
-          <br />
-          <br />
-          <Code>"always"</Code>: always autohide.
-          <br />
-          <Code>"not-last"</Code>: only autohide if the message is not the last
-          one in the thread.
-        </span>
-      ),
-    },
-    {
-      name: "autohideFloat",
-      type: '"always" | "single-branch" | "never"',
-      default: '"never"',
-      description: (
-        <span>
-          Float the ActionBar during autohide.
-          <br />
-          <br />
-          <Code>"always"</Code>: always float during autohide.
-          <br />
-          <Code>"single-branch"</Code>: only float if the message is the only
-          one in the thread.
-          <br />
-          <br />
-          Note: this only sets `data-floating` on the ActionBar. You need to set
-          the appropriate styles on the ActionBar to make it float.
-        </span>
-      ),
-    },
-  ]}
-/>
+{ActionBarPrimitiveDocs.Root?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ActionBarPrimitiveDocs.Root.deprecated}
+  </Callout>
+)}
+
+{ActionBarPrimitiveDocs.Root?.description}
+
+{ActionBarPrimitiveDocs.Root?.element && (
+  <p>This primitive renders a <code>{`<${ActionBarPrimitiveDocs.Root?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
+
+<ParametersTable {...ActionBarPrimitiveRootProps} />
 
+{/* api-manual:ActionBarPrimitive.Root:start */}
 | Data attribute | Values |
 | --- | --- |
 | `[data-floating]` | Present when floating |
+{/* api-manual:ActionBarPrimitive.Root:end */}
 
-### Edit
+### Copy
 
-Enables edit mode on user message.
+{ActionBarPrimitiveDocs.Copy?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ActionBarPrimitiveDocs.Copy.deprecated}
+  </Callout>
+)}
 
-This primitive renders a `<button>` element unless `asChild` is set.
+{ActionBarPrimitiveDocs.Copy?.description}
 
-<ParametersTable
-  type="ActionBarPrimitiveEditProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-  ]}
-/>
+{ActionBarPrimitiveDocs.Copy?.element && (
+  <p>This primitive renders a <code>{`<${ActionBarPrimitiveDocs.Copy?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-### Reload
+<ParametersTable {...ActionBarPrimitiveCopyProps} />
 
-Regenerates the assistant message.
+{/* api-manual:ActionBarPrimitive.Copy:start */}
+| Data attribute | Values |
+| --- | --- |
+| `[data-copied]` | Present when the message was recently copied. |
+{/* api-manual:ActionBarPrimitive.Copy:end */}
 
-This primitive renders a `<button>` element unless `asChild` is set.
+### Reload
 
-<ParametersTable
-  type="ActionBarPrimitiveReloadProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-  ]}
-/>
+{ActionBarPrimitiveDocs.Reload?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ActionBarPrimitiveDocs.Reload.deprecated}
+  </Callout>
+)}
 
-### Copy
+{ActionBarPrimitiveDocs.Reload?.description}
 
-Copies the message to the clipboard.
-
-This primitive renders a `<button>` element unless `asChild` is set.
-
-<ParametersTable
-  type="ActionBarPrimitiveCopyProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-    {
-      name: "copiedDuration",
-      type: "number",
-      description:
-        "The duration in milliseconds to change the message status to 'copied'.",
-      default: "3000",
-    },
-  ]}
-/>
+{ActionBarPrimitiveDocs.Reload?.element && (
+  <p>This primitive renders a <code>{`<${ActionBarPrimitiveDocs.Reload?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-| Data attribute | Values |
-| --- | --- |
-| `[data-copied]` | Present when the message was recently copied. |
+<ParametersTable {...ActionBarPrimitiveReloadProps} />
 
-#### Copied state
+### Edit
 
-Show a different icon for a few seconds after the message is copied.
+{ActionBarPrimitiveDocs.Edit?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ActionBarPrimitiveDocs.Edit.deprecated}
+  </Callout>
+)}
 
-```tsx
-<ActionBarPrimitive.Copy>
-  <AuiIf condition={(s) => !s.message.isCopied}>
-    <CopyIcon />
-  </AuiIf>
-  <AuiIf condition={(s) => s.message.isCopied}>
-    <CopySuccessIcon />
-  </AuiIf>
-</ActionBarPrimitive.Copy>
-```
+{ActionBarPrimitiveDocs.Edit?.description}
 
-or using the `data-copied` attribute:
+{ActionBarPrimitiveDocs.Edit?.element && (
+  <p>This primitive renders a <code>{`<${ActionBarPrimitiveDocs.Edit?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-```tsx
-<ActionBarPrimitive.Copy className="group">
-  <CopyIcon className="group-data-[copied]:hidden" />
-  <CheckIcon className="hidden group-data-[copied]:block" />
-</ActionBarPrimitive.Copy>
-```
+<ParametersTable {...ActionBarPrimitiveEditProps} />
 
 ### Speak
 
-Plays the message text as speech.
+{ActionBarPrimitiveDocs.Speak?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ActionBarPrimitiveDocs.Speak.deprecated}
+  </Callout>
+)}
+
+{ActionBarPrimitiveDocs.Speak?.description}
 
-This primitive renders a `<button>` element unless `asChild` is set.
+{ActionBarPrimitiveDocs.Speak?.element && (
+  <p>This primitive renders a <code>{`<${ActionBarPrimitiveDocs.Speak?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-<ParametersTable
-  type="ActionBarPrimitiveSpeakProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-  ]}
-/>
+<ParametersTable {...ActionBarPrimitiveSpeakProps} />
 
 ### StopSpeaking
 
-Stops the message text from being played as speech.
+{ActionBarPrimitiveDocs.StopSpeaking?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ActionBarPrimitiveDocs.StopSpeaking.deprecated}
+  </Callout>
+)}
+
+{ActionBarPrimitiveDocs.StopSpeaking?.description}
+
+{ActionBarPrimitiveDocs.StopSpeaking?.element && (
+  <p>This primitive renders a <code>{`<${ActionBarPrimitiveDocs.StopSpeaking?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-This primitive renders a `<button>` element unless `asChild` is set.
+<ParametersTable {...ActionBarPrimitiveStopSpeakingProps} />
 
-<ParametersTable
-  type="ActionBarPrimitiveStopSpeakingProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-  ]}
-/>
+### FeedbackPositive
 
-### Feedback Positive
+{ActionBarPrimitiveDocs.FeedbackPositive?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ActionBarPrimitiveDocs.FeedbackPositive.deprecated}
+  </Callout>
+)}
 
-Shows a positive feedback submission button.
+{ActionBarPrimitiveDocs.FeedbackPositive?.description}
 
-This primitive renders a `<button>` element unless `asChild` is set.
+{ActionBarPrimitiveDocs.FeedbackPositive?.element && (
+  <p>This primitive renders a <code>{`<${ActionBarPrimitiveDocs.FeedbackPositive?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-<ParametersTable
-  type="ActionBarPrimitiveFeedbackPositiveProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-  ]}
-/>
+<ParametersTable {...ActionBarPrimitiveFeedbackPositiveProps} />
 
+{/* api-manual:ActionBarPrimitive.FeedbackPositive:start */}
 | Data attribute | Values |
 | --- | --- |
 | `[data-submitted]` | Present when positive feedback was submitted. |
+{/* api-manual:ActionBarPrimitive.FeedbackPositive:end */}
 
-### Feedback Negative
+### FeedbackNegative
 
-Shows a negative feedback submission button.
+{ActionBarPrimitiveDocs.FeedbackNegative?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ActionBarPrimitiveDocs.FeedbackNegative.deprecated}
+  </Callout>
+)}
 
-This primitive renders a `<button>` element unless `asChild` is set.
+{ActionBarPrimitiveDocs.FeedbackNegative?.description}
 
-<ParametersTable
-  type="ActionBarPrimitiveFeedbackNegativeProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-  ]}
-/>
+{ActionBarPrimitiveDocs.FeedbackNegative?.element && (
+  <p>This primitive renders a <code>{`<${ActionBarPrimitiveDocs.FeedbackNegative?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
+<ParametersTable {...ActionBarPrimitiveFeedbackNegativeProps} />
+
+{/* api-manual:ActionBarPrimitive.FeedbackNegative:start */}
 | Data attribute | Values |
 | --- | --- |
 | `[data-submitted]` | Present when negative feedback was submitted. |
+{/* api-manual:ActionBarPrimitive.FeedbackNegative:end */}
 
 ### ExportMarkdown
 
-Exports the message content as a Markdown file download by default, or calls a custom export handler when `onExport` is provided.
-
-This primitive renders a `<button>` element unless `asChild` is set.
-
-<ParametersTable
-  type="ActionBarPrimitiveExportMarkdownProps"
-  parameters={[
-    {
-      name: "asChild",
-    },
-    {
-      name: "filename",
-      type: "string",
-      description:
-        "The filename for the downloaded Markdown file. Defaults to 'message-{timestamp}.md'. Ignored when onExport is provided.",
-    },
-    {
-      name: "onExport",
-      type: "(content: string) => void | Promise<void>",
-      description:
-        "Optional callback function that receives the message content. When provided, overrides the default Markdown download behavior. Use this to implement custom export logic (PDF, JSON, TXT, etc.).",
-    },
-  ]}
-/>
-
-#### Examples
-
-Default Markdown export:
-
-```tsx
-<ActionBarPrimitive.ExportMarkdown>
-  <DownloadIcon />
-  Export as Markdown
-</ActionBarPrimitive.ExportMarkdown>
-```
-
-With custom filename:
+{ActionBarPrimitiveDocs.ExportMarkdown?.deprecated && (
+  <Callout type="warn">
+    <strong>Deprecated.</strong> {ActionBarPrimitiveDocs.ExportMarkdown.deprecated}
+  </Callout>
+)}
 
-```tsx
-<ActionBarPrimitive.ExportMarkdown filename="chat-response.md">
-  <DownloadIcon />
-  Download
-</ActionBarPrimitive.ExportMarkdown>
-```
+{ActionBarPrimitiveDocs.ExportMarkdown?.description}
 
-Export as PDF (with custom logic):
+{ActionBarPrimitiveDocs.ExportMarkdown?.element && (
+  <p>This primitive renders a <code>{`<${ActionBarPrimitiveDocs.ExportMarkdown?.element}>`}</code> element unless <code>asChild</code> is set.</p>
+)}
 
-```tsx
-<ActionBarPrimitive.ExportMarkdown
-  onExport={async (content) => {
-    const pdf = await generatePdf(content);
-    downloadFile(pdf, "message.pdf");
-  }}
->
-  <FileIcon />
-  Export PDF
-</ActionBarPrimitive.ExportMarkdown>
-```
-
-Export as JSON:
-
-```tsx
-<ActionBarPrimitive.ExportMarkdown
-  onExport={(content) => {
-    const json = JSON.stringify({ content, timestamp: Date.now() });
-    const blob = new Blob([json], { type: "application/json" });
-    const url = URL.createObjectURL(blob);
-    const a = document.createElement("a");
-    a.href = url;
-    a.download = "message.json";
-    a.click();
-    URL.revokeObjectURL(url);
-  }}
->
-  <CodeIcon />
-  Export JSON
-</ActionBarPrimitive.ExportMarkdown>
-```
+<ParametersTable {...ActionBarPrimitiveExportMarkdownProps} />
+{/* api-reference:end */}

package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx

@@ -1,10 +1,11 @@
 ---
 title: AuiIf
-description: Conditional rendering component based on thread, message, or composer state.
+description: Conditional rendering primitive for showing React UI from assistant-ui thread, message, composer, and runtime state.
 ---
 
-Conditionally render children based on assistant state.
+{/* api-reference:skip-auto-generation */}
 
+{/* api-manual:start */}
 
 ## Anatomy
 
@@ -13,7 +14,7 @@ import { AuiIf } from "@assistant-ui/react";
 
 <AuiIf condition={(s) => s.thread.isEmpty}>
   <WelcomeScreen />
-</AuiIf>
+</AuiIf>;
 ```
 
 ## Overview
@@ -29,7 +30,8 @@ import { AuiIf } from "@assistant-ui/react";
       name: "condition",
       type: "(state: AssistantState) => boolean",
       required: true,
-      description: "A function that receives the assistant state and returns whether to render children.",
+      description:
+        "A function that receives the assistant state and returns whether to render children.",
     },
     {
       name: "children",
@@ -54,7 +56,8 @@ The condition function receives an `AssistantState` object with the following pr
     {
       name: "message",
       type: "MessageState",
-      description: "The current message state (available within a message context).",
+      description:
+        "The current message state (available within a message context).",
     },
     {
       name: "composer",
@@ -64,12 +67,14 @@ The condition function receives an `AssistantState` object with the following pr
     {
       name: "part",
       type: "PartState",
-      description: "The current message part state (available within a part context).",
+      description:
+        "The current message part state (available within a part context).",
     },
     {
       name: "attachment",
       type: "AttachmentState",
-      description: "The current attachment state (available within an attachment context).",
+      description:
+        "The current attachment state (available within an attachment context).",
     },
   ]}
 />
@@ -184,23 +189,37 @@ const isThreadEmpty: AuiIf.Condition = (s) => s.thread.isEmpty;
 
 <AuiIf condition={isThreadEmpty}>
   <WelcomeScreen />
-</AuiIf>
+</AuiIf>;
 ```
 
 ## Migration from Deprecated Components
 
 <Callout type="warn">
-`ThreadPrimitive.If`, `MessagePrimitive.If`, and `ComposerPrimitive.If` are deprecated. Use `AuiIf` instead.
+  `ThreadPrimitive.If`, `MessagePrimitive.If`, and `ComposerPrimitive.If` are
+  deprecated. Use `AuiIf` instead.
+</Callout>
+
+| Before                                 | After                                                       |
+| -------------------------------------- | ----------------------------------------------------------- |
+| `<ThreadPrimitive.If empty>`           | `<AuiIf condition={(s) => s.thread.isEmpty}>`               |
+| `<ThreadPrimitive.If running>`         | `<AuiIf condition={(s) => s.thread.isRunning}>`             |
+| `<ThreadPrimitive.If running={false}>` | `<AuiIf condition={(s) => !s.thread.isRunning}>`            |
+| `<MessagePrimitive.If user>`           | `<AuiIf condition={(s) => s.message.role === "user"}>`      |
+| `<MessagePrimitive.If assistant>`      | `<AuiIf condition={(s) => s.message.role === "assistant"}>` |
+| `<MessagePrimitive.If copied>`         | `<AuiIf condition={(s) => s.message.isCopied}>`             |
+| `<MessagePrimitive.If speaking>`       | `<AuiIf condition={(s) => s.message.speech != null}>`       |
+| `<MessagePrimitive.If last>`           | `<AuiIf condition={(s) => s.message.isLast}>`               |
+| `<ComposerPrimitive.If editing>`       | `<AuiIf condition={(s) => s.composer.isEditing}>`           |
+
+## AssistantIf
+
+<Callout type="warn">
+  <strong>Deprecated:</strong> Use `AuiIf` instead. This alias was removed in
+  v0.13.
 </Callout>
 
-| Before | After |
-|--------|-------|
-| `<ThreadPrimitive.If empty>` | `<AuiIf condition={(s) => s.thread.isEmpty}>` |
-| `<ThreadPrimitive.If running>` | `<AuiIf condition={(s) => s.thread.isRunning}>` |
-| `<ThreadPrimitive.If running={false}>` | `<AuiIf condition={(s) => !s.thread.isRunning}>` |
-| `<MessagePrimitive.If user>` | `<AuiIf condition={(s) => s.message.role === "user"}>` |
-| `<MessagePrimitive.If assistant>` | `<AuiIf condition={(s) => s.message.role === "assistant"}>` |
-| `<MessagePrimitive.If copied>` | `<AuiIf condition={(s) => s.message.isCopied}>` |
-| `<MessagePrimitive.If speaking>` | `<AuiIf condition={(s) => s.message.speech != null}>` |
-| `<MessagePrimitive.If last>` | `<AuiIf condition={(s) => s.message.isLast}>` |
-| `<ComposerPrimitive.If editing>` | `<AuiIf condition={(s) => s.composer.isEditing}>` |
+```tsx
+import { AssistantIf } from "@assistant-ui/react";
+```
+
+{/* api-manual:end */}