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

import { AssistantModalPrimitiveAnchorProps, AssistantModalPrimitiveContentProps, AssistantModalPrimitiveRootProps, AssistantModalPrimitiveTriggerProps } from "@/generated/typeDocs";
import { AssistantModalPrimitive as AssistantModalPrimitiveDocs } from "@/generated/primitiveDocs";

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

For examples and usage patterns, see AssistantModal.

{/* api-manual */}

Anatomy#

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

const AssistantModal = () => (
  <AssistantModalPrimitive.Root>
    <AssistantModalPrimitive.Trigger>
      <FloatingAssistantButton />
    </AssistantModalPrimitive.Trigger>
    <AssistantModalPrimitive.Content>
      <Thread />
    </AssistantModalPrimitive.Content>
  </AssistantModalPrimitive.Root>
);

{/* api-manual */}

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

API Reference#

Root#

{AssistantModalPrimitiveDocs.Root?.deprecated && (

Deprecated. {AssistantModalPrimitiveDocs.Root.deprecated}

)}

{AssistantModalPrimitiveDocs.Root?.description}

{AssistantModalPrimitiveDocs.Root?.element && (

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

)}

<ParametersTable {...AssistantModalPrimitiveRootProps} />

Trigger#

{AssistantModalPrimitiveDocs.Trigger?.deprecated && (

Deprecated. {AssistantModalPrimitiveDocs.Trigger.deprecated}

)}

{AssistantModalPrimitiveDocs.Trigger?.description}

{AssistantModalPrimitiveDocs.Trigger?.element && (

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

)}

<ParametersTable {...AssistantModalPrimitiveTriggerProps} />

{/* api-manual.Trigger */}

Data attributeValues
[data-state]"open" | "closed"
{/* api-manual.Trigger */}

Content#

{AssistantModalPrimitiveDocs.Content?.deprecated && (

Deprecated. {AssistantModalPrimitiveDocs.Content.deprecated}

)}

{AssistantModalPrimitiveDocs.Content?.description}

{AssistantModalPrimitiveDocs.Content?.element && (

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

)}

<ParametersTable {...AssistantModalPrimitiveContentProps} />

Anchor#

{AssistantModalPrimitiveDocs.Anchor?.deprecated && (

Deprecated. {AssistantModalPrimitiveDocs.Anchor.deprecated}

)}

{AssistantModalPrimitiveDocs.Anchor?.description}

{AssistantModalPrimitiveDocs.Anchor?.element && (

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

)}

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

assistant-modal | Dosu