Documents
message
message
Type
External
Status
Published
Created
Mar 17, 2026
Updated
May 19, 2026
Updated by
Dosu Bot
Source
View

import { MessagePrimitiveAttachmentByIndexProps, MessagePrimitiveAttachmentsProps, MessagePrimitiveContentProps, MessagePrimitiveGroupedPartsProps, MessagePrimitiveIfProps, MessagePrimitivePartByIndexProps, MessagePrimitivePartsProps, MessagePrimitiveQuoteProps, MessagePrimitiveRootProps, MessagePrimitiveUnstable_PartsGroupedByParentIdProps, MessagePrimitiveUnstable_PartsGroupedProps } from "@/generated/typeDocs";
import { MessagePrimitive as MessagePrimitiveDocs } from "@/generated/primitiveDocs";

{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts /}
{/
Do not edit manually. */}

For examples and usage patterns, see Message.

{/* api-manual */}

Anatomy#

import { MessagePrimitive } from "@assistant-ui/react";

const UserMessage = () => (
  <MessagePrimitive.Root>
    User: <MessagePrimitive.Parts />
    <BranchPicker />
    <ActionBar />
  </MessagePrimitive.Root>
);

const AssistantMessage = () => (
  <MessagePrimitive.Root>
    Assistant: <MessagePrimitive.Parts />
    <BranchPicker />
    <ActionBar />
  </MessagePrimitive.Root>
);

{/* api-manual */}

{/* api-reference /}
{/
AUTO-GENERATED by scripts/generate-api-reference.mts /}
{/
Do not edit this block manually. */}

API Reference#

Root#

{MessagePrimitiveDocs.Root?.deprecated && (

Deprecated. {MessagePrimitiveDocs.Root.deprecated}

)}

{MessagePrimitiveDocs.Root?.description}

{MessagePrimitiveDocs.Root?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.Root?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitiveRootProps} />

Parts#

{MessagePrimitiveDocs.Parts?.deprecated && (

Deprecated. {MessagePrimitiveDocs.Parts.deprecated}

)}

{MessagePrimitiveDocs.Parts?.description}

{MessagePrimitiveDocs.Parts?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.Parts?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitivePartsProps} />

PartByIndex#

{MessagePrimitiveDocs.PartByIndex?.deprecated && (

Deprecated. {MessagePrimitiveDocs.PartByIndex.deprecated}

)}

{MessagePrimitiveDocs.PartByIndex?.description}

{MessagePrimitiveDocs.PartByIndex?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.PartByIndex?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitivePartByIndexProps} />

Content#

{MessagePrimitiveDocs.Content?.deprecated && (

Deprecated. {MessagePrimitiveDocs.Content.deprecated}

)}

{MessagePrimitiveDocs.Content?.description}

{MessagePrimitiveDocs.Content?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.Content?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitiveContentProps} />

If#

{MessagePrimitiveDocs.If?.deprecated && (

Deprecated. {MessagePrimitiveDocs.If.deprecated}

)}

{MessagePrimitiveDocs.If?.description}

{MessagePrimitiveDocs.If?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.If?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitiveIfProps} />

Attachments#

{MessagePrimitiveDocs.Attachments?.deprecated && (

Deprecated. {MessagePrimitiveDocs.Attachments.deprecated}

)}

{MessagePrimitiveDocs.Attachments?.description}

{MessagePrimitiveDocs.Attachments?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.Attachments?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitiveAttachmentsProps} />

AttachmentByIndex#

{MessagePrimitiveDocs.AttachmentByIndex?.deprecated && (

Deprecated. {MessagePrimitiveDocs.AttachmentByIndex.deprecated}

)}

{MessagePrimitiveDocs.AttachmentByIndex?.description}

{MessagePrimitiveDocs.AttachmentByIndex?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.AttachmentByIndex?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitiveAttachmentByIndexProps} />

Quote#

{MessagePrimitiveDocs.Quote?.deprecated && (

Deprecated. {MessagePrimitiveDocs.Quote.deprecated}

)}

{MessagePrimitiveDocs.Quote?.description}

{MessagePrimitiveDocs.Quote?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.Quote?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitiveQuoteProps} />

Error#

{MessagePrimitiveDocs.Error?.deprecated && (

Deprecated. {MessagePrimitiveDocs.Error.deprecated}

)}

{MessagePrimitiveDocs.Error?.description}

{MessagePrimitiveDocs.Error?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.Error?.element}>`} element unless asChild is set.

)}

{MessagePrimitiveDocs.Error?.props && (

)}

GroupedParts#

{MessagePrimitiveDocs.GroupedParts?.deprecated && (

Deprecated. {MessagePrimitiveDocs.GroupedParts.deprecated}

)}

{MessagePrimitiveDocs.GroupedParts?.description}

{MessagePrimitiveDocs.GroupedParts?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.GroupedParts?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitiveGroupedPartsProps} />

Unstable_PartsGrouped#

{MessagePrimitiveDocs.Unstable_PartsGrouped?.deprecated && (

Deprecated. {MessagePrimitiveDocs.Unstable_PartsGrouped.deprecated}

)}

{MessagePrimitiveDocs.Unstable_PartsGrouped?.description}

{MessagePrimitiveDocs.Unstable_PartsGrouped?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.Unstable_PartsGrouped?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitiveUnstable_PartsGroupedProps} />

Unstable_PartsGroupedByParentId#

{MessagePrimitiveDocs.Unstable_PartsGroupedByParentId?.deprecated && (

Deprecated. {MessagePrimitiveDocs.Unstable_PartsGroupedByParentId.deprecated}

)}

{MessagePrimitiveDocs.Unstable_PartsGroupedByParentId?.description}

{MessagePrimitiveDocs.Unstable_PartsGroupedByParentId?.element && (

This primitive renders a {`<${MessagePrimitiveDocs.Unstable_PartsGroupedByParentId?.element}>`} element unless asChild is set.

)}

<ParametersTable {...MessagePrimitiveUnstable_PartsGroupedByParentIdProps} />
{/* api-reference */}