grassroot
Install

DocsAPI referenceHeadlessassistant-attachment

assistant-attachment headless API

The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.

@grassroot/ui-headless-core/assistant-attachment

Core connector and vanilla API

6 exports
View source packages/ui-headless/core/src/assistant-attachment/index.ts

assistantAttachmentAnatomy

value
DeclarationView source
assistantAttachmentAnatomyts
export declare const assistantAttachmentAnatomy: {
  readonly scope: "assistant-attachment";
  readonly parts: readonly ["root", "thumb", "name", "remove"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "thumb", "name", "remove"]
required
scope
property
"assistant-attachment"
required
Name
parts
Kind
property
Type
readonly ["root", "thumb", "name", "remove"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-attachment"
Requirement
required

AssistantAttachmentApi

interface
DeclarationView source
AssistantAttachmentApits
interface AssistantAttachmentApi {
  rootProps(): PartProps;
  thumbProps(): PartProps;
  nameProps(): PartProps;
  removeProps(): PartProps;
}
Name
Kind
Type
Requirement
nameProps
method
() => PartProps
required
removeProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
thumbProps
method
() => PartProps
required
Name
nameProps
Kind
method
Type
() => PartProps
Requirement
required
Name
removeProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
thumbProps
Kind
method
Type
() => PartProps
Requirement
required

AssistantAttachmentConnectOptions

interface
DeclarationView source
AssistantAttachmentConnectOptionsts
interface AssistantAttachmentConnectOptions {
  readonly attachment: AssistantAttachmentLike;
  readonly inMessage?: boolean;
  readonly onRemove?: () => void;
}
Name
Kind
Type
Requirement
attachment
property
AssistantAttachmentLike
required
inMessage
property
boolean
optional
onRemove
property
() => void
optional
Name
attachment
Kind
property
Type
AssistantAttachmentLike
Requirement
required
Name
inMessage
Kind
property
Type
boolean
Requirement
optional
Name
onRemove
Kind
property
Type
() => void
Requirement
optional

AssistantAttachmentLike

interface
DeclarationView source
AssistantAttachmentLikets
interface AssistantAttachmentLike {
  readonly id: string;
  readonly type?: string;
  readonly name: string;
  readonly contentType?: string;
  readonly status?: {
    readonly type?: string;
    readonly reason?: string;
    readonly progress?: number;
  };
  readonly content?: readonly unknown[];
  readonly file?: unknown;
}
Name
Kind
Type
Requirement
content
property
readonly unknown[]
optional
contentType
property
string
optional
file
property
unknown
optional
id
property
string
required
name
property
string
required
status
property
{ readonly type?: string; readonly reason?: string; readonly progress?: number; }
optional
type
property
string
optional
Name
content
Kind
property
Type
readonly unknown[]
Requirement
optional
Name
contentType
Kind
property
Type
string
Requirement
optional
Name
file
Kind
property
Type
unknown
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required
Name
name
Kind
property
Type
string
Requirement
required
Name
status
Kind
property
Type
{ readonly type?: string; readonly reason?: string; readonly progress?: number; }
Requirement
optional
Name
type
Kind
property
Type
string
Requirement
optional

AssistantAttachmentPart

type
DeclarationView source
AssistantAttachmentPartts
type AssistantAttachmentPart = (typeof parts)[number];

connectAssistantAttachment

function
DeclarationView source
connectAssistantAttachmentts
declare function connectAssistantAttachment(scope: PartScope, options: AssistantAttachmentConnectOptions): AssistantAttachmentApi;
Name
Kind
Type
Requirement
scope
parameter
PartScope
required
options
parameter
AssistantAttachmentConnectOptions
required
return
return value
AssistantAttachmentApi
n/a
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantAttachmentConnectOptions
Requirement
required
Name
return
Kind
return value
Type
AssistantAttachmentApi
Requirement
n/a

Framework adapters

Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.

This entry is core-only. No framework adapter package ships for assistant-attachment yet — mount it through the vanilla API above.