DocsAPI referenceHeadlessCore

Headless core

The framework-neutral contract shared by every connector, vanilla mount and adapter. Component-specific core APIs live on their matching component page.

@grassroot/ui-headless-core

Root utilities

408 exports
View source packages/ui-headless/core/src/index.ts

Shared types and utilities

DeclarationView source
ActionBarAutohidets
type ActionBarAutohide = "always" | "not-last" | "never";
DeclarationView source
ActionBarFeedbackts
type ActionBarFeedback = "positive" | "negative";

applyTransaction

function
DeclarationView source
applyTransactionts
declare function applyTransaction<T>(cache: GridRowProjectionCache<T>, transaction: {
readonly add?: readonly {
readonly row: T;
readonly index?: number;
}[];
readonly update?: readonly T[];
readonly remove?: readonly string[];
}, model: GridRowProjectionModel<T>): GridRowProjection<T>;
Name
Kind
Type
Requirement
cache
parameter
GridRowProjectionCache<T>
required
transaction
parameter
{ readonly add?: readonly { readonly row: T; readonly index?: number; }[]; readonly update?: readonly T[]; readonly remove?: readonly string[]; }
required
model
parameter
GridRowProjectionModel<T>
required
return
return value
GridRowProjection<T>
n/a
Name
cache
Kind
parameter
Type
GridRowProjectionCache<T>
Requirement
required
Name
transaction
Kind
parameter
Type
{ readonly add?: readonly { readonly row: T; readonly index?: number; }[]; readonly update?: readonly T[]; readonly remove?: readonly string[]; }
Requirement
required
Name
model
Kind
parameter
Type
GridRowProjectionModel<T>
Requirement
required
Name
return
Kind
return value
Type
GridRowProjection<T>
Requirement
n/a
DeclarationView source
assistantActionBarAnatomyts
export declare const assistantActionBarAnatomy: {
readonly scope: "assistant-action-bar";
readonly parts: readonly ["root", "copy", "reload", "edit", "speak", "stop-speaking", "feedback-positive", "feedback-negative", "export-markdown"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "copy", "reload", "edit", "speak", "stop-speaking", "feedback-positive", "feedback-negative", "export-markdown"]
required
scope
property
"assistant-action-bar"
required
Name
parts
Kind
property
Type
readonly ["root", "copy", "reload", "edit", "speak", "stop-speaking", "feedback-positive", "feedback-negative", "export-markdown"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-action-bar"
Requirement
required
DeclarationView source
AssistantActionBarApits
interface AssistantActionBarApi {
rootProps(): PartProps;
copyProps(): PartProps;
reloadProps(): PartProps;
editProps(): PartProps;
speakProps(): PartProps;
stopSpeakingProps(): PartProps;
feedbackPositiveProps(): PartProps;
feedbackNegativeProps(): PartProps;
exportMarkdownProps(): PartProps;
getVersion(): number;
subscribe(listener: () => void): () => void;
destroy(): void;
}
Name
Kind
Type
Requirement
copyProps
method
() => PartProps
required
destroy
method
() => void
required
editProps
method
() => PartProps
required
exportMarkdownProps
method
() => PartProps
required
feedbackNegativeProps
method
() => PartProps
required
feedbackPositiveProps
method
() => PartProps
required
getVersion
method
() => number
required
reloadProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
speakProps
method
() => PartProps
required
stopSpeakingProps
method
() => PartProps
required
subscribe
method
(listener: () => void) => () => void
required
Name
copyProps
Kind
method
Type
() => PartProps
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
editProps
Kind
method
Type
() => PartProps
Requirement
required
Name
exportMarkdownProps
Kind
method
Type
() => PartProps
Requirement
required
Name
feedbackNegativeProps
Kind
method
Type
() => PartProps
Requirement
required
Name
feedbackPositiveProps
Kind
method
Type
() => PartProps
Requirement
required
Name
getVersion
Kind
method
Type
() => number
Requirement
required
Name
reloadProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
speakProps
Kind
method
Type
() => PartProps
Requirement
required
Name
stopSpeakingProps
Kind
method
Type
() => PartProps
Requirement
required
Name
subscribe
Kind
method
Type
(listener: () => void) => () => void
Requirement
required
DeclarationView source
AssistantActionBarClientLikets
interface AssistantActionBarClientLike {
readonly thread?: {
readonly getState: () => Record<string, unknown>;
};
readonly message?: {
readonly getState: () => Record<string, unknown>;
};
readonly capabilities?: Record<string, boolean>;
}
Name
Kind
Type
Requirement
capabilities
property
Record<string, boolean>
optional
message
property
{ readonly getState: () => Record<string, unknown>; }
optional
thread
property
{ readonly getState: () => Record<string, unknown>; }
optional
Name
capabilities
Kind
property
Type
Record<string, boolean>
Requirement
optional
Name
message
Kind
property
Type
{ readonly getState: () => Record<string, unknown>; }
Requirement
optional
Name
thread
Kind
property
Type
{ readonly getState: () => Record<string, unknown>; }
Requirement
optional
DeclarationView source
AssistantActionBarConnectOptionsts
interface AssistantActionBarConnectOptions {
readonly messageId?: string;
readonly message?: ExportableMessage;
readonly copyText?: string;
readonly hideWhenRunning?: boolean;
readonly autohide?: ActionBarAutohide;
readonly autohideFloat?: boolean;
readonly isLast?: boolean;
readonly copiedDuration?: number;
readonly clipboard?: {
readonly writeText: (text: string) => void | Promise<void>;
};
readonly onFeedback?: (feedback: ActionBarFeedback) => void;
readonly onExport?: (markdown: string) => void;
readonly onReload?: () => void;
readonly onEdit?: () => void;
readonly onSpeak?: () => void;
readonly onStopSpeaking?: () => void;
}
Name
Kind
Type
Requirement
autohide
property
ActionBarAutohide
optional
autohideFloat
property
boolean
optional
clipboard
property
{ readonly writeText: (text: string) => void | Promise<void>; }
optional
copiedDuration
property
number
optional
copyText
property
string
optional
hideWhenRunning
property
boolean
optional
isLast
property
boolean
optional
message
property
ExportableMessage
optional
messageId
property
string
optional
onEdit
property
() => void
optional
onExport
property
(markdown: string) => void
optional
onFeedback
property
(feedback: ActionBarFeedback) => void
optional
onReload
property
() => void
optional
onSpeak
property
() => void
optional
Name
autohide
Kind
property
Type
ActionBarAutohide
Requirement
optional
Name
autohideFloat
Kind
property
Type
boolean
Requirement
optional
Name
clipboard
Kind
property
Type
{ readonly writeText: (text: string) => void | Promise<void>; }
Requirement
optional
Name
copiedDuration
Kind
property
Type
number
Requirement
optional
Name
copyText
Kind
property
Type
string
Requirement
optional
Name
hideWhenRunning
Kind
property
Type
boolean
Requirement
optional
Name
isLast
Kind
property
Type
boolean
Requirement
optional
Name
message
Kind
property
Type
ExportableMessage
Requirement
optional
Name
messageId
Kind
property
Type
string
Requirement
optional
Name
onEdit
Kind
property
Type
() => void
Requirement
optional
Name
onExport
Kind
property
Type
(markdown: string) => void
Requirement
optional
Name
onFeedback
Kind
property
Type
(feedback: ActionBarFeedback) => void
Requirement
optional
Name
onReload
Kind
property
Type
() => void
Requirement
optional
Name
onSpeak
Kind
property
Type
() => void
Requirement
optional
Name
onStopSpeaking
Kind
property
Type
() => void
Requirement
optional
DeclarationView source
AssistantActionBarMountts
interface AssistantActionBarMount {
readonly connector: AssistantActionBarApi;
readonly root: HTMLElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
AssistantActionBarApi
required
destroy
method
() => void
required
root
property
HTMLElement
required
Name
connector
Kind
property
Type
AssistantActionBarApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
DeclarationView source
AssistantActionBarPartts
type AssistantActionBarPart = (typeof parts)[number];
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
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
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
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
DeclarationView source
AssistantAttachmentPartts
type AssistantAttachmentPart = (typeof parts)[number];
DeclarationView source
assistantBranchPickerAnatomyts
export declare const assistantBranchPickerAnatomy: {
readonly scope: "assistant-branch-picker";
readonly parts: readonly ["root", "previous", "next", "number", "count"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "previous", "next", "number", "count"]
required
scope
property
"assistant-branch-picker"
required
Name
parts
Kind
property
Type
readonly ["root", "previous", "next", "number", "count"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-branch-picker"
Requirement
required
DeclarationView source
AssistantBranchPickerApits
interface AssistantBranchPickerApi {
rootProps(): PartProps;
previousProps(): PartProps;
nextProps(): PartProps;
numberProps(): PartProps;
countProps(): PartProps;
readonly canPrevious: boolean;
readonly canNext: boolean;
}
Name
Kind
Type
Requirement
canNext
property
boolean
required
canPrevious
property
boolean
required
countProps
method
() => PartProps
required
nextProps
method
() => PartProps
required
numberProps
method
() => PartProps
required
previousProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
Name
canNext
Kind
property
Type
boolean
Requirement
required
Name
canPrevious
Kind
property
Type
boolean
Requirement
required
Name
countProps
Kind
method
Type
() => PartProps
Requirement
required
Name
nextProps
Kind
method
Type
() => PartProps
Requirement
required
Name
numberProps
Kind
method
Type
() => PartProps
Requirement
required
Name
previousProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
AssistantBranchPickerConnectOptionsts
interface AssistantBranchPickerConnectOptions {
readonly branches: readonly string[];
readonly currentIndex: number;
readonly isRunning?: boolean;
readonly switchBranchDuringRun?: boolean;
readonly onSwitch?: (branchId: string) => void;
}
Name
Kind
Type
Requirement
branches
property
readonly string[]
required
currentIndex
property
number
required
isRunning
property
boolean
optional
onSwitch
property
(branchId: string) => void
optional
switchBranchDuringRun
property
boolean
optional
Name
branches
Kind
property
Type
readonly string[]
Requirement
required
Name
currentIndex
Kind
property
Type
number
Requirement
required
Name
isRunning
Kind
property
Type
boolean
Requirement
optional
Name
onSwitch
Kind
property
Type
(branchId: string) => void
Requirement
optional
Name
switchBranchDuringRun
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
AssistantBranchPickerPartts
type AssistantBranchPickerPart = (typeof assistantBranchPickerAnatomy.parts)[number];
DeclarationView source
assistantChainOfThoughtAnatomyts
export declare const assistantChainOfThoughtAnatomy: {
readonly scope: "assistant-chain-of-thought";
readonly parts: readonly ["root", "accordion-trigger", "parts"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "accordion-trigger", "parts"]
required
scope
property
"assistant-chain-of-thought"
required
Name
parts
Kind
property
Type
readonly ["root", "accordion-trigger", "parts"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-chain-of-thought"
Requirement
required
DeclarationView source
AssistantChainOfThoughtApits
interface AssistantChainOfThoughtApi {
rootProps(): PartProps;
triggerProps(): PartProps;
partsProps(): PartProps;
readonly open: boolean;
}
Name
Kind
Type
Requirement
open
property
boolean
required
partsProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
triggerProps
method
() => PartProps
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
partsProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
AssistantChainOfThoughtPartts
type AssistantChainOfThoughtPart = (typeof assistantChainOfThoughtAnatomy.parts)[number];
DeclarationView source
assistantComposerAnatomyts
export declare const assistantComposerAnatomy: {
readonly scope: "assistant-composer";
readonly parts: readonly ["root", "input", "send", "cancel", "add-attachment", "add-attachment-input", "attachments", "attachment", "attachment-dropzone", "dictate", "stop-dictation", "dictation-transcript", "quote", "quote-text", "quote-dismiss", "queue", "trigger-popover-root", "trigger-popover", "trigger-popover-categories", "trigger-popover-category-item", "trigger-popover-items", "trigger-popover-item", "trigger-popover-back"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "input", "send", "cancel", "add-attachment", "add-attachment-input", "attachments", "attachment", "attachment-dropzone", "dictate", "stop-dictation", "dictation-transcript", "quote", "quote-text", "quote-dismiss", "queue", "trigger-popover-root", "trigger-popover", "trigger-popover-categories", "trigger-popover-category-item", "trigger-popover-items", "trigger-popover-item", "trigger-popover-back"]
required
scope
property
"assistant-composer"
required
Name
parts
Kind
property
Type
readonly ["root", "input", "send", "cancel", "add-attachment", "add-attachment-input", "attachments", "attachment", "attachment-dropzone", "dictate", "stop-dictation", "dictation-transcript", "quote", "quote-text", "quote-dismiss", "queue", "trigger-popover-root", "trigger-popover", "trigger-popover-categories", "trigger-popover-category-item", "trigger-popover-items", "trigger-popover-item", "trigger-popover-back"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-composer"
Requirement
required
DeclarationView source
AssistantComposerApits
interface AssistantComposerApi {
rootProps(): PartProps;
inputProps(options?: AssistantComposerInputOptions): PartProps;
sendProps(): PartProps;
cancelProps(): PartProps;
addAttachmentProps(): PartProps;
addAttachmentInputProps(): PartProps;
attachmentsProps(): PartProps;
attachmentDropzoneProps(): PartProps;
dictateProps(): PartProps;
stopDictationProps(): PartProps;
dictationTranscriptProps(): PartProps;
quoteProps(): PartProps;
quoteTextProps(): PartProps;
quoteDismissProps(): PartProps;
queueProps(): PartProps;
triggerPopoverRootProps(): PartProps;
triggerPopoverProps(): PartProps;
triggerPopoverCategoriesProps(): PartProps;
triggerPopoverCategoryItemProps(category: string): PartProps;
triggerPopoverItemsProps(): PartProps;
triggerPopoverItemProps(item: TriggerPopoverItem): PartProps;
triggerPopoverBackProps(): PartProps;
selectTriggerPopover(item: TriggerPopoverItem): void;
selectTriggerPopoverCategory(category: string): boolean;
removeAttachment(id: string): void;
subscribe(listener: () => void): () => void;
readonly text: string;
readonly canSend: boolean;
readonly canCancel: boolean;
readonly isEditing: boolean;
readonly isSubmitting: boolean;
readonly canDictate: boolean;
readonly isDictating: boolean;
readonly canAttach: boolean;
readonly attachments: readonly AssistantComposerAttachmentLike[];
readonly queueItems: readonly unknown[];
readonly triggerPopoverOpen: boolean;
}
Name
Kind
Type
Requirement
addAttachmentInputProps
method
() => PartProps
required
addAttachmentProps
method
() => PartProps
required
attachmentDropzoneProps
method
() => PartProps
required
attachments
property
readonly AssistantComposerAttachmentLike[]
required
attachmentsProps
method
() => PartProps
required
canAttach
property
boolean
required
canCancel
property
boolean
required
cancelProps
method
() => PartProps
required
canDictate
property
boolean
required
canSend
property
boolean
required
dictateProps
method
() => PartProps
required
dictationTranscriptProps
method
() => PartProps
required
inputProps
method
(options?: AssistantComposerInputOptions) => PartProps
required
isDictating
property
boolean
required
Name
addAttachmentInputProps
Kind
method
Type
() => PartProps
Requirement
required
Name
addAttachmentProps
Kind
method
Type
() => PartProps
Requirement
required
Name
attachmentDropzoneProps
Kind
method
Type
() => PartProps
Requirement
required
Name
attachments
Kind
property
Type
readonly AssistantComposerAttachmentLike[]
Requirement
required
Name
attachmentsProps
Kind
method
Type
() => PartProps
Requirement
required
Name
canAttach
Kind
property
Type
boolean
Requirement
required
Name
canCancel
Kind
property
Type
boolean
Requirement
required
Name
cancelProps
Kind
method
Type
() => PartProps
Requirement
required
Name
canDictate
Kind
property
Type
boolean
Requirement
required
Name
canSend
Kind
property
Type
boolean
Requirement
required
Name
dictateProps
Kind
method
Type
() => PartProps
Requirement
required
Name
dictationTranscriptProps
Kind
method
Type
() => PartProps
Requirement
required
Name
inputProps
Kind
method
Type
(options?: AssistantComposerInputOptions) => PartProps
Requirement
required
Name
isDictating
Kind
property
Type
boolean
Requirement
required
Name
isEditing
Kind
property
Type
boolean
Requirement
required
Name
isSubmitting
Kind
property
Type
boolean
Requirement
required
Name
queueItems
Kind
property
Type
readonly unknown[]
Requirement
required
Name
queueProps
Kind
method
Type
() => PartProps
Requirement
required
Name
quoteDismissProps
Kind
method
Type
() => PartProps
Requirement
required
Name
quoteProps
Kind
method
Type
() => PartProps
Requirement
required
Name
quoteTextProps
Kind
method
Type
() => PartProps
Requirement
required
Name
removeAttachment
Kind
method
Type
(id: string) => void
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
selectTriggerPopover
Kind
method
Type
(item: TriggerPopoverItem) => void
Requirement
required
Name
selectTriggerPopoverCategory
Kind
method
Type
(category: string) => boolean
Requirement
required
Name
sendProps
Kind
method
Type
() => PartProps
Requirement
required
Name
stopDictationProps
Kind
method
Type
() => PartProps
Requirement
required
Name
subscribe
Kind
method
Type
(listener: () => void) => () => void
Requirement
required
Name
text
Kind
property
Type
string
Requirement
required
Name
triggerPopoverBackProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerPopoverCategoriesProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerPopoverCategoryItemProps
Kind
method
Type
(category: string) => PartProps
Requirement
required
Name
triggerPopoverItemProps
Kind
method
Type
(item: TriggerPopoverItem) => PartProps
Requirement
required
Name
triggerPopoverItemsProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerPopoverOpen
Kind
property
Type
boolean
Requirement
required
Name
triggerPopoverProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerPopoverRootProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
AssistantComposerAttachmentLikets
interface AssistantComposerAttachmentLike {
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
DeclarationView source
AssistantComposerClientLikets
interface AssistantComposerClientLike {
readonly composer?: AssistantComposerScopeLike;
readonly capabilities?: Record<string, boolean>;
}
Name
Kind
Type
Requirement
capabilities
property
Record<string, boolean>
optional
composer
property
AssistantComposerScopeLike
optional
Name
capabilities
Kind
property
Type
Record<string, boolean>
Requirement
optional
Name
composer
Kind
property
Type
AssistantComposerScopeLike
Requirement
optional
DeclarationView source
AssistantComposerConnectOptionsts
interface AssistantComposerConnectOptions {
readonly compact?: boolean;
readonly submitMode?: ComposerSubmitMode;
readonly cancelOnEscape?: boolean;
readonly addAttachmentOnPaste?: boolean;
readonly steerHotkey?: "shiftEnter" | "altEnter" | "ctrlEnter";
readonly unstableInsertNewlineOnTouchEnter?: boolean;
readonly inputLabel?: string;
readonly attachmentAccept?: string;
readonly attachmentMultiple?: boolean;
readonly getDragging?: () => boolean;
readonly onDraggingChange?: (dragging: boolean) => void;
readonly onAddAttachment?: (files: readonly File[]) => void;
readonly onRequestAttachment?: () => void;
readonly onDictate?: () => void;
readonly onStopDictation?: () => void;
readonly onQuoteDismiss?: () => void;
readonly onSubmit?: (event?: unknown) => void;
readonly triggerPopover?: TriggerPopoverRegistry;
readonly inputHistory?: InputHistory;
readonly onCompositionStart?: () => void;
readonly onCompositionEnd?: () => void;
}
Name
Kind
Type
Requirement
addAttachmentOnPaste
property
boolean
optional
attachmentAccept
property
string
optional
attachmentMultiple
property
boolean
optional
cancelOnEscape
property
boolean
optional
compact
property
boolean
optional
getDragging
property
() => boolean
optional
inputHistory
property
InputHistory
optional
inputLabel
property
string
optional
onAddAttachment
property
(files: readonly File[]) => void
optional
onCompositionEnd
property
() => void
optional
onCompositionStart
property
() => void
optional
onDictate
property
() => void
optional
onDraggingChange
property
(dragging: boolean) => void
optional
onQuoteDismiss
property
() => void
optional
Name
addAttachmentOnPaste
Kind
property
Type
boolean
Requirement
optional
Name
attachmentAccept
Kind
property
Type
string
Requirement
optional
Name
attachmentMultiple
Kind
property
Type
boolean
Requirement
optional
Name
cancelOnEscape
Kind
property
Type
boolean
Requirement
optional
Name
compact
Kind
property
Type
boolean
Requirement
optional
Name
getDragging
Kind
property
Type
() => boolean
Requirement
optional
Name
inputHistory
Kind
property
Type
InputHistory
Requirement
optional
Name
inputLabel
Kind
property
Type
string
Requirement
optional
Name
onAddAttachment
Kind
property
Type
(files: readonly File[]) => void
Requirement
optional
Name
onCompositionEnd
Kind
property
Type
() => void
Requirement
optional
Name
onCompositionStart
Kind
property
Type
() => void
Requirement
optional
Name
onDictate
Kind
property
Type
() => void
Requirement
optional
Name
onDraggingChange
Kind
property
Type
(dragging: boolean) => void
Requirement
optional
Name
onQuoteDismiss
Kind
property
Type
() => void
Requirement
optional
Name
onRequestAttachment
Kind
property
Type
() => void
Requirement
optional
Name
onStopDictation
Kind
property
Type
() => void
Requirement
optional
Name
onSubmit
Kind
property
Type
(event?: unknown) => void
Requirement
optional
Name
steerHotkey
Kind
property
Type
"shiftEnter" | "altEnter" | "ctrlEnter"
Requirement
optional
Name
submitMode
Kind
property
Type
ComposerSubmitMode
Requirement
optional
Name
triggerPopover
Kind
property
Type
TriggerPopoverRegistry
Requirement
optional
Name
unstableInsertNewlineOnTouchEnter
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
AssistantComposerInputOptionsts
type AssistantComposerInputOptions = Pick<AssistantComposerConnectOptions, "submitMode" | "cancelOnEscape" | "addAttachmentOnPaste" | "steerHotkey" | "unstableInsertNewlineOnTouchEnter" | "inputLabel">;
DeclarationView source
AssistantComposerMountts
interface AssistantComposerMount {
readonly connector: AssistantComposerApi;
readonly root: HTMLFormElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
AssistantComposerApi
required
destroy
method
() => void
required
root
property
HTMLFormElement
required
Name
connector
Kind
property
Type
AssistantComposerApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLFormElement
Requirement
required
DeclarationView source
AssistantComposerPartts
type AssistantComposerPart = (typeof parts)[number];
DeclarationView source
AssistantDataUIRegistrationts
type AssistantDataUIRegistration<T = unknown> = {
readonly name: string;
readonly render: T;
};
Name
Kind
Type
Requirement
name
property
string
required
render
property
T
required
Name
name
Kind
property
Type
string
Requirement
required
Name
render
Kind
property
Type
T
Requirement
required
DeclarationView source
assistantErrorAnatomyts
export declare const assistantErrorAnatomy: {
readonly scope: "assistant-error";
readonly parts: readonly ["root", "message"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "message"]
required
scope
property
"assistant-error"
required
Name
parts
Kind
property
Type
readonly ["root", "message"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-error"
Requirement
required

AssistantErrorApi

interface
DeclarationView source
AssistantErrorApits
interface AssistantErrorApi {
rootProps(): PartProps;
messageProps(): PartProps;
readonly visible: boolean;
readonly message: string;
}
Name
Kind
Type
Requirement
message
property
string
required
messageProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
visible
property
boolean
required
Name
message
Kind
property
Type
string
Requirement
required
Name
messageProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
visible
Kind
property
Type
boolean
Requirement
required
DeclarationView source
AssistantErrorConnectOptionsts
interface AssistantErrorConnectOptions {
readonly status?: AssistantErrorStatus;
}
Name
Kind
Type
Requirement
status
property
AssistantErrorStatus
optional
Name
status
Kind
property
Type
AssistantErrorStatus
Requirement
optional
DeclarationView source
AssistantErrorPartts
type AssistantErrorPart = (typeof assistantErrorAnatomy.parts)[number];
DeclarationView source
AssistantErrorStatusts
type AssistantErrorStatus = {
readonly type: string;
readonly reason?: string;
readonly error?: unknown;
};
Name
Kind
Type
Requirement
error
property
unknown
optional
reason
property
string
optional
type
property
string
required
Name
error
Kind
property
Type
unknown
Requirement
optional
Name
reason
Kind
property
Type
string
Requirement
optional
Name
type
Kind
property
Type
string
Requirement
required
DeclarationView source
AssistantMcpAddFormControllerts
type AssistantMcpAddFormController = {
readonly getState: () => AssistantMcpAddFormState;
readonly subscribe: (listener: () => void) => () => void;
readonly rootProps: () => Readonly<Record<string, unknown>>;
readonly inputProps: (name: string) => Readonly<Record<string, unknown>>;
readonly submitProps: () => Readonly<Record<string, unknown>>;
readonly setValue: (name: string, value: unknown) => void;
readonly submit: (values?: Readonly<Record<string, unknown>>) => Promise<void>;
readonly reset: () => void;
readonly dispose: () => void;
};
Name
Kind
Type
Requirement
dispose
property
() => void
required
getState
property
() => AssistantMcpAddFormState
required
inputProps
property
(name: string) => Readonly<Record<string, unknown>>
required
reset
property
() => void
required
rootProps
property
() => Readonly<Record<string, unknown>>
required
setValue
property
(name: string, value: unknown) => void
required
submit
property
(values?: Readonly<Record<string, unknown>>) => Promise<void>
required
submitProps
property
() => Readonly<Record<string, unknown>>
required
subscribe
property
(listener: () => void) => () => void
required
Name
dispose
Kind
property
Type
() => void
Requirement
required
Name
getState
Kind
property
Type
() => AssistantMcpAddFormState
Requirement
required
Name
inputProps
Kind
property
Type
(name: string) => Readonly<Record<string, unknown>>
Requirement
required
Name
reset
Kind
property
Type
() => void
Requirement
required
Name
rootProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
setValue
Kind
property
Type
(name: string, value: unknown) => void
Requirement
required
Name
submit
Kind
property
Type
(values?: Readonly<Record<string, unknown>>) => Promise<void>
Requirement
required
Name
submitProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
subscribe
Kind
property
Type
(listener: () => void) => () => void
Requirement
required
DeclarationView source
AssistantMcpAddFormStatusts
type AssistantMcpAddFormStatus = "idle" | "submitting" | "submitted" | "error";
DeclarationView source
AssistantMcpElicitationControllerts
type AssistantMcpElicitationController = {
readonly getState: () => AssistantMcpElicitationState;
readonly subscribe: (listener: () => void) => () => void;
readonly rootProps: () => Readonly<Record<string, unknown>>;
readonly formProps: () => Readonly<Record<string, unknown>>;
readonly submitProps: () => Readonly<Record<string, unknown>>;
readonly cancelProps: () => Readonly<Record<string, unknown>>;
readonly submit: (response: unknown) => Promise<void>;
readonly cancel: () => void;
readonly dispose: () => void;
};
Name
Kind
Type
Requirement
cancel
property
() => void
required
cancelProps
property
() => Readonly<Record<string, unknown>>
required
dispose
property
() => void
required
formProps
property
() => Readonly<Record<string, unknown>>
required
getState
property
() => AssistantMcpElicitationState
required
rootProps
property
() => Readonly<Record<string, unknown>>
required
submit
property
(response: unknown) => Promise<void>
required
submitProps
property
() => Readonly<Record<string, unknown>>
required
subscribe
property
(listener: () => void) => () => void
required
Name
cancel
Kind
property
Type
() => void
Requirement
required
Name
cancelProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
dispose
Kind
property
Type
() => void
Requirement
required
Name
formProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
getState
Kind
property
Type
() => AssistantMcpElicitationState
Requirement
required
Name
rootProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
submit
Kind
property
Type
(response: unknown) => Promise<void>
Requirement
required
Name
submitProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
subscribe
Kind
property
Type
(listener: () => void) => () => void
Requirement
required
DeclarationView source
AssistantMcpElicitationStatusts
type AssistantMcpElicitationStatus = "pending" | "submitted" | "cancelled";
DeclarationView source
AssistantMcpManagerControllerts
type AssistantMcpManagerController = {
readonly getState: () => AssistantMcpManagerState;
readonly subscribe: (listener: () => void) => () => void;
readonly rootProps: () => Readonly<Record<string, unknown>>;
readonly connectorsProps: () => Readonly<Record<string, unknown>>;
readonly customServersProps: () => Readonly<Record<string, unknown>>;
readonly addCustomTriggerProps: () => Readonly<Record<string, unknown>>;
readonly connect: (serverId: string) => Promise<void>;
readonly disconnect: (serverId: string) => Promise<void>;
readonly dispose: () => void;
};
Name
Kind
Type
Requirement
addCustomTriggerProps
property
() => Readonly<Record<string, unknown>>
required
connect
property
(serverId: string) => Promise<void>
required
connectorsProps
property
() => Readonly<Record<string, unknown>>
required
customServersProps
property
() => Readonly<Record<string, unknown>>
required
disconnect
property
(serverId: string) => Promise<void>
required
dispose
property
() => void
required
getState
property
() => AssistantMcpManagerState
required
rootProps
property
() => Readonly<Record<string, unknown>>
required
subscribe
property
(listener: () => void) => () => void
required
Name
addCustomTriggerProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
connect
Kind
property
Type
(serverId: string) => Promise<void>
Requirement
required
Name
connectorsProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
customServersProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
disconnect
Kind
property
Type
(serverId: string) => Promise<void>
Requirement
required
Name
dispose
Kind
property
Type
() => void
Requirement
required
Name
getState
Kind
property
Type
() => AssistantMcpManagerState
Requirement
required
Name
rootProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
subscribe
Kind
property
Type
(listener: () => void) => () => void
Requirement
required
DeclarationView source
AssistantMcpManagerLikets
type AssistantMcpManagerLike = {
readonly listServers: () => readonly AssistantMcpServerState[];
readonly getServer: (serverId: string) => AssistantMcpServerState | undefined;
readonly connect: (serverId: string) => Promise<void>;
readonly disconnect: (serverId: string) => Promise<void>;
readonly subscribe: (listener: () => void) => () => void;
};
Name
Kind
Type
Requirement
connect
property
(serverId: string) => Promise<void>
required
disconnect
property
(serverId: string) => Promise<void>
required
getServer
property
(serverId: string) => AssistantMcpServerState | undefined
required
listServers
property
() => readonly AssistantMcpServerState[]
required
subscribe
property
(listener: () => void) => () => void
required
Name
connect
Kind
property
Type
(serverId: string) => Promise<void>
Requirement
required
Name
disconnect
Kind
property
Type
(serverId: string) => Promise<void>
Requirement
required
Name
getServer
Kind
property
Type
(serverId: string) => AssistantMcpServerState | undefined
Requirement
required
Name
listServers
Kind
property
Type
() => readonly AssistantMcpServerState[]
Requirement
required
Name
subscribe
Kind
property
Type
(listener: () => void) => () => void
Requirement
required
DeclarationView source
AssistantMcpServerControllerts
type AssistantMcpServerController = {
readonly getState: () => AssistantMcpServerState;
readonly subscribe: (listener: () => void) => () => void;
readonly rootProps: () => Readonly<Record<string, unknown>>;
readonly iconProps: () => Readonly<Record<string, unknown>>;
readonly nameProps: () => Readonly<Record<string, unknown>>;
readonly statusProps: () => Readonly<Record<string, unknown>>;
readonly connectButtonProps: () => Readonly<Record<string, unknown>>;
readonly disconnectButtonProps: () => Readonly<Record<string, unknown>>;
readonly removeButtonProps: () => Readonly<Record<string, unknown>>;
readonly connect: () => Promise<void>;
readonly disconnect: () => Promise<void>;
readonly dispose: () => void;
};
Name
Kind
Type
Requirement
connect
property
() => Promise<void>
required
connectButtonProps
property
() => Readonly<Record<string, unknown>>
required
disconnect
property
() => Promise<void>
required
disconnectButtonProps
property
() => Readonly<Record<string, unknown>>
required
dispose
property
() => void
required
getState
property
() => AssistantMcpServerState
required
iconProps
property
() => Readonly<Record<string, unknown>>
required
nameProps
property
() => Readonly<Record<string, unknown>>
required
removeButtonProps
property
() => Readonly<Record<string, unknown>>
required
rootProps
property
() => Readonly<Record<string, unknown>>
required
statusProps
property
() => Readonly<Record<string, unknown>>
required
subscribe
property
(listener: () => void) => () => void
required
Name
connect
Kind
property
Type
() => Promise<void>
Requirement
required
Name
connectButtonProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
disconnect
Kind
property
Type
() => Promise<void>
Requirement
required
Name
disconnectButtonProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
dispose
Kind
property
Type
() => void
Requirement
required
Name
getState
Kind
property
Type
() => AssistantMcpServerState
Requirement
required
Name
iconProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
nameProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
removeButtonProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
rootProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
statusProps
Kind
property
Type
() => Readonly<Record<string, unknown>>
Requirement
required
Name
subscribe
Kind
property
Type
(listener: () => void) => () => void
Requirement
required
DeclarationView source
assistantModalAnatomyts
export declare const assistantModalAnatomy: {
readonly scope: "assistant-modal";
readonly parts: readonly ["root", "trigger", "anchor", "content", "title", "description", "close"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "trigger", "anchor", "content", "title", "description", "close"]
required
scope
property
"assistant-modal"
required
Name
parts
Kind
property
Type
readonly ["root", "trigger", "anchor", "content", "title", "description", "close"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-modal"
Requirement
required

AssistantModalApi

interface
DeclarationView source
AssistantModalApits
interface AssistantModalApi {
rootProps(): PartProps;
triggerProps(): PartProps;
anchorProps(): PartProps;
contentProps(): PartProps;
titleProps(): PartProps;
descriptionProps(): PartProps;
closeProps(): PartProps;
readonly open: boolean;
}
Name
Kind
Type
Requirement
anchorProps
method
() => PartProps
required
closeProps
method
() => PartProps
required
contentProps
method
() => PartProps
required
descriptionProps
method
() => PartProps
required
open
property
boolean
required
rootProps
method
() => PartProps
required
titleProps
method
() => PartProps
required
triggerProps
method
() => PartProps
required
Name
anchorProps
Kind
method
Type
() => PartProps
Requirement
required
Name
closeProps
Kind
method
Type
() => PartProps
Requirement
required
Name
contentProps
Kind
method
Type
() => PartProps
Requirement
required
Name
descriptionProps
Kind
method
Type
() => PartProps
Requirement
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
titleProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
AssistantModalConnectOptionsts
interface AssistantModalConnectOptions {
readonly modal?: boolean;
readonly side?: "top" | "bottom";
readonly align?: "start" | "end";
readonly dissmissOnInteractOutside?: boolean;
readonly dismissOnInteractOutside?: boolean;
}
Name
Kind
Type
Requirement
align
property
"start" | "end"
optional
dismissOnInteractOutside
property
boolean
optional
dissmissOnInteractOutside
property
boolean
optional
modal
property
boolean
optional
side
property
"top" | "bottom"
optional
Name
align
Kind
property
Type
"start" | "end"
Requirement
optional
Name
dismissOnInteractOutside
Kind
property
Type
boolean
Requirement
optional
Name
dissmissOnInteractOutside
Kind
property
Type
boolean
Requirement
optional
Name
modal
Kind
property
Type
boolean
Requirement
optional
Name
side
Kind
property
Type
"top" | "bottom"
Requirement
optional
DeclarationView source
AssistantModalPartts
type AssistantModalPart = (typeof assistantModalAnatomy.parts)[number];
DeclarationView source
AssistantModalServicets
type AssistantModalService = Service<PopoverInput, PopoverStateValue, PopoverContext, PopoverEvent, PopoverCommand>;
DeclarationView source
AssistantModelContextts
type AssistantModelContext = {
readonly priority?: number;
readonly system?: string;
readonly tools?: unknown;
readonly callSettings?: Readonly<Record<string, unknown>>;
readonly config?: Readonly<Record<string, unknown>>;
readonly unstable_composerMetadata?: unknown;
};
Name
Kind
Type
Requirement
callSettings
property
Readonly<Record<string, unknown>>
optional
config
property
Readonly<Record<string, unknown>>
optional
priority
property
number
optional
system
property
string
optional
tools
property
unknown
optional
unstable_composerMetadata
property
unknown
optional
Name
callSettings
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
optional
Name
config
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
optional
Name
priority
Kind
property
Type
number
Requirement
optional
Name
system
Kind
property
Type
string
Requirement
optional
Name
tools
Kind
property
Type
unknown
Requirement
optional
Name
unstable_composerMetadata
Kind
property
Type
unknown
Requirement
optional
DeclarationView source
AssistantModelContextClientts
type AssistantModelContextClient = {
readonly modelContextRegistry?: AssistantModelContextRegistry;
};
Name
Kind
Type
Requirement
modelContextRegistry
property
AssistantModelContextRegistry
optional
Name
modelContextRegistry
Kind
property
Type
AssistantModelContextRegistry
Requirement
optional
DeclarationView source
AssistantModelContextProviderts
type AssistantModelContextProvider = AssistantModelContext | (() => AssistantModelContext | undefined) | {
readonly getModelContext: () => AssistantModelContext | undefined;
};
DeclarationView source
AssistantModelContextRegistrationOptionsts
type AssistantModelContextRegistrationOptions = {
readonly priority?: number;
readonly source?: string;
};
Name
Kind
Type
Requirement
priority
property
number
optional
source
property
string
optional
Name
priority
Kind
property
Type
number
Requirement
optional
Name
source
Kind
property
Type
string
Requirement
optional
DeclarationView source
AssistantModelContextRegistryts
type AssistantModelContextRegistry = {
register(provider: AssistantModelContextProvider, options?: AssistantModelContextRegistrationOptions): () => void;
getModelContext(): AssistantModelContext;
};
Name
Kind
Type
Requirement
getModelContext
method
() => AssistantModelContext
required
register
method
(provider: AssistantModelContextProvider, options?: AssistantModelContextRegistrationOptions) => () => void
required
Name
getModelContext
Kind
method
Type
() => AssistantModelContext
Requirement
required
Name
register
Kind
method
Type
(provider: AssistantModelContextProvider, options?: AssistantModelContextRegistrationOptions) => () => void
Requirement
required
DeclarationView source
assistantQueueItemAnatomyts
export declare const assistantQueueItemAnatomy: {
readonly scope: "assistant-queue-item";
readonly parts: readonly ["root", "text", "steer", "remove"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "text", "steer", "remove"]
required
scope
property
"assistant-queue-item"
required
Name
parts
Kind
property
Type
readonly ["root", "text", "steer", "remove"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-queue-item"
Requirement
required
DeclarationView source
AssistantQueueItemApits
interface AssistantQueueItemApi {
rootProps(): PartProps;
textProps(): PartProps;
steerProps(): PartProps;
removeProps(): PartProps;
}
Name
Kind
Type
Requirement
removeProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
steerProps
method
() => PartProps
required
textProps
method
() => PartProps
required
Name
removeProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
steerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
textProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
AssistantQueueItemConnectOptionsts
interface AssistantQueueItemConnectOptions {
readonly item: AssistantQueueItemLike;
readonly onSteer?: (item: AssistantQueueItemLike) => void;
readonly onRemove?: (item: AssistantQueueItemLike) => void;
readonly steerLabel?: string;
readonly removeLabel?: string;
readonly disabled?: boolean;
}
Name
Kind
Type
Requirement
disabled
property
boolean
optional
item
property
AssistantQueueItemLike
required
onRemove
property
(item: AssistantQueueItemLike) => void
optional
onSteer
property
(item: AssistantQueueItemLike) => void
optional
removeLabel
property
string
optional
steerLabel
property
string
optional
Name
disabled
Kind
property
Type
boolean
Requirement
optional
Name
item
Kind
property
Type
AssistantQueueItemLike
Requirement
required
Name
onRemove
Kind
property
Type
(item: AssistantQueueItemLike) => void
Requirement
optional
Name
onSteer
Kind
property
Type
(item: AssistantQueueItemLike) => void
Requirement
optional
Name
removeLabel
Kind
property
Type
string
Requirement
optional
Name
steerLabel
Kind
property
Type
string
Requirement
optional
DeclarationView source
AssistantQueueItemLikets
interface AssistantQueueItemLike {
readonly id?: string;
readonly text?: string;
readonly value?: unknown;
}
Name
Kind
Type
Requirement
id
property
string
optional
text
property
string
optional
value
property
unknown
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
text
Kind
property
Type
string
Requirement
optional
Name
value
Kind
property
Type
unknown
Requirement
optional
DeclarationView source
AssistantQueueItemPartts
type AssistantQueueItemPart = (typeof assistantQueueItemAnatomy.parts)[number];
DeclarationView source
assistantSelectionToolbarAnatomyts
export declare const assistantSelectionToolbarAnatomy: {
readonly scope: "assistant-selection-toolbar";
readonly parts: readonly ["root", "quote"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "quote"]
required
scope
property
"assistant-selection-toolbar"
required
Name
parts
Kind
property
Type
readonly ["root", "quote"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-selection-toolbar"
Requirement
required
DeclarationView source
AssistantSelectionToolbarApits
interface AssistantSelectionToolbarApi {
rootProps(): PartProps;
quoteProps(): PartProps;
subscribe(listener: () => void): () => void;
destroy(): void;
}
Name
Kind
Type
Requirement
destroy
method
() => void
required
quoteProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
subscribe
method
(listener: () => void) => () => void
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
quoteProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
subscribe
Kind
method
Type
(listener: () => void) => () => void
Requirement
required
DeclarationView source
AssistantSelectionToolbarConnectOptionsts
interface AssistantSelectionToolbarConnectOptions {
readonly onQuote?: (selection: SelectionObserverSelection) => void;
readonly quoteLabel?: string;
}
Name
Kind
Type
Requirement
onQuote
property
(selection: SelectionObserverSelection) => void
optional
quoteLabel
property
string
optional
Name
onQuote
Kind
property
Type
(selection: SelectionObserverSelection) => void
Requirement
optional
Name
quoteLabel
Kind
property
Type
string
Requirement
optional
DeclarationView source
AssistantSelectionToolbarPartts
type AssistantSelectionToolbarPart = (typeof assistantSelectionToolbarAnatomy.parts)[number];
DeclarationView source
assistantSuggestionAnatomyts
export declare const assistantSuggestionAnatomy: {
readonly scope: "assistant-suggestion";
readonly parts: readonly ["root", "title", "description", "trigger"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "title", "description", "trigger"]
required
scope
property
"assistant-suggestion"
required
Name
parts
Kind
property
Type
readonly ["root", "title", "description", "trigger"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-suggestion"
Requirement
required
DeclarationView source
AssistantSuggestionApits
interface AssistantSuggestionApi {
rootProps(): PartProps;
titleProps(): PartProps;
descriptionProps(): PartProps;
triggerProps(): PartProps;
}
Name
Kind
Type
Requirement
descriptionProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
titleProps
method
() => PartProps
required
triggerProps
method
() => PartProps
required
Name
descriptionProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
titleProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
AssistantSuggestionClientLikets
type AssistantSuggestionClientLike = {
readonly composer?: {
readonly setText: (text: string) => unknown;
readonly send: (options?: {
readonly steer?: boolean;
}) => unknown;
};
};
Name
Kind
Type
Requirement
composer
property
{ readonly setText: (text: string) => unknown; readonly send: (options?: { readonly steer?: boolean; }) => unknown; }
optional
Name
composer
Kind
property
Type
{ readonly setText: (text: string) => unknown; readonly send: (options?: { readonly steer?: boolean; }) => unknown; }
Requirement
optional
DeclarationView source
AssistantSuggestionConnectOptionsts
interface AssistantSuggestionConnectOptions {
readonly client: AssistantSuggestionClientLike;
readonly text: string;
readonly send?: boolean;
readonly onTrigger?: () => void;
}
Name
Kind
Type
Requirement
client
property
AssistantSuggestionClientLike
required
onTrigger
property
() => void
optional
send
property
boolean
optional
text
property
string
required
Name
client
Kind
property
Type
AssistantSuggestionClientLike
Requirement
required
Name
onTrigger
Kind
property
Type
() => void
Requirement
optional
Name
send
Kind
property
Type
boolean
Requirement
optional
Name
text
Kind
property
Type
string
Requirement
required
DeclarationView source
AssistantSuggestionPartts
type AssistantSuggestionPart = (typeof assistantSuggestionAnatomy.parts)[number];
DeclarationView source
assistantThreadAnatomyts
export declare const assistantThreadAnatomy: {
readonly scope: "assistant-thread";
readonly parts: readonly ["root", "viewport", "viewport-provider", "footer", "messages", "message", "scroll-to-bottom", "suggestions", "suggestion"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "viewport", "viewport-provider", "footer", "messages", "message", "scroll-to-bottom", "suggestions", "suggestion"]
required
scope
property
"assistant-thread"
required
Name
parts
Kind
property
Type
readonly ["root", "viewport", "viewport-provider", "footer", "messages", "message", "scroll-to-bottom", "suggestions", "suggestion"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-thread"
Requirement
required

AssistantThreadApi

interface
DeclarationView source
AssistantThreadApits
interface AssistantThreadApi {
rootProps(): PartProps;
viewportProps(): PartProps;
viewportProviderProps(): PartProps;
footerProps(): PartProps;
messagesProps(): PartProps;
messageProps(id: string): PartProps;
scrollToBottomProps(): PartProps;
suggestionsProps(): PartProps;
suggestionProps(index: number): PartProps;
readonly following: boolean;
readonly running: boolean;
}
Name
Kind
Type
Requirement
following
property
boolean
required
footerProps
method
() => PartProps
required
messageProps
method
(id: string) => PartProps
required
messagesProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
running
property
boolean
required
scrollToBottomProps
method
() => PartProps
required
suggestionProps
method
(index: number) => PartProps
required
suggestionsProps
method
() => PartProps
required
viewportProps
method
() => PartProps
required
viewportProviderProps
method
() => PartProps
required
Name
following
Kind
property
Type
boolean
Requirement
required
Name
footerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
messageProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
messagesProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
running
Kind
property
Type
boolean
Requirement
required
Name
scrollToBottomProps
Kind
method
Type
() => PartProps
Requirement
required
Name
suggestionProps
Kind
method
Type
(index: number) => PartProps
Requirement
required
Name
suggestionsProps
Kind
method
Type
() => PartProps
Requirement
required
Name
viewportProps
Kind
method
Type
() => PartProps
Requirement
required
Name
viewportProviderProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
AssistantThreadClientLikets
type AssistantThreadClientLike = {
readonly thread?: {
readonly getState: () => Record<string, unknown>;
};
};
Name
Kind
Type
Requirement
thread
property
{ readonly getState: () => Record<string, unknown>; }
optional
Name
thread
Kind
property
Type
{ readonly getState: () => Record<string, unknown>; }
Requirement
optional
DeclarationView source
AssistantThreadConnectOptionsts
interface AssistantThreadConnectOptions {
readonly label?: string;
readonly busy?: boolean;
readonly getFollowing?: () => boolean;
readonly onScrollToBottom?: () => void;
}
Name
Kind
Type
Requirement
busy
property
boolean
optional
getFollowing
property
() => boolean
optional
label
property
string
optional
onScrollToBottom
property
() => void
optional
Name
busy
Kind
property
Type
boolean
Requirement
optional
Name
getFollowing
Kind
property
Type
() => boolean
Requirement
optional
Name
label
Kind
property
Type
string
Requirement
optional
Name
onScrollToBottom
Kind
property
Type
() => void
Requirement
optional
DeclarationView source
assistantThreadListAnatomyts
export declare const assistantThreadListAnatomy: {
readonly scope: "assistant-thread-list";
readonly parts: readonly ["root", "new", "items", "item", "load-more"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "new", "items", "item", "load-more"]
required
scope
property
"assistant-thread-list"
required
Name
parts
Kind
property
Type
readonly ["root", "new", "items", "item", "load-more"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-thread-list"
Requirement
required
DeclarationView source
AssistantThreadListApits
interface AssistantThreadListApi {
rootProps(): PartProps;
newProps(): PartProps;
itemsProps(): PartProps;
itemProps(item: AssistantThreadListItemLike, index: number): PartProps;
loadMoreProps(): PartProps;
readonly items: () => readonly AssistantThreadListItemLike[];
readonly selectedThreadId: string | null;
readonly loading: boolean;
readonly hasMore: boolean;
}
Name
Kind
Type
Requirement
hasMore
property
boolean
required
itemProps
method
(item: AssistantThreadListItemLike, index: number) => PartProps
required
items
property
() => readonly AssistantThreadListItemLike[]
required
itemsProps
method
() => PartProps
required
loading
property
boolean
required
loadMoreProps
method
() => PartProps
required
newProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
selectedThreadId
property
string | null
required
Name
hasMore
Kind
property
Type
boolean
Requirement
required
Name
itemProps
Kind
method
Type
(item: AssistantThreadListItemLike, index: number) => PartProps
Requirement
required
Name
items
Kind
property
Type
() => readonly AssistantThreadListItemLike[]
Requirement
required
Name
itemsProps
Kind
method
Type
() => PartProps
Requirement
required
Name
loading
Kind
property
Type
boolean
Requirement
required
Name
loadMoreProps
Kind
method
Type
() => PartProps
Requirement
required
Name
newProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
selectedThreadId
Kind
property
Type
string | null
Requirement
required
DeclarationView source
AssistantThreadListClientLikets
type AssistantThreadListClientLike = {
readonly threads?: {
readonly getState: () => Record<string, any>;
readonly subscribe?: (listener: () => void) => () => void;
readonly select?: (id: string | null) => unknown;
readonly reload?: () => unknown;
readonly loadMore?: () => unknown;
};
readonly capabilities?: {
readonly reload?: boolean;
readonly refetchThread?: boolean;
readonly delete?: boolean;
};
};
Name
Kind
Type
Requirement
capabilities
property
{ readonly reload?: boolean; readonly refetchThread?: boolean; readonly delete?: boolean; }
optional
threads
property
{ readonly getState: () => Record<string, any>; readonly subscribe?: (listener: () => void) => () => void; readonly select?: (id: string | null) => unknown; readonly reload?: () => unknown; readonly loadMore?: () => unknown; }
optional
Name
capabilities
Kind
property
Type
{ readonly reload?: boolean; readonly refetchThread?: boolean; readonly delete?: boolean; }
Requirement
optional
Name
threads
Kind
property
Type
{ readonly getState: () => Record<string, any>; readonly subscribe?: (listener: () => void) => () => void; readonly select?: (id: string | null) => unknown; readonly reload?: () => unknown; readonly loadMore?: () => unknown; }
Requirement
optional
DeclarationView source
AssistantThreadListConnectOptionsts
interface AssistantThreadListConnectOptions {
readonly dir?: "ltr" | "rtl";
readonly onNew?: () => void;
readonly onSelect?: (id: string) => void;
readonly onLoadMore?: () => void;
readonly onOpenMore?: (item: AssistantThreadListItemLike, index: number) => void;
readonly canCreate?: boolean;
}
Name
Kind
Type
Requirement
canCreate
property
boolean
optional
dir
property
"ltr" | "rtl"
optional
onLoadMore
property
() => void
optional
onNew
property
() => void
optional
onOpenMore
property
(item: AssistantThreadListItemLike, index: number) => void
optional
onSelect
property
(id: string) => void
optional
Name
canCreate
Kind
property
Type
boolean
Requirement
optional
Name
dir
Kind
property
Type
"ltr" | "rtl"
Requirement
optional
Name
onLoadMore
Kind
property
Type
() => void
Requirement
optional
Name
onNew
Kind
property
Type
() => void
Requirement
optional
Name
onOpenMore
Kind
property
Type
(item: AssistantThreadListItemLike, index: number) => void
Requirement
optional
Name
onSelect
Kind
property
Type
(id: string) => void
Requirement
optional
DeclarationView source
assistantThreadListItemAnatomyts
export declare const assistantThreadListItemAnatomy: {
readonly scope: "assistant-thread-list-item";
readonly parts: readonly ["root", "trigger", "title", "archive", "unarchive", "delete"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "trigger", "title", "archive", "unarchive", "delete"]
required
scope
property
"assistant-thread-list-item"
required
Name
parts
Kind
property
Type
readonly ["root", "trigger", "title", "archive", "unarchive", "delete"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-thread-list-item"
Requirement
required
DeclarationView source
AssistantThreadListItemApits
interface AssistantThreadListItemApi {
rootProps(): PartProps;
triggerProps(): PartProps;
titleProps(): PartProps;
archiveProps(): PartProps;
unarchiveProps(): PartProps;
deleteProps(): PartProps;
}
Name
Kind
Type
Requirement
archiveProps
method
() => PartProps
required
deleteProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
titleProps
method
() => PartProps
required
triggerProps
method
() => PartProps
required
unarchiveProps
method
() => PartProps
required
Name
archiveProps
Kind
method
Type
() => PartProps
Requirement
required
Name
deleteProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
titleProps
Kind
method
Type
() => PartProps
Requirement
required
Name
triggerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
unarchiveProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
AssistantThreadListItemCapabilitiests
interface AssistantThreadListItemCapabilities {
readonly delete?: boolean;
readonly reload?: boolean;
readonly refetchThread?: boolean;
}
Name
Kind
Type
Requirement
delete
property
boolean
optional
refetchThread
property
boolean
optional
reload
property
boolean
optional
Name
delete
Kind
property
Type
boolean
Requirement
optional
Name
refetchThread
Kind
property
Type
boolean
Requirement
optional
Name
reload
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
AssistantThreadListItemConnectOptionsts
interface AssistantThreadListItemConnectOptions {
readonly item: AssistantThreadListItemLike;
readonly active?: boolean;
readonly capabilities?: AssistantThreadListItemCapabilities;
readonly fallbackTitle?: string;
readonly onSelect?: () => void;
readonly onArchive?: () => void;
readonly onUnarchive?: () => void;
readonly onDelete?: () => void;
}
Name
Kind
Type
Requirement
active
property
boolean
optional
capabilities
property
AssistantThreadListItemCapabilities
optional
fallbackTitle
property
string
optional
item
property
AssistantThreadListItemLike
required
onArchive
property
() => void
optional
onDelete
property
() => void
optional
onSelect
property
() => void
optional
onUnarchive
property
() => void
optional
Name
active
Kind
property
Type
boolean
Requirement
optional
Name
capabilities
Kind
property
Type
AssistantThreadListItemCapabilities
Requirement
optional
Name
fallbackTitle
Kind
property
Type
string
Requirement
optional
Name
item
Kind
property
Type
AssistantThreadListItemLike
Requirement
required
Name
onArchive
Kind
property
Type
() => void
Requirement
optional
Name
onDelete
Kind
property
Type
() => void
Requirement
optional
Name
onSelect
Kind
property
Type
() => void
Requirement
optional
Name
onUnarchive
Kind
property
Type
() => void
Requirement
optional
DeclarationView source
AssistantThreadListItemLikets
type AssistantThreadListItemLike = {
readonly id?: string;
readonly remoteId?: string;
readonly externalId?: string;
readonly status?: "regular" | "archived" | string;
readonly title?: string;
readonly custom?: Readonly<Record<string, unknown>>;
};
Name
Kind
Type
Requirement
custom
property
Readonly<Record<string, unknown>>
optional
externalId
property
string
optional
id
property
string
optional
remoteId
property
string
optional
status
property
"regular" | "archived" | string
optional
title
property
string
optional
Name
custom
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
optional
Name
externalId
Kind
property
Type
string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
remoteId
Kind
property
Type
string
Requirement
optional
Name
status
Kind
property
Type
"regular" | "archived" | string
Requirement
optional
Name
title
Kind
property
Type
string
Requirement
optional
DeclarationView source
AssistantThreadListItemPartts
type AssistantThreadListItemPart = (typeof assistantThreadListItemAnatomy.parts)[number];
DeclarationView source
AssistantThreadListPartts
type AssistantThreadListPart = (typeof assistantThreadListAnatomy.parts)[number];
DeclarationView source
AssistantThreadMountts
interface AssistantThreadMount {
readonly connector: AssistantThreadApi;
readonly root: HTMLElement;
destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
AssistantThreadApi
required
destroy
method
() => void
required
root
property
HTMLElement
required
Name
connector
Kind
property
Type
AssistantThreadApi
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
DeclarationView source
AssistantThreadPartts
type AssistantThreadPart = (typeof assistantThreadAnatomy.parts)[number];
DeclarationView source
AssistantToolUIRegistrationts
type AssistantToolUIRegistration<T = unknown> = {
readonly name?: string;
readonly render?: T;
readonly renderText?: (value: unknown) => string | null;
};
Name
Kind
Type
Requirement
name
property
string
optional
render
property
T
optional
renderText
property
(value: unknown) => string | null
optional
Name
name
Kind
property
Type
string
Requirement
optional
Name
render
Kind
property
Type
T
Requirement
optional
Name
renderText
Kind
property
Type
(value: unknown) => string | null
Requirement
optional
DeclarationView source
AssistantVisibleOptionsts
type AssistantVisibleOptions = {
readonly clickable?: boolean;
readonly editable?: boolean;
};
Name
Kind
Type
Requirement
clickable
property
boolean
optional
editable
property
boolean
optional
Name
clickable
Kind
property
Type
boolean
Requirement
optional
Name
editable
Kind
property
Type
boolean
Requirement
optional

astToEditorNodes

function
DeclarationView source
astToEditorNodests
declare function astToEditorNodes(document: MarkdownDocument): readonly EditorBridgeNode[];
Name
Kind
Type
Requirement
document
parameter
MarkdownDocument
required
return
return value
readonly EditorBridgeNode[]
n/a
Name
document
Kind
parameter
Type
MarkdownDocument
Requirement
required
Name
return
Kind
return value
Type
readonly EditorBridgeNode[]
Requirement
n/a

AutosizeController

interface
DeclarationView source
AutosizeControllerts
interface AutosizeController {
sync(): void;
destroy(): void;
}
Name
Kind
Type
Requirement
destroy
method
() => void
required
sync
method
() => void
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
sync
Kind
method
Type
() => void
Requirement
required

AutosizeOptions

interface
DeclarationView source
AutosizeOptionsts
interface AutosizeOptions {
readonly maxHeight?: number;
readonly minHeight?: number;
}
Name
Kind
Type
Requirement
maxHeight
property
number
optional
minHeight
property
number
optional
Name
maxHeight
Kind
property
Type
number
Requirement
optional
Name
minHeight
Kind
property
Type
number
Requirement
optional

BlockNode

type
DeclarationView source
BlockNodets
type BlockNode = {
readonly id: string;
readonly type: Exclude<MarkdownNodeType, "document" | "text" | "emphasis" | "strong" | "strikethrough" | "code-span" | "link" | "autolink" | "image" | "footnote-ref" | "hard-break">;
readonly raw: string;
readonly position?: Position;
readonly text?: string;
readonly level?: number;
readonly lang?: string;
readonly meta?: string;
readonly ordered?: boolean;
readonly start?: number;
readonly tight?: boolean;
readonly checked?: boolean;
readonly align?: readonly ("left" | "center" | "right" | null)[];
readonly cells?: readonly (readonly InlineNode[])[];
readonly children?: readonly (BlockNode | InlineNode)[];
};
Name
Kind
Type
Requirement
align
property
readonly ("left" | "center" | "right" | null)[]
optional
cells
property
readonly (readonly InlineNode[])[]
optional
checked
property
boolean
optional
children
property
readonly (BlockNode | InlineNode)[]
optional
id
property
string
required
lang
property
string
optional
level
property
number
optional
meta
property
string
optional
ordered
property
boolean
optional
position
property
Position
optional
raw
property
string
required
start
property
number
optional
text
property
string
optional
tight
property
boolean
optional
Name
align
Kind
property
Type
readonly ("left" | "center" | "right" | null)[]
Requirement
optional
Name
cells
Kind
property
Type
readonly (readonly InlineNode[])[]
Requirement
optional
Name
checked
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
readonly (BlockNode | InlineNode)[]
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required
Name
lang
Kind
property
Type
string
Requirement
optional
Name
level
Kind
property
Type
number
Requirement
optional
Name
meta
Kind
property
Type
string
Requirement
optional
Name
ordered
Kind
property
Type
boolean
Requirement
optional
Name
position
Kind
property
Type
Position
Requirement
optional
Name
raw
Kind
property
Type
string
Requirement
required
Name
start
Kind
property
Type
number
Requirement
optional
Name
text
Kind
property
Type
string
Requirement
optional
Name
tight
Kind
property
Type
boolean
Requirement
optional
Name
type
Kind
property
Type
Exclude<MarkdownNodeType, "document" | "text" | "emphasis" | "strong" | "strikethrough" | "code-span" | "link" | "autolink" | "image" | "footnote-ref" | "hard-break">
Requirement
required

ChartDataSession

interface
DeclarationView source
ChartDataSessionts
interface ChartDataSession {
replace(source: ChartDataSource): void;
dispose(): void;
}
Name
Kind
Type
Requirement
dispose
method
() => void
required
replace
method
(source: ChartDataSource) => void
required
Name
dispose
Kind
method
Type
() => void
Requirement
required
Name
replace
Kind
method
Type
(source: ChartDataSource) => void
Requirement
required
DeclarationView source
ChartDataSessionOptionsts
interface ChartDataSessionOptions {
readonly onData?: (snapshot: ChartSeriesSnapshot) => void;
readonly onStatus?: (status: ChartDataStatus) => void;
}
Name
Kind
Type
Requirement
onData
property
(snapshot: ChartSeriesSnapshot) => void
optional
onStatus
property
(status: ChartDataStatus) => void
optional
Name
onData
Kind
property
Type
(snapshot: ChartSeriesSnapshot) => void
Requirement
optional
Name
onStatus
Kind
property
Type
(status: ChartDataStatus) => void
Requirement
optional
DeclarationView source
ChartDataSourcets
type ChartDataSource = StreamSource<ChartSeriesSnapshot>;
DeclarationView source
ChartDataStatusts
type ChartDataStatus = "loading" | "ready" | "error";
DeclarationView source
ChartSeriesSnapshotts
type ChartSeriesSnapshot = readonly ChartSeries[];
DeclarationView source
CLICK_ID_ATTRIBUTEts
export declare const CLICK_ID_ATTRIBUTE: "data-click-id";
DeclarationView source
ClipboardControllerts
interface ClipboardController {
attach(element: Element): void;
destroy(): void;
listenerCount(): number;
}
Name
Kind
Type
Requirement
attach
method
(element: Element) => void
required
destroy
method
() => void
required
listenerCount
method
() => number
required
Name
attach
Kind
method
Type
(element: Element) => void
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
listenerCount
Kind
method
Type
() => number
Requirement
required

ClipboardManager

interface
DeclarationView source
ClipboardManagerts
interface ClipboardManager {
copy(text: string): Promise<void>;
subscribe(listener: () => void): () => void;
getState(): ClipboardState;
destroy(): void;
}
Name
Kind
Type
Requirement
copy
method
(text: string) => Promise<void>
required
destroy
method
() => void
required
getState
method
() => ClipboardState
required
subscribe
method
(listener: () => void) => () => void
required
Name
copy
Kind
method
Type
(text: string) => Promise<void>
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
getState
Kind
method
Type
() => ClipboardState
Requirement
required
Name
subscribe
Kind
method
Type
(listener: () => void) => () => void
Requirement
required
DeclarationView source
ClipboardManagerOptionsts
interface ClipboardManagerOptions {
readonly writeText?: (text: string) => void | Promise<void>;
readonly copiedDuration?: number;
}
Name
Kind
Type
Requirement
copiedDuration
property
number
optional
writeText
property
(text: string) => void | Promise<void>
optional
Name
copiedDuration
Kind
property
Type
number
Requirement
optional
Name
writeText
Kind
property
Type
(text: string) => void | Promise<void>
Requirement
optional
DeclarationView source
ClipboardTSVOptionsts
interface ClipboardTSVOptions {
readonly columnDelimiter?: string;
readonly rowDelimiter?: string;
}
Name
Kind
Type
Requirement
columnDelimiter
property
string
optional
rowDelimiter
property
string
optional
Name
columnDelimiter
Kind
property
Type
string
Requirement
optional
Name
rowDelimiter
Kind
property
Type
string
Requirement
optional
DeclarationView source
collectDiagnosticsts
declare function collectDiagnostics(document: MarkdownDocument, code?: MarkdownDiagnosticCode | string): readonly MarkdownDiagnostic[];
Name
Kind
Type
Requirement
document
parameter
MarkdownDocument
required
code
parameter
MarkdownDiagnosticCode | string
optional
return
return value
readonly MarkdownDiagnostic[]
n/a
Name
document
Kind
parameter
Type
MarkdownDocument
Requirement
required
Name
code
Kind
parameter
Type
MarkdownDiagnosticCode | string
Requirement
optional
Name
return
Kind
return value
Type
readonly MarkdownDiagnostic[]
Requirement
n/a
DeclarationView source
ComposerSubmitModets
type ComposerSubmitMode = "enter" | "ctrlEnter" | "none";

computeBlockId

function
DeclarationView source
computeBlockIdts
declare function computeBlockId(ordinal: number, rawSourceSlice: string): string;
Name
Kind
Type
Requirement
ordinal
parameter
number
required
rawSourceSlice
parameter
string
required
return
return value
string
n/a
Name
ordinal
Kind
parameter
Type
number
Requirement
required
Name
rawSourceSlice
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
string
Requirement
n/a
DeclarationView source
computeColumnWindowts
declare function computeColumnWindow(params: {
readonly scrollOffset: number;
readonly viewportSize: number;
readonly columnCount: number;
readonly estimatedColumnSize: number;
readonly overscan?: number;
}): VirtualWindow;
Name
Kind
Type
Requirement
params
parameter
{ readonly scrollOffset: number; readonly viewportSize: number; readonly columnCount: number; readonly estimatedColumnSize: number; readonly overscan?: number; }
required
return
return value
VirtualWindow
n/a
Name
params
Kind
parameter
Type
{ readonly scrollOffset: number; readonly viewportSize: number; readonly columnCount: number; readonly estimatedColumnSize: number; readonly overscan?: number; }
Requirement
required
Name
return
Kind
return value
Type
VirtualWindow
Requirement
n/a
DeclarationView source
computeVirtualWindowts
declare function computeVirtualWindow(params: {
readonly scrollOffset: number;
readonly viewportSize: number;
readonly itemCount: number;
readonly estimatedItemSize: number;
readonly measuredSizes?: ReadonlyMap<number, number>;
readonly overscan?: number;
}): VirtualWindow;
Name
Kind
Type
Requirement
params
parameter
{ readonly scrollOffset: number; readonly viewportSize: number; readonly itemCount: number; readonly estimatedItemSize: number; readonly measuredSizes?: ReadonlyMap<number, number>; readonly overscan?: number; }
required
return
return value
VirtualWindow
n/a
Name
params
Kind
parameter
Type
{ readonly scrollOffset: number; readonly viewportSize: number; readonly itemCount: number; readonly estimatedItemSize: number; readonly measuredSizes?: ReadonlyMap<number, number>; readonly overscan?: number; }
Requirement
required
Name
return
Kind
return value
Type
VirtualWindow
Requirement
n/a
DeclarationView source
connectAssistantActionBarts
declare function connectAssistantActionBar(client: AssistantActionBarClientLike, scope: PartScope, options?: AssistantActionBarConnectOptions): AssistantActionBarApi;
Name
Kind
Type
Requirement
client
parameter
AssistantActionBarClientLike
required
scope
parameter
PartScope
required
options
parameter
AssistantActionBarConnectOptions
optional
return
return value
AssistantActionBarApi
n/a
Name
client
Kind
parameter
Type
AssistantActionBarClientLike
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantActionBarConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
AssistantActionBarApi
Requirement
n/a
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
DeclarationView source
connectAssistantBranchPickerts
declare function connectAssistantBranchPicker(scope: PartScope, options: AssistantBranchPickerConnectOptions): AssistantBranchPickerApi;
Name
Kind
Type
Requirement
scope
parameter
PartScope
required
options
parameter
AssistantBranchPickerConnectOptions
required
return
return value
AssistantBranchPickerApi
n/a
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantBranchPickerConnectOptions
Requirement
required
Name
return
Kind
return value
Type
AssistantBranchPickerApi
Requirement
n/a
DeclarationView source
connectAssistantChainOfThoughtts
declare function connectAssistantChainOfThought(collapsible: CollapsibleApi, scope: PartScope): AssistantChainOfThoughtApi;
Name
Kind
Type
Requirement
collapsible
parameter
CollapsibleApi
required
scope
parameter
PartScope
required
return
return value
AssistantChainOfThoughtApi
n/a
Name
collapsible
Kind
parameter
Type
CollapsibleApi
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
return
Kind
return value
Type
AssistantChainOfThoughtApi
Requirement
n/a
DeclarationView source
connectAssistantComposerts
declare function connectAssistantComposer(client: AssistantComposerClientLike, scope: PartScope, options?: AssistantComposerConnectOptions): AssistantComposerApi;
Name
Kind
Type
Requirement
client
parameter
AssistantComposerClientLike
required
scope
parameter
PartScope
required
options
parameter
AssistantComposerConnectOptions
optional
return
return value
AssistantComposerApi
n/a
Name
client
Kind
parameter
Type
AssistantComposerClientLike
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantComposerConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
AssistantComposerApi
Requirement
n/a
DeclarationView source
connectAssistantErrorts
declare function connectAssistantError(scope: PartScope, options?: AssistantErrorConnectOptions): AssistantErrorApi;
Name
Kind
Type
Requirement
scope
parameter
PartScope
required
options
parameter
AssistantErrorConnectOptions
optional
return
return value
AssistantErrorApi
n/a
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantErrorConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
AssistantErrorApi
Requirement
n/a
DeclarationView source
connectAssistantModalts
declare function connectAssistantModal(service: AssistantModalService, scope: PartScope, options?: AssistantModalConnectOptions): AssistantModalApi;
Name
Kind
Type
Requirement
service
parameter
AssistantModalService
required
scope
parameter
PartScope
required
options
parameter
AssistantModalConnectOptions
optional
return
return value
AssistantModalApi
n/a
Name
service
Kind
parameter
Type
AssistantModalService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantModalConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
AssistantModalApi
Requirement
n/a
DeclarationView source
connectAssistantQueueItemts
declare function connectAssistantQueueItem(scope: PartScope, options: AssistantQueueItemConnectOptions): AssistantQueueItemApi;
Name
Kind
Type
Requirement
scope
parameter
PartScope
required
options
parameter
AssistantQueueItemConnectOptions
required
return
return value
AssistantQueueItemApi
n/a
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantQueueItemConnectOptions
Requirement
required
Name
return
Kind
return value
Type
AssistantQueueItemApi
Requirement
n/a
DeclarationView source
connectAssistantSelectionToolbarts
declare function connectAssistantSelectionToolbar(observer: SelectionObserverApi, scope: PartScope, options?: AssistantSelectionToolbarConnectOptions): AssistantSelectionToolbarApi;
Name
Kind
Type
Requirement
observer
parameter
SelectionObserverApi
required
scope
parameter
PartScope
required
options
parameter
AssistantSelectionToolbarConnectOptions
optional
return
return value
AssistantSelectionToolbarApi
n/a
Name
observer
Kind
parameter
Type
SelectionObserverApi
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantSelectionToolbarConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
AssistantSelectionToolbarApi
Requirement
n/a
DeclarationView source
connectAssistantSuggestionts
declare function connectAssistantSuggestion(scope: PartScope, options: AssistantSuggestionConnectOptions): AssistantSuggestionApi;
Name
Kind
Type
Requirement
scope
parameter
PartScope
required
options
parameter
AssistantSuggestionConnectOptions
required
return
return value
AssistantSuggestionApi
n/a
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantSuggestionConnectOptions
Requirement
required
Name
return
Kind
return value
Type
AssistantSuggestionApi
Requirement
n/a
DeclarationView source
connectAssistantThreadts
declare function connectAssistantThread(client: AssistantThreadClientLike, scope: PartScope, options?: AssistantThreadConnectOptions): AssistantThreadApi;
Name
Kind
Type
Requirement
client
parameter
AssistantThreadClientLike
required
scope
parameter
PartScope
required
options
parameter
AssistantThreadConnectOptions
optional
return
return value
AssistantThreadApi
n/a
Name
client
Kind
parameter
Type
AssistantThreadClientLike
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantThreadConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
AssistantThreadApi
Requirement
n/a
DeclarationView source
connectAssistantThreadListts
declare function connectAssistantThreadList(client: AssistantThreadListClientLike, scope: PartScope, options?: AssistantThreadListConnectOptions): AssistantThreadListApi;
Name
Kind
Type
Requirement
client
parameter
AssistantThreadListClientLike
required
scope
parameter
PartScope
required
options
parameter
AssistantThreadListConnectOptions
optional
return
return value
AssistantThreadListApi
n/a
Name
client
Kind
parameter
Type
AssistantThreadListClientLike
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantThreadListConnectOptions
Requirement
optional
Name
return
Kind
return value
Type
AssistantThreadListApi
Requirement
n/a
DeclarationView source
connectAssistantThreadListItemts
declare function connectAssistantThreadListItem(scope: PartScope, options: AssistantThreadListItemConnectOptions): AssistantThreadListItemApi;
Name
Kind
Type
Requirement
scope
parameter
PartScope
required
options
parameter
AssistantThreadListItemConnectOptions
required
return
return value
AssistantThreadListItemApi
n/a
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantThreadListItemConnectOptions
Requirement
required
Name
return
Kind
return value
Type
AssistantThreadListItemApi
Requirement
n/a

connectGrid

function
DeclarationView source
connectGridts
declare function connectGrid<T>(service: GridService<T>, scope: PartScope, options: GridConnectOptions<T>, remoteSnapshot?: GridRemoteSnapshot<T> | (() => GridRemoteSnapshot<T>)): GridApi<T>;
Name
Kind
Type
Requirement
service
parameter
GridService<T>
required
scope
parameter
PartScope
required
options
parameter
GridConnectOptions<T>
required
remoteSnapshot
parameter
GridRemoteSnapshot<T> | (() => GridRemoteSnapshot<T>)
optional
return
return value
GridApi<T>
n/a
Name
service
Kind
parameter
Type
GridService<T>
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
GridConnectOptions<T>
Requirement
required
Name
remoteSnapshot
Kind
parameter
Type
GridRemoteSnapshot<T> | (() => GridRemoteSnapshot<T>)
Requirement
optional
Name
return
Kind
return value
Type
GridApi<T>
Requirement
n/a
DeclarationView source
contentHashedOrigints
export declare const contentHashedOrigin: (resourceUri: string) => string;
Name
Kind
Type
Requirement
resourceUri
parameter
string
required
return
return value
string
n/a
Name
resourceUri
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
string
Requirement
n/a
DeclarationView source
createAssistantMcpAddFormControllerts
declare function createAssistantMcpAddFormController(options: {
readonly onSubmit: (values: Readonly<Record<string, unknown>>) => void | Promise<void>;
}): AssistantMcpAddFormController;
Name
Kind
Type
Requirement
options
parameter
{ readonly onSubmit: (values: Readonly<Record<string, unknown>>) => void | Promise<void>; }
required
return
return value
AssistantMcpAddFormController
n/a
Name
options
Kind
parameter
Type
{ readonly onSubmit: (values: Readonly<Record<string, unknown>>) => void | Promise<void>; }
Requirement
required
Name
return
Kind
return value
Type
AssistantMcpAddFormController
Requirement
n/a
DeclarationView source
createAssistantMcpElicitationControllerts
declare function createAssistantMcpElicitationController(options: {
readonly request: unknown;
readonly onSubmit?: (response: unknown) => void | Promise<void>;
readonly onCancel?: () => void | Promise<void>;
}): AssistantMcpElicitationController;
Name
Kind
Type
Requirement
options
parameter
{ readonly request: unknown; readonly onSubmit?: (response: unknown) => void | Promise<void>; readonly onCancel?: () => void | Promise<void>; }
required
return
return value
AssistantMcpElicitationController
n/a
Name
options
Kind
parameter
Type
{ readonly request: unknown; readonly onSubmit?: (response: unknown) => void | Promise<void>; readonly onCancel?: () => void | Promise<void>; }
Requirement
required
Name
return
Kind
return value
Type
AssistantMcpElicitationController
Requirement
n/a
DeclarationView source
createAssistantMcpManagerControllerts
declare function createAssistantMcpManagerController(options: {
readonly manager: AssistantMcpManagerLike;
}): AssistantMcpManagerController;
Name
Kind
Type
Requirement
options
parameter
{ readonly manager: AssistantMcpManagerLike; }
required
return
return value
AssistantMcpManagerController
n/a
Name
options
Kind
parameter
Type
{ readonly manager: AssistantMcpManagerLike; }
Requirement
required
Name
return
Kind
return value
Type
AssistantMcpManagerController
Requirement
n/a
DeclarationView source
createAssistantMcpServerControllerts
declare function createAssistantMcpServerController(options: {
readonly manager: AssistantMcpManagerLike;
readonly serverId: string;
}): AssistantMcpServerController;
Name
Kind
Type
Requirement
options
parameter
{ readonly manager: AssistantMcpManagerLike; readonly serverId: string; }
required
return
return value
AssistantMcpServerController
n/a
Name
options
Kind
parameter
Type
{ readonly manager: AssistantMcpManagerLike; readonly serverId: string; }
Requirement
required
Name
return
Kind
return value
Type
AssistantMcpServerController
Requirement
n/a
DeclarationView source
createAutosizeControllerts
declare function createAutosizeController(element: HTMLTextAreaElement, options?: AutosizeOptions): AutosizeController;
Name
Kind
Type
Requirement
element
parameter
HTMLTextAreaElement
required
options
parameter
AutosizeOptions
optional
return
return value
AutosizeController
n/a
Name
element
Kind
parameter
Type
HTMLTextAreaElement
Requirement
required
Name
options
Kind
parameter
Type
AutosizeOptions
Requirement
optional
Name
return
Kind
return value
Type
AutosizeController
Requirement
n/a

Owns one replaceable chart-data source. Every value is a complete series snapshot; this layer deliberately does not patch, merge, or interpret it.

DeclarationView source
createChartDataSessionts
declare function createChartDataSession(options?: ChartDataSessionOptions): ChartDataSession;
Name
Kind
Type
Requirement
options
parameter
ChartDataSessionOptions
optional
return
return value
ChartDataSession
n/a
Name
options
Kind
parameter
Type
ChartDataSessionOptions
Requirement
optional
Name
return
Kind
return value
Type
ChartDataSession
Requirement
n/a
DeclarationView source
createClipboardControllerts
declare function createClipboardController(options: {
readonly onCopy: () => string;
readonly onPaste: (text: string) => void;
readonly onCut?: () => string;
}): ClipboardController;
Name
Kind
Type
Requirement
options
parameter
{ readonly onCopy: () => string; readonly onPaste: (text: string) => void; readonly onCut?: () => string; }
required
return
return value
ClipboardController
n/a
Name
options
Kind
parameter
Type
{ readonly onCopy: () => string; readonly onPaste: (text: string) => void; readonly onCut?: () => string; }
Requirement
required
Name
return
Kind
return value
Type
ClipboardController
Requirement
n/a
DeclarationView source
createClipboardManagerts
declare function createClipboardManager(options?: ClipboardManagerOptions): ClipboardManager;
Name
Kind
Type
Requirement
options
parameter
ClipboardManagerOptions
optional
return
return value
ClipboardManager
n/a
Name
options
Kind
parameter
Type
ClipboardManagerOptions
Requirement
optional
Name
return
Kind
return value
Type
ClipboardManager
Requirement
n/a
DeclarationView source
createGenerativeUIRendererts
export declare const createGenerativeUIRenderer: <T = GenerativeUIRenderNode>(options?: GenerativeUIRendererOptions<T>) => GenerativeUIRenderer<T>;
Name
Kind
Type
Requirement
options
parameter
GenerativeUIRendererOptions<T>
optional
return
return value
GenerativeUIRenderer<T>
n/a
Name
options
Kind
parameter
Type
GenerativeUIRendererOptions<T>
Requirement
optional
Name
return
Kind
return value
Type
GenerativeUIRenderer<T>
Requirement
n/a

createGridInput

function
DeclarationView source
createGridInputts
declare function createGridInput<T>(options: GridConnectOptions<T>, remoteSnapshot?: GridRemoteSnapshot<T>): GridInput<T>;
Name
Kind
Type
Requirement
options
parameter
GridConnectOptions<T>
required
remoteSnapshot
parameter
GridRemoteSnapshot<T>
optional
return
return value
GridInput<T>
n/a
Name
options
Kind
parameter
Type
GridConnectOptions<T>
Requirement
required
Name
remoteSnapshot
Kind
parameter
Type
GridRemoteSnapshot<T>
Requirement
optional
Name
return
Kind
return value
Type
GridInput<T>
Requirement
n/a
DeclarationView source
createGridRemoteRowsts
declare function createGridRemoteRows<T>(options: GridRemoteRowsOptions<T>): GridRemoteRows<T>;
Name
Kind
Type
Requirement
options
parameter
GridRemoteRowsOptions<T>
required
return
return value
GridRemoteRows<T>
n/a
Name
options
Kind
parameter
Type
GridRemoteRowsOptions<T>
Requirement
required
Name
return
Kind
return value
Type
GridRemoteRows<T>
Requirement
n/a
DeclarationView source
createGridRowProjectionCachets
declare function createGridRowProjectionCache<T>(): GridRowProjectionCache<T>;
Name
Kind
Type
Requirement
return
return value
GridRowProjectionCache<T>
n/a
Name
return
Kind
return value
Type
GridRowProjectionCache<T>
Requirement
n/a
DeclarationView source
createInputHistoryts
declare function createInputHistory(options?: InputHistoryOptions): InputHistory;
Name
Kind
Type
Requirement
options
parameter
InputHistoryOptions
optional
return
return value
InputHistory
n/a
Name
options
Kind
parameter
Type
InputHistoryOptions
Requirement
optional
Name
return
Kind
return value
Type
InputHistory
Requirement
n/a
DeclarationView source
createMcpAppFramets
export declare const createMcpAppFrame: (options: McpAppFrameOptions) => McpAppFrame;
Name
Kind
Type
Requirement
options
parameter
McpAppFrameOptions
required
return
return value
McpAppFrame
n/a
Name
options
Kind
parameter
Type
McpAppFrameOptions
Requirement
required
Name
return
Kind
return value
Type
McpAppFrame
Requirement
n/a
DeclarationView source
createMediaCapturets
declare function createMediaCapture(options?: MediaCaptureOptions): Promise<MediaCapture>;
Name
Kind
Type
Requirement
options
parameter
MediaCaptureOptions
optional
return
return value
Promise<MediaCapture>
n/a
Name
options
Kind
parameter
Type
MediaCaptureOptions
Requirement
optional
Name
return
Kind
return value
Type
Promise<MediaCapture>
Requirement
n/a
DeclarationView source
createMountedServicets
declare function createMountedService<Input, Value extends StateValue, Context, Event extends EventObject, Command extends CommandObject, Output>(machine: Machine<Input, Value, Context, Event, Command, Output>, options: MountedServiceOptions<Input, Event, Command>): {
readonly service: Service<Input, Value, Context, Event, Command, Output>;
detach(): void;
};
Name
Kind
Type
Requirement
machine
parameter
Machine<Input, Value, Context, Event, Command, Output>
required
options
parameter
MountedServiceOptions<Input, Event, Command>
required
return
return value
{ readonly service: Service<Input, Value, Context, Event, Command, Output>; detach(): void; }
n/a
Name
machine
Kind
parameter
Type
Machine<Input, Value, Context, Event, Command, Output>
Requirement
required
Name
options
Kind
parameter
Type
MountedServiceOptions<Input, Event, Command>
Requirement
required
Name
return
Kind
return value
Type
{ readonly service: Service<Input, Value, Context, Event, Command, Output>; detach(): void; }
Requirement
n/a
DeclarationView source
createPointerDragControllerts
declare function createPointerDragController(options?: DragControllerOptions & {
readonly threshold?: number;
}): PointerDragController;
Name
Kind
Type
Requirement
options
parameter
DragControllerOptions & { readonly threshold?: number; }
optional
return
return value
PointerDragController
n/a
Name
options
Kind
parameter
Type
DragControllerOptions & { readonly threshold?: number; }
Requirement
optional
Name
return
Kind
return value
Type
PointerDragController
Requirement
n/a
DeclarationView source
createSelectionObserverts
declare function createSelectionObserver(options: SelectionObserverOptions): SelectionObserverApi;
Name
Kind
Type
Requirement
options
parameter
SelectionObserverOptions
required
return
return value
SelectionObserverApi
n/a
Name
options
Kind
parameter
Type
SelectionObserverOptions
Requirement
required
Name
return
Kind
return value
Type
SelectionObserverApi
Requirement
n/a

createSmoothText

function
DeclarationView source
createSmoothTextts
declare function createSmoothText(scheduler: SmoothTextScheduler, options?: SmoothTextOptions): {
push(value: string): void;
flush(): void;
getText(): string;
destroy(): void;
};
Name
Kind
Type
Requirement
scheduler
parameter
SmoothTextScheduler
required
options
parameter
SmoothTextOptions
optional
return
return value
{ push(value: string): void; flush(): void; getText(): string; destroy(): void; }
n/a
Name
scheduler
Kind
parameter
Type
SmoothTextScheduler
Requirement
required
Name
options
Kind
parameter
Type
SmoothTextOptions
Requirement
optional
Name
return
Kind
return value
Type
{ push(value: string): void; flush(): void; getText(): string; destroy(): void; }
Requirement
n/a
DeclarationView source
createThreadViewportStorets
declare function createThreadViewportStore(initial?: Partial<ThreadViewportState>): ThreadViewportStore;
Name
Kind
Type
Requirement
initial
parameter
Partial<ThreadViewportState>
optional
return
return value
ThreadViewportStore
n/a
Name
initial
Kind
parameter
Type
Partial<ThreadViewportState>
Requirement
optional
Name
return
Kind
return value
Type
ThreadViewportStore
Requirement
n/a
DeclarationView source
createToolUIResolverts
export declare const createToolUIResolver: <TResult = unknown, TPart = unknown>(defaults?: Omit<ToolUIResolverOptions<TResult, TPart>, "part" | "toolName" | "name">) => {
resolve: (options: Pick<ToolUIResolverOptions<TResult, TPart>, "part" | "toolName" | "name">) => string | TResult | null;
};
Name
Kind
Type
Requirement
defaults
parameter
Omit<ToolUIResolverOptions<TResult, TPart>, "part" | "toolName" | "name">
optional
return
return value
{ resolve: (options: Pick<ToolUIResolverOptions<TResult, TPart>, "part" | "toolName" | "name">) => string | TResult | null; }
n/a
Name
defaults
Kind
parameter
Type
Omit<ToolUIResolverOptions<TResult, TPart>, "part" | "toolName" | "name">
Requirement
optional
Name
return
Kind
return value
Type
{ resolve: (options: Pick<ToolUIResolverOptions<TResult, TPart>, "part" | "toolName" | "name">) => string | TResult | null; }
Requirement
n/a
DeclarationView source
createTriggerPopoverRegistryts
declare function createTriggerPopoverRegistry(options: TriggerPopoverRegistryOptions): TriggerPopoverRegistry;
Name
Kind
Type
Requirement
options
parameter
TriggerPopoverRegistryOptions
required
return
return value
TriggerPopoverRegistry
n/a
Name
options
Kind
parameter
Type
TriggerPopoverRegistryOptions
Requirement
required
Name
return
Kind
return value
Type
TriggerPopoverRegistry
Requirement
n/a
DeclarationView source
createTurnAnchorControllerts
declare function createTurnAnchorController(messageScroller?: Pick<MessageScrollerController, "scrollToMessage">): TurnAnchorController;
Name
Kind
Type
Requirement
messageScroller
parameter
Pick<MessageScrollerController, "scrollToMessage">
optional
return
return value
TurnAnchorController
n/a
Name
messageScroller
Kind
parameter
Type
Pick<MessageScrollerController, "scrollToMessage">
Requirement
optional
Name
return
Kind
return value
Type
TurnAnchorController
Requirement
n/a
DeclarationView source
createVirtualizerts
declare function createVirtualizer(options: VirtualizerOptions): Virtualizer;
Name
Kind
Type
Requirement
options
parameter
VirtualizerOptions
required
return
return value
Virtualizer
n/a
Name
options
Kind
parameter
Type
VirtualizerOptions
Requirement
required
Name
return
Kind
return value
Type
Virtualizer
Requirement
n/a
DeclarationView source
createVisibleRegionControllerts
declare function createVisibleRegionController(root: VisibleRegionElement, options?: VisibleRegionOptions): VisibleRegionController;
Name
Kind
Type
Requirement
root
parameter
VisibleRegionElement
required
options
parameter
VisibleRegionOptions
optional
return
return value
VisibleRegionController
n/a
Name
root
Kind
parameter
Type
VisibleRegionElement
Requirement
required
Name
options
Kind
parameter
Type
VisibleRegionOptions
Requirement
optional
Name
return
Kind
return value
Type
VisibleRegionController
Requirement
n/a
DeclarationView source
DataRenderContextts
type DataRenderContext<TData = unknown> = {
readonly name: string;
readonly data: TData;
};
Name
Kind
Type
Requirement
data
property
TData
required
name
property
string
required
Name
data
Kind
property
Type
TData
Requirement
required
Name
name
Kind
property
Type
string
Requirement
required
DeclarationView source
DataRendererts
type DataRenderer<TResult, TData = unknown> = TResult | null | undefined | ((context: DataRenderContext<TData>) => unknown);
DeclarationView source
DataUIResolverOptionsts
type DataUIResolverOptions<TResult = unknown, TData = unknown> = {
readonly name: string;
readonly data: TData;
readonly by_name?: Readonly<Record<string, DataRenderer<TResult, TData>>>;
readonly byName?: Readonly<Record<string, DataRenderer<TResult, TData>>>;
readonly Fallback?: DataRenderer<TResult, TData>;
readonly fallback?: DataRenderer<TResult, TData>;
};
Name
Kind
Type
Requirement
by_name
property
Readonly<Record<string, DataRenderer<TResult, TData>>>
optional
byName
property
Readonly<Record<string, DataRenderer<TResult, TData>>>
optional
data
property
TData
required
fallback
property
DataRenderer<TResult, TData>
optional
Fallback
property
DataRenderer<TResult, TData>
optional
name
property
string
required
Name
by_name
Kind
property
Type
Readonly<Record<string, DataRenderer<TResult, TData>>>
Requirement
optional
Name
byName
Kind
property
Type
Readonly<Record<string, DataRenderer<TResult, TData>>>
Requirement
optional
Name
data
Kind
property
Type
TData
Requirement
required
Name
fallback
Kind
property
Type
DataRenderer<TResult, TData>
Requirement
optional
Name
Fallback
Kind
property
Type
DataRenderer<TResult, TData>
Requirement
optional
Name
name
Kind
property
Type
string
Requirement
required

Directive

interface
DeclarationView source
Directivets
interface Directive {
readonly type: string;
readonly label: string;
readonly name: string;
}
Name
Kind
Type
Requirement
label
property
string
required
name
property
string
required
type
property
string
required
Name
label
Kind
property
Type
string
Requirement
required
Name
name
Kind
property
Type
string
Requirement
required
Name
type
Kind
property
Type
string
Requirement
required
DeclarationView source
DragControllerOptionsts
interface DragControllerOptions {
readonly onStart?: (state: DragControllerState) => void;
readonly onMove?: (state: DragControllerState) => void;
readonly onEnd?: (state: DragControllerState) => void;
readonly onCancel?: (state: DragControllerState) => void;
}
Name
Kind
Type
Requirement
onCancel
property
(state: DragControllerState) => void
optional
onEnd
property
(state: DragControllerState) => void
optional
onMove
property
(state: DragControllerState) => void
optional
onStart
property
(state: DragControllerState) => void
optional
Name
onCancel
Kind
property
Type
(state: DragControllerState) => void
Requirement
optional
Name
onEnd
Kind
property
Type
(state: DragControllerState) => void
Requirement
optional
Name
onMove
Kind
property
Type
(state: DragControllerState) => void
Requirement
optional
Name
onStart
Kind
property
Type
(state: DragControllerState) => void
Requirement
optional

DragPhase

type
DeclarationView source
DragPhasets
type DragPhase = "idle" | "start" | "move" | "end" | "cancel";
DeclarationView source
EDIT_ID_ATTRIBUTEts
export declare const EDIT_ID_ATTRIBUTE: "data-edit-id";
DeclarationView source
EDITOR_MARK_TYPESts
export declare const EDITOR_MARK_TYPES: readonly ["bold", "italic", "code", "strike", "link"];
DeclarationView source
EDITOR_NODE_TYPESts
export declare const EDITOR_NODE_TYPES: readonly ["doc", "paragraph", "heading", "list", "listItem", "blockquote", "codeBlock", "hr", "image", "text", "hardBreak"];

EditorBridgeNode

interface
DeclarationView source
EditorBridgeNodets
interface EditorBridgeNode {
readonly type: string;
readonly attrs?: Readonly<Record<string, unknown>>;
readonly marks?: readonly {
readonly type: string;
readonly attrs?: Readonly<Record<string, unknown>>;
}[];
readonly text?: string;
readonly children?: readonly EditorBridgeNode[];
}
Name
Kind
Type
Requirement
attrs
property
Readonly<Record<string, unknown>>
optional
children
property
readonly EditorBridgeNode[]
optional
marks
property
readonly { readonly type: string; readonly attrs?: Readonly<Record<string, unknown>>; }[]
optional
text
property
string
optional
type
property
string
required
Name
attrs
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
optional
Name
children
Kind
property
Type
readonly EditorBridgeNode[]
Requirement
optional
Name
marks
Kind
property
Type
readonly { readonly type: string; readonly attrs?: Readonly<Record<string, unknown>>; }[]
Requirement
optional
Name
text
Kind
property
Type
string
Requirement
optional
Name
type
Kind
property
Type
string
Requirement
required

editorNodesToAst

function
DeclarationView source
editorNodesToAstts
declare function editorNodesToAst(nodes: readonly EditorBridgeNode[]): MarkdownDocument;
Name
Kind
Type
Requirement
nodes
parameter
readonly EditorBridgeNode[]
required
return
return value
MarkdownDocument
n/a
Name
nodes
Kind
parameter
Type
readonly EditorBridgeNode[]
Requirement
required
Name
return
Kind
return value
Type
MarkdownDocument
Requirement
n/a

exportGridCSV

function
DeclarationView source
exportGridCSVts
declare function exportGridCSV<T>(projection: GridRowProjection<T>, columnDefs: readonly GridColumnDef<T>[], options?: {
readonly includeHeader?: boolean;
readonly delimiter?: string;
}): string;
Name
Kind
Type
Requirement
projection
parameter
GridRowProjection<T>
required
columnDefs
parameter
readonly GridColumnDef<T>[]
required
options
parameter
{ readonly includeHeader?: boolean; readonly delimiter?: string; }
optional
return
return value
string
n/a
Name
projection
Kind
parameter
Type
GridRowProjection<T>
Requirement
required
Name
columnDefs
Kind
parameter
Type
readonly GridColumnDef<T>[]
Requirement
required
Name
options
Kind
parameter
Type
{ readonly includeHeader?: boolean; readonly delimiter?: string; }
Requirement
optional
Name
return
Kind
return value
Type
string
Requirement
n/a

fnv1a32

function

FNV-1a 32-bit, used deliberately instead of a dependency for stable ids.

DeclarationView source
fnv1a32ts
declare function fnv1a32(value: string): string;
Name
Kind
Type
Requirement
value
parameter
string
required
return
return value
string
n/a
Name
value
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
string
Requirement
n/a

formatDirective

function
DeclarationView source
formatDirectivets
declare function formatDirective(directive: Directive): string;
Name
Kind
Type
Requirement
directive
parameter
Directive
required
return
return value
string
n/a
Name
directive
Kind
parameter
Type
Directive
Requirement
required
Name
return
Kind
return value
Type
string
Requirement
n/a
DeclarationView source
formatDirectiveTextts
declare function formatDirectiveText(type: string, label: string, name: string): string;
Name
Kind
Type
Requirement
type
parameter
string
required
label
parameter
string
required
name
parameter
string
required
return
return value
string
n/a
Name
type
Kind
parameter
Type
string
Requirement
required
Name
label
Kind
parameter
Type
string
Requirement
required
Name
name
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
string
Requirement
n/a
DeclarationView source
GenerativeUIComponentMapts
type GenerativeUIComponentMap<T> = Readonly<Record<string, GenerativeUIComponentRenderer<T>>>;
DeclarationView source
GenerativeUIComponentRendererts
type GenerativeUIComponentRenderer<T> = (input: {
readonly component: string;
readonly props: Readonly<Record<string, unknown>>;
readonly children: readonly T[];
readonly node: GenerativeUIInputNode;
}) => T;
DeclarationView source
GenerativeUIInputNodets
type GenerativeUIInputNode = {
readonly component?: string;
readonly $type?: string;
readonly type?: string;
readonly props?: Readonly<Record<string, unknown>>;
readonly children?: readonly unknown[];
readonly key?: string;
readonly $key?: string;
readonly $action?: string;
readonly $status?: string;
readonly $input?: unknown;
};
Name
Kind
Type
Requirement
$action
property
string
optional
$input
property
unknown
optional
$key
property
string
optional
$status
property
string
optional
$type
property
string
optional
children
property
readonly unknown[]
optional
component
property
string
optional
key
property
string
optional
props
property
Readonly<Record<string, unknown>>
optional
type
property
string
optional
Name
$action
Kind
property
Type
string
Requirement
optional
Name
$input
Kind
property
Type
unknown
Requirement
optional
Name
$key
Kind
property
Type
string
Requirement
optional
Name
$status
Kind
property
Type
string
Requirement
optional
Name
$type
Kind
property
Type
string
Requirement
optional
Name
children
Kind
property
Type
readonly unknown[]
Requirement
optional
Name
component
Kind
property
Type
string
Requirement
optional
Name
key
Kind
property
Type
string
Requirement
optional
Name
props
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
optional
Name
type
Kind
property
Type
string
Requirement
optional
DeclarationView source
GenerativeUIRendererts
declare class GenerativeUIRenderer<T = GenerativeUIRenderNode> {
private readonly options;
constructor(options?: GenerativeUIRendererOptions<T>);
render(spec: unknown): T | readonly T[];
private renderValue;
private renderNode;
private renderFallback;
}
Name
Kind
Type
Requirement
options
property
any
required
render
method
(spec: unknown) => T | readonly T[]
required
renderFallback
property
any
required
renderNode
property
any
required
renderValue
property
any
required
Name
options
Kind
property
Type
any
Requirement
required
Name
render
Kind
method
Type
(spec: unknown) => T | readonly T[]
Requirement
required
Name
renderFallback
Kind
property
Type
any
Requirement
required
Name
renderNode
Kind
property
Type
any
Requirement
required
Name
renderValue
Kind
property
Type
any
Requirement
required
DeclarationView source
GenerativeUIRendererOptionsts
type GenerativeUIRendererOptions<T = GenerativeUIRenderNode> = {
readonly components?: GenerativeUIComponentMap<T>;
readonly fallback?: GenerativeUIComponentRenderer<T>;
readonly unknown?: GenerativeUIUnknownMode;
};
Name
Kind
Type
Requirement
components
property
GenerativeUIComponentMap<T>
optional
fallback
property
GenerativeUIComponentRenderer<T>
optional
unknown
property
GenerativeUIUnknownMode
optional
Name
components
Kind
property
Type
GenerativeUIComponentMap<T>
Requirement
optional
Name
fallback
Kind
property
Type
GenerativeUIComponentRenderer<T>
Requirement
optional
Name
unknown
Kind
property
Type
GenerativeUIUnknownMode
Requirement
optional
DeclarationView source
GenerativeUIRenderNodets
type GenerativeUIRenderNode = {
readonly component: string;
readonly props: Readonly<Record<string, unknown>>;
readonly children: readonly GenerativeUIRenderNode[];
};
Name
Kind
Type
Requirement
children
property
readonly GenerativeUIRenderNode[]
required
component
property
string
required
props
property
Readonly<Record<string, unknown>>
required
Name
children
Kind
property
Type
readonly GenerativeUIRenderNode[]
Requirement
required
Name
component
Kind
property
Type
string
Requirement
required
Name
props
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
required
DeclarationView source
GenerativeUIUnknownModets
type GenerativeUIUnknownMode = "fallback" | "throw";

getBlockById

function
DeclarationView source
getBlockByIdts
declare function getBlockById(document: MarkdownDocument, id: string): BlockNode | undefined;
Name
Kind
Type
Requirement
document
parameter
MarkdownDocument
required
id
parameter
string
required
return
return value
BlockNode | undefined
n/a
Name
document
Kind
parameter
Type
MarkdownDocument
Requirement
required
Name
id
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
BlockNode | undefined
Requirement
n/a

getBlocksByType

function
DeclarationView source
getBlocksByTypets
declare function getBlocksByType(document: MarkdownDocument, type: BlockNode["type"]): readonly BlockNode[];
Name
Kind
Type
Requirement
document
parameter
MarkdownDocument
required
type
parameter
BlockNode["type"]
required
return
return value
readonly BlockNode[]
n/a
Name
document
Kind
parameter
Type
MarkdownDocument
Requirement
required
Name
type
Kind
parameter
Type
BlockNode["type"]
Requirement
required
Name
return
Kind
return value
Type
readonly BlockNode[]
Requirement
n/a
DeclarationView source
getFootnoteDefinitionts
declare function getFootnoteDefinition(document: MarkdownDocument, identifier: string): BlockNode | undefined;
Name
Kind
Type
Requirement
document
parameter
MarkdownDocument
required
identifier
parameter
string
required
return
return value
BlockNode | undefined
n/a
Name
document
Kind
parameter
Type
MarkdownDocument
Requirement
required
Name
identifier
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
BlockNode | undefined
Requirement
n/a
DeclarationView source
GRID_ROW_HEIGHTts
export declare const GRID_ROW_HEIGHT: 44;
DeclarationView source
GRID_SELECTION_COLUMN_WIDTHts
export declare const GRID_SELECTION_COLUMN_WIDTH: 44;
DeclarationView source
GRID_VIEWPORT_HEIGHTts
export declare const GRID_VIEWPORT_HEIGHT: 352;

gridAnatomy

value
DeclarationView source
gridAnatomyts
export declare const gridAnatomy: {
readonly scope: "grid";
readonly parts: readonly ["root", "scroller", "content", "header", "header-row", "header-cell", "column-resize-handle", "column-menu-trigger", "body", "row", "group-row", "group-toggle", "cell", "cell-editor", "select-all", "row-checkbox", "quick-filter-input", "column-filter-panel", "overlay", "live-region"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "scroller", "content", "header", "header-row", "header-cell", "column-resize-handle", "column-menu-trigger", "body", "row", "group-row", "group-toggle", "cell", "cell-editor", "select-all", "row-checkbox", "quick-filter-input", "column-filter-panel", "overlay", "live-region"]
required
scope
property
"grid"
required
Name
parts
Kind
property
Type
readonly ["root", "scroller", "content", "header", "header-row", "header-cell", "column-resize-handle", "column-menu-trigger", "body", "row", "group-row", "group-toggle", "cell", "cell-editor", "select-all", "row-checkbox", "quick-filter-input", "column-filter-panel", "overlay", "live-region"]
Requirement
required
Name
scope
Kind
property
Type
"grid"
Requirement
required

GridApi

interface
DeclarationView source
GridApits
interface GridApi<T = unknown> {
rootProps(): PartProps;
scrollerProps(): PartProps;
contentProps(): PartProps;
headerProps(): PartProps;
headerRowProps(): PartProps;
selectionHeaderProps(): PartProps;
headerCellProps(columnKey: string): PartProps;
columnResizeHandleProps(columnKey: string): PartProps;
columnMenuTriggerProps(columnKey: string): PartProps;
bodyProps(): PartProps;
rowProps(rowId: string, index: number): PartProps;
groupRowProps(groupKey: string, index: number): PartProps;
groupToggleProps(groupKey: string): PartProps;
selectionCellProps(rowId: string): PartProps;
cellProps(rowId: string, columnKey: string, columnIndex: number): PartProps;
cellEditorProps(rowId: string, columnKey: string): PartProps;
selectAllProps(): PartProps;
rowCheckboxProps(rowId: string): PartProps;
quickFilterInputProps(): PartProps;
columnFilterPanelProps(columnKey: string): PartProps;
overlayProps(kind: "loading" | "empty" | "error"): PartProps;
liveRegionProps(): PartProps;
columnDefs: readonly GridColumnDef<T>[];
columnProjection(): GridColumnProjection<T>;
projection(): GridRowProjection<T>;
rowIdDiagnostics(): readonly DiagnosticObject[];
readonly selectionMode: SelectionMode;
readonly selectedIds: readonly string[];
}
Name
Kind
Type
Requirement
bodyProps
method
() => PartProps
required
cellEditorProps
method
(rowId: string, columnKey: string) => PartProps
required
cellProps
method
(rowId: string, columnKey: string, columnIndex: number) => PartProps
required
columnDefs
property
readonly GridColumnDef<T>[]
required
columnFilterPanelProps
method
(columnKey: string) => PartProps
required
columnMenuTriggerProps
method
(columnKey: string) => PartProps
required
columnProjection
method
() => GridColumnProjection<T>
required
columnResizeHandleProps
method
(columnKey: string) => PartProps
required
contentProps
method
() => PartProps
required
groupRowProps
method
(groupKey: string, index: number) => PartProps
required
groupToggleProps
method
(groupKey: string) => PartProps
required
headerCellProps
method
(columnKey: string) => PartProps
required
headerProps
method
() => PartProps
required
headerRowProps
method
() => PartProps
required
Name
bodyProps
Kind
method
Type
() => PartProps
Requirement
required
Name
cellEditorProps
Kind
method
Type
(rowId: string, columnKey: string) => PartProps
Requirement
required
Name
cellProps
Kind
method
Type
(rowId: string, columnKey: string, columnIndex: number) => PartProps
Requirement
required
Name
columnDefs
Kind
property
Type
readonly GridColumnDef<T>[]
Requirement
required
Name
columnFilterPanelProps
Kind
method
Type
(columnKey: string) => PartProps
Requirement
required
Name
columnMenuTriggerProps
Kind
method
Type
(columnKey: string) => PartProps
Requirement
required
Name
columnProjection
Kind
method
Type
() => GridColumnProjection<T>
Requirement
required
Name
columnResizeHandleProps
Kind
method
Type
(columnKey: string) => PartProps
Requirement
required
Name
contentProps
Kind
method
Type
() => PartProps
Requirement
required
Name
groupRowProps
Kind
method
Type
(groupKey: string, index: number) => PartProps
Requirement
required
Name
groupToggleProps
Kind
method
Type
(groupKey: string) => PartProps
Requirement
required
Name
headerCellProps
Kind
method
Type
(columnKey: string) => PartProps
Requirement
required
Name
headerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
headerRowProps
Kind
method
Type
() => PartProps
Requirement
required
Name
liveRegionProps
Kind
method
Type
() => PartProps
Requirement
required
Name
overlayProps
Kind
method
Type
(kind: "loading" | "empty" | "error") => PartProps
Requirement
required
Name
projection
Kind
method
Type
() => GridRowProjection<T>
Requirement
required
Name
quickFilterInputProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rowCheckboxProps
Kind
method
Type
(rowId: string) => PartProps
Requirement
required
Name
rowIdDiagnostics
Kind
method
Type
() => readonly DiagnosticObject[]
Requirement
required
Name
rowProps
Kind
method
Type
(rowId: string, index: number) => PartProps
Requirement
required
Name
scrollerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
selectAllProps
Kind
method
Type
() => PartProps
Requirement
required
Name
selectedIds
Kind
property
Type
readonly string[]
Requirement
required
Name
selectionCellProps
Kind
method
Type
(rowId: string) => PartProps
Requirement
required
Name
selectionHeaderProps
Kind
method
Type
() => PartProps
Requirement
required
Name
selectionMode
Kind
property
Type
SelectionMode
Requirement
required

gridCellParams

function
DeclarationView source
gridCellParamsts
declare function gridCellParams<T>(service: GridService<T>, options: GridConnectOptions<T>, row: T, rowId: string, column: GridColumnDef<T>): GridCellParams<T>;
Name
Kind
Type
Requirement
service
parameter
GridService<T>
required
options
parameter
GridConnectOptions<T>
required
row
parameter
T
required
rowId
parameter
string
required
column
parameter
GridColumnDef<T>
required
return
return value
GridCellParams<T>
n/a
Name
service
Kind
parameter
Type
GridService<T>
Requirement
required
Name
options
Kind
parameter
Type
GridConnectOptions<T>
Requirement
required
Name
row
Kind
parameter
Type
T
Requirement
required
Name
rowId
Kind
parameter
Type
string
Requirement
required
Name
column
Kind
parameter
Type
GridColumnDef<T>
Requirement
required
Name
return
Kind
return value
Type
GridCellParams<T>
Requirement
n/a
DeclarationView source
GridCellValidationts
type GridCellValidation = boolean | {
readonly valid: boolean;
readonly message?: string;
};
DeclarationView source
GridColumnProjectionts
type GridColumnProjection<T = unknown> = {
readonly columns: readonly GridColumnDef<T>[];
readonly widths: Readonly<Record<string, number>>;
readonly pinnedOffsets: Readonly<Record<string, number>>;
readonly gridTemplateColumns: string;
};
Name
Kind
Type
Requirement
columns
property
readonly GridColumnDef<T>[]
required
gridTemplateColumns
property
string
required
pinnedOffsets
property
Readonly<Record<string, number>>
required
widths
property
Readonly<Record<string, number>>
required
Name
columns
Kind
property
Type
readonly GridColumnDef<T>[]
Requirement
required
Name
gridTemplateColumns
Kind
property
Type
string
Requirement
required
Name
pinnedOffsets
Kind
property
Type
Readonly<Record<string, number>>
Requirement
required
Name
widths
Kind
property
Type
Readonly<Record<string, number>>
Requirement
required
DeclarationView source
GridConnectOptionsts
type GridConnectOptions<T = unknown> = GridCommonOptions<T> & GridRowsInput<T>;
DeclarationView source
GridDataSourcets
type GridDataSource<T> = (query: GridRemoteQuery, tools: {
readonly signal: AbortSignal;
}) => PromiseLike<{
readonly rows: readonly T[];
readonly total?: number;
readonly nextCursor?: import("@grassroot/statechart").JsonValue | null;
}>;
DeclarationView source
GridEditCommitDetailts
interface GridEditCommitDetail<T = unknown> {
readonly rowId: string;
readonly colKey: string;
readonly value: unknown;
readonly previousValue: unknown;
readonly reason: string;
readonly row?: T;
readonly column?: GridColumnDef<T>;
}
Name
Kind
Type
Requirement
colKey
property
string
required
column
property
GridColumnDef<T>
optional
previousValue
property
unknown
required
reason
property
string
required
row
property
T
optional
rowId
property
string
required
value
property
unknown
required
Name
colKey
Kind
property
Type
string
Requirement
required
Name
column
Kind
property
Type
GridColumnDef<T>
Requirement
optional
Name
previousValue
Kind
property
Type
unknown
Requirement
required
Name
reason
Kind
property
Type
string
Requirement
required
Name
row
Kind
property
Type
T
Requirement
optional
Name
rowId
Kind
property
Type
string
Requirement
required
Name
value
Kind
property
Type
unknown
Requirement
required

GridGroup

type
DeclarationView source
GridGroupts
type GridGroup<T> = {
readonly key: string;
readonly level: number;
readonly ids: readonly string[];
readonly rows: readonly T[];
};
Name
Kind
Type
Requirement
ids
property
readonly string[]
required
key
property
string
required
level
property
number
required
rows
property
readonly T[]
required
Name
ids
Kind
property
Type
readonly string[]
Requirement
required
Name
key
Kind
property
Type
string
Requirement
required
Name
level
Kind
property
Type
number
Requirement
required
Name
rows
Kind
property
Type
readonly T[]
Requirement
required

GridMount

interface
DeclarationView source
GridMountts
interface GridMount<T> {
destroy(): void;
service: ReturnType<typeof createService>;
api: GridApi<T>;
remote?: GridRemoteRows<T>;
}
Name
Kind
Type
Requirement
api
property
GridApi<T>
required
destroy
method
() => void
required
remote
property
GridRemoteRows<T>
optional
service
property
ReturnType<typeof createService>
required
Name
api
Kind
property
Type
GridApi<T>
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
remote
Kind
property
Type
GridRemoteRows<T>
Requirement
optional
Name
service
Kind
property
Type
ReturnType<typeof createService>
Requirement
required

GridPart

type
DeclarationView source
GridPartts
type GridPart = (typeof parts)[number];

gridProjection

function
DeclarationView source
gridProjectionts
declare function gridProjection<T>(service: GridService<T>, options: GridConnectOptions<T>, remoteSnapshot?: GridRemoteSnapshot<T> | (() => GridRemoteSnapshot<T>)): GridRowProjection<T>;
Name
Kind
Type
Requirement
service
parameter
GridService<T>
required
options
parameter
GridConnectOptions<T>
required
remoteSnapshot
parameter
GridRemoteSnapshot<T> | (() => GridRemoteSnapshot<T>)
optional
return
return value
GridRowProjection<T>
n/a
Name
service
Kind
parameter
Type
GridService<T>
Requirement
required
Name
options
Kind
parameter
Type
GridConnectOptions<T>
Requirement
required
Name
remoteSnapshot
Kind
parameter
Type
GridRemoteSnapshot<T> | (() => GridRemoteSnapshot<T>)
Requirement
optional
Name
return
Kind
return value
Type
GridRowProjection<T>
Requirement
n/a
DeclarationView source
GridRemoteRowsts
type GridRemoteRows<T> = {
readonly getSnapshot: () => GridRemoteSnapshot<T>;
readonly subscribe: (listener: () => void) => () => void;
readonly begin: (request: GridRemoteQuery) => boolean;
readonly handleCommand: (command: GridRemoteCommand) => boolean;
readonly covers: (range: {
readonly start: number;
readonly end: number;
}) => boolean;
readonly nextAppendRequest: () => GridRemoteQuery | null;
readonly selectWindow: (range: {
readonly start: number;
readonly end: number;
}) => void;
readonly destroy: () => void;
};
Name
Kind
Type
Requirement
begin
property
(request: GridRemoteQuery) => boolean
required
covers
property
(range: { readonly start: number; readonly end: number; }) => boolean
required
destroy
property
() => void
required
getSnapshot
property
() => GridRemoteSnapshot<T>
required
handleCommand
property
(command: GridRemoteCommand) => boolean
required
nextAppendRequest
property
() => GridRemoteQuery | null
required
selectWindow
property
(range: { readonly start: number; readonly end: number; }) => void
required
subscribe
property
(listener: () => void) => () => void
required
Name
begin
Kind
property
Type
(request: GridRemoteQuery) => boolean
Requirement
required
Name
covers
Kind
property
Type
(range: { readonly start: number; readonly end: number; }) => boolean
Requirement
required
Name
destroy
Kind
property
Type
() => void
Requirement
required
Name
getSnapshot
Kind
property
Type
() => GridRemoteSnapshot<T>
Requirement
required
Name
handleCommand
Kind
property
Type
(command: GridRemoteCommand) => boolean
Requirement
required
Name
nextAppendRequest
Kind
property
Type
() => GridRemoteQuery | null
Requirement
required
Name
selectWindow
Kind
property
Type
(range: { readonly start: number; readonly end: number; }) => void
Requirement
required
Name
subscribe
Kind
property
Type
(listener: () => void) => () => void
Requirement
required
DeclarationView source
GridRemoteRowsOptionsts
type GridRemoteRowsOptions<T> = {
readonly rowModel: "server" | "infinite";
readonly getRowId: (row: T, absoluteIndex: number) => string;
readonly blockSize?: number;
readonly initialRows?: readonly T[];
readonly initialTotal?: number;
readonly onDiagnostic?: (diagnostic: DiagnosticObject) => void;
};
Name
Kind
Type
Requirement
blockSize
property
number
optional
getRowId
property
(row: T, absoluteIndex: number) => string
required
initialRows
property
readonly T[]
optional
initialTotal
property
number
optional
onDiagnostic
property
(diagnostic: DiagnosticObject) => void
optional
rowModel
property
"server" | "infinite"
required
Name
blockSize
Kind
property
Type
number
Requirement
optional
Name
getRowId
Kind
property
Type
(row: T, absoluteIndex: number) => string
Requirement
required
Name
initialRows
Kind
property
Type
readonly T[]
Requirement
optional
Name
initialTotal
Kind
property
Type
number
Requirement
optional
Name
onDiagnostic
Kind
property
Type
(diagnostic: DiagnosticObject) => void
Requirement
optional
Name
rowModel
Kind
property
Type
"server" | "infinite"
Requirement
required
DeclarationView source
GridRemoteSnapshotts
type GridRemoteSnapshot<T> = {
readonly rows: readonly T[];
/** Absolute index represented by rows[0] for a server virtual window. */
readonly baseIndex?: number;
readonly total?: number;
readonly nextCursor?: import("@grassroot/statechart").JsonValue | null;
readonly status: GridRemoteStatus;
readonly error?: unknown;
readonly loadedRanges: readonly {
readonly start: number;
readonly end: number;
}[];
readonly lastRequest?: GridRemoteQuery;
};
Name
Kind
Type
Requirement
Description
baseIndex
property
number
optional
Absolute index represented by rows[0] for a server virtual window.
error
property
unknown
optional
lastRequest
property
GridRemoteQuery
optional
loadedRanges
property
readonly { readonly start: number; readonly end: number; }[]
required
nextCursor
property
import("@grassroot/statechart").JsonValue | null
optional
rows
property
readonly T[]
required
status
property
GridRemoteStatus
required
total
property
number
optional
Name
baseIndex
Kind
property
Type
number
Requirement
optional
Description
Absolute index represented by rows[0] for a server virtual window.
Name
error
Kind
property
Type
unknown
Requirement
optional
Description
Name
lastRequest
Kind
property
Type
GridRemoteQuery
Requirement
optional
Description
Name
loadedRanges
Kind
property
Type
readonly { readonly start: number; readonly end: number; }[]
Requirement
required
Description
Name
nextCursor
Kind
property
Type
import("@grassroot/statechart").JsonValue | null
Requirement
optional
Description
Name
rows
Kind
property
Type
readonly T[]
Requirement
required
Description
Name
status
Kind
property
Type
GridRemoteStatus
Requirement
required
Description
Name
total
Kind
property
Type
number
Requirement
optional
Description
DeclarationView source
GridRemoteStatusts
type GridRemoteStatus = "idle" | "loading" | "refreshing" | "loading-more" | "error";

Turns a real virtual window into the one serializable Grid event adapters may send.

DeclarationView source
gridRemoteWindowEventts
declare function gridRemoteWindowEvent<T>(options: {
readonly rowModel: "server" | "infinite";
readonly mode?: "virtualized" | "paginated";
readonly sidecar: GridRemoteRows<T>;
readonly start: number;
readonly end: number;
readonly loadMoreThreshold?: number;
}): GridEvent | null;
Name
Kind
Type
Requirement
options
parameter
{ readonly rowModel: "server" | "infinite"; readonly mode?: "virtualized" | "paginated"; readonly sidecar: GridRemoteRows<T>; readonly start: number; readonly end: number; readonly loadMoreThreshold?: number; }
required
return
return value
GridEvent | null
n/a
Name
options
Kind
parameter
Type
{ readonly rowModel: "server" | "infinite"; readonly mode?: "virtualized" | "paginated"; readonly sidecar: GridRemoteRows<T>; readonly start: number; readonly end: number; readonly loadMoreThreshold?: number; }
Requirement
required
Name
return
Kind
return value
Type
GridEvent | null
Requirement
n/a
DeclarationView source
GridRowProjectionts
type GridRowProjection<T> = {
readonly orderedIds: readonly string[];
readonly rowsById: ReadonlyMap<string, T>;
readonly groups: readonly GridGroup<T>[];
readonly aggregates: ReadonlyMap<string, Readonly<Record<string, number>>>;
readonly total: number;
/** Absolute index represented by orderedIds[0]; zero for client and infinite rows. */
readonly baseIndex?: number;
readonly rowIndexById?: ReadonlyMap<string, number>;
readonly cache?: GridRowProjectionCache<T>;
};
Name
Kind
Type
Requirement
Description
aggregates
property
ReadonlyMap<string, Readonly<Record<string, number>>>
required
baseIndex
property
number
optional
Absolute index represented by orderedIds[0]; zero for client and infinite rows.
cache
property
GridRowProjectionCache<T>
optional
groups
property
readonly GridGroup<T>[]
required
orderedIds
property
readonly string[]
required
rowIndexById
property
ReadonlyMap<string, number>
optional
rowsById
property
ReadonlyMap<string, T>
required
total
property
number
required
Name
aggregates
Kind
property
Type
ReadonlyMap<string, Readonly<Record<string, number>>>
Requirement
required
Description
Name
baseIndex
Kind
property
Type
number
Requirement
optional
Description
Absolute index represented by orderedIds[0]; zero for client and infinite rows.
Name
cache
Kind
property
Type
GridRowProjectionCache<T>
Requirement
optional
Description
Name
groups
Kind
property
Type
readonly GridGroup<T>[]
Requirement
required
Description
Name
orderedIds
Kind
property
Type
readonly string[]
Requirement
required
Description
Name
rowIndexById
Kind
property
Type
ReadonlyMap<string, number>
Requirement
optional
Description
Name
rowsById
Kind
property
Type
ReadonlyMap<string, T>
Requirement
required
Description
Name
total
Kind
property
Type
number
Requirement
required
Description
DeclarationView source
GridRowProjectionCachets
interface GridRowProjectionCache<T> {
rows?: readonly T[];
model?: GridRowProjectionModel<T>;
projection?: GridRowProjection<T>;
}
Name
Kind
Type
Requirement
model
property
GridRowProjectionModel<T>
optional
projection
property
GridRowProjection<T>
optional
rows
property
readonly T[]
optional
Name
model
Kind
property
Type
GridRowProjectionModel<T>
Requirement
optional
Name
projection
Kind
property
Type
GridRowProjection<T>
Requirement
optional
Name
rows
Kind
property
Type
readonly T[]
Requirement
optional
DeclarationView source
GridRowProjectionModelts
type GridRowProjectionModel<T> = {
readonly filterModel: GridFilterModel;
readonly sortModel: readonly GridSortEntry[];
readonly groupModel: {
readonly groupBy: readonly string[];
readonly expandedGroupKeys: readonly string[];
readonly aggFor?: Readonly<Record<string, "sum" | "avg" | "count" | "min" | "max" | "custom">>;
};
readonly getRowId: (row: T, index: number) => string;
readonly columnDefs: readonly GridColumnDef<T>[];
readonly page?: {
readonly page: number;
readonly pageSize: number;
};
readonly customFilters?: Readonly<Record<string, (row: T, value: unknown) => boolean>>;
};
Name
Kind
Type
Requirement
columnDefs
property
readonly GridColumnDef<T>[]
required
customFilters
property
Readonly<Record<string, (row: T, value: unknown) => boolean>>
optional
filterModel
property
GridFilterModel
required
getRowId
property
(row: T, index: number) => string
required
groupModel
property
{ readonly groupBy: readonly string[]; readonly expandedGroupKeys: readonly string[]; readonly aggFor?: Readonly<Record<string, "sum" | "avg" | "count" | "min" | "max" | "custom">>; }
required
page
property
{ readonly page: number; readonly pageSize: number; }
optional
sortModel
property
readonly GridSortEntry[]
required
Name
columnDefs
Kind
property
Type
readonly GridColumnDef<T>[]
Requirement
required
Name
customFilters
Kind
property
Type
Readonly<Record<string, (row: T, value: unknown) => boolean>>
Requirement
optional
Name
filterModel
Kind
property
Type
GridFilterModel
Requirement
required
Name
getRowId
Kind
property
Type
(row: T, index: number) => string
Requirement
required
Name
groupModel
Kind
property
Type
{ readonly groupBy: readonly string[]; readonly expandedGroupKeys: readonly string[]; readonly aggFor?: Readonly<Record<string, "sum" | "avg" | "count" | "min" | "max" | "custom">>; }
Requirement
required
Name
page
Kind
property
Type
{ readonly page: number; readonly pageSize: number; }
Requirement
optional
Name
sortModel
Kind
property
Type
readonly GridSortEntry[]
Requirement
required
DeclarationView source
GridServicets
type GridService<T = unknown> = Service<GridInput<T>, "ready", GridContext, GridEvent, GridCommand>;

gridValue

function
DeclarationView source
gridValuets
declare function gridValue<T>(row: T, column: GridColumnDef<T>): unknown;
Name
Kind
Type
Requirement
row
parameter
T
required
column
parameter
GridColumnDef<T>
required
return
return value
unknown
n/a
Name
row
Kind
parameter
Type
T
Requirement
required
Name
column
Kind
parameter
Type
GridColumnDef<T>
Requirement
required
Name
return
Kind
return value
Type
unknown
Requirement
n/a
DeclarationView source
hasInteractiveNodests
declare function hasInteractiveNodes(document: MarkdownDocument): boolean;
Name
Kind
Type
Requirement
document
parameter
MarkdownDocument
required
return
return value
boolean
n/a
Name
document
Kind
parameter
Type
MarkdownDocument
Requirement
required
Name
return
Kind
return value
Type
boolean
Requirement
n/a

Highlighters may return their native `content`/`type` shape or the public CodeBlock `text`/`tone` shape. Both are normalised into render tokens.

DeclarationView source
HighlightTokents
type HighlightToken = {
readonly text: string;
readonly tone?: CodeBlockTokenTone;
readonly type?: string;
} | {
readonly content: string;
readonly tone?: CodeBlockTokenTone;
readonly type?: string;
};

InlineNode

type
DeclarationView source
InlineNodets
type InlineNode = {
readonly type: Extract<MarkdownNodeType, "text" | "emphasis" | "strong" | "strikethrough" | "code-span" | "link" | "autolink" | "image" | "footnote-ref" | "hard-break" | "html-blocked">;
readonly raw: string;
readonly position?: Position;
readonly text?: string;
readonly url?: string;
readonly title?: string;
readonly label?: string;
readonly identifier?: string;
readonly children?: readonly InlineNode[];
};
Name
Kind
Type
Requirement
children
property
readonly InlineNode[]
optional
identifier
property
string
optional
label
property
string
optional
position
property
Position
optional
raw
property
string
required
text
property
string
optional
title
property
string
optional
type
property
Extract<MarkdownNodeType, "text" | "emphasis" | "strong" | "strikethrough" | "code-span" | "link" | "autolink" | "image" | "footnote-ref" | "hard-break" | "html-blocked">
required
url
property
string
optional
Name
children
Kind
property
Type
readonly InlineNode[]
Requirement
optional
Name
identifier
Kind
property
Type
string
Requirement
optional
Name
label
Kind
property
Type
string
Requirement
optional
Name
position
Kind
property
Type
Position
Requirement
optional
Name
raw
Kind
property
Type
string
Requirement
required
Name
text
Kind
property
Type
string
Requirement
optional
Name
title
Kind
property
Type
string
Requirement
optional
Name
type
Kind
property
Type
Extract<MarkdownNodeType, "text" | "emphasis" | "strong" | "strikethrough" | "code-span" | "link" | "autolink" | "image" | "footnote-ref" | "hard-break" | "html-blocked">
Requirement
required
Name
url
Kind
property
Type
string
Requirement
optional

InputHistory

interface
DeclarationView source
InputHistoryts
interface InputHistory {
push(value: string): void;
previous(current: string): string;
next(current: string): string;
reset(): void;
readonly entries: readonly string[];
}
Name
Kind
Type
Requirement
entries
property
readonly string[]
required
next
method
(current: string) => string
required
previous
method
(current: string) => string
required
push
method
(value: string) => void
required
reset
method
() => void
required
Name
entries
Kind
property
Type
readonly string[]
Requirement
required
Name
next
Kind
method
Type
(current: string) => string
Requirement
required
Name
previous
Kind
method
Type
(current: string) => string
Requirement
required
Name
push
Kind
method
Type
(value: string) => void
Requirement
required
Name
reset
Kind
method
Type
() => void
Requirement
required
DeclarationView source
InputHistoryOptionsts
interface InputHistoryOptions {
readonly limit?: number;
}
Name
Kind
Type
Requirement
limit
property
number
optional
Name
limit
Kind
property
Type
number
Requirement
optional

listHeadings

function
DeclarationView source
listHeadingsts
declare function listHeadings(document: MarkdownDocument): readonly {
readonly id: string;
readonly level: 1 | 2 | 3 | 4 | 5 | 6;
readonly text: string;
}[];
Name
Kind
Type
Requirement
document
parameter
MarkdownDocument
required
return
return value
readonly { readonly id: string; readonly level: 1 | 2 | 3 | 4 | 5 | 6; readonly text: string; }[]
n/a
Name
document
Kind
parameter
Type
MarkdownDocument
Requirement
required
Name
return
Kind
return value
Type
readonly { readonly id: string; readonly level: 1 | 2 | 3 | 4 | 5 | 6; readonly text: string; }[]
Requirement
n/a
DeclarationView source
makeAssistantDataUIts
export declare const makeAssistantDataUI: <T extends {
readonly name: string;
}>(definition: T) => T;
Name
Kind
Type
Requirement
definition
parameter
T
required
return
return value
T
n/a
Name
definition
Kind
parameter
Type
T
Requirement
required
Name
return
Kind
return value
Type
T
Requirement
n/a
DeclarationView source
makeAssistantToolts
export declare const makeAssistantTool: <T>(definition: T) => T;
Name
Kind
Type
Requirement
definition
parameter
T
required
return
return value
T
n/a
Name
definition
Kind
parameter
Type
T
Requirement
required
Name
return
Kind
return value
Type
T
Requirement
n/a
DeclarationView source
makeAssistantToolUIts
export declare const makeAssistantToolUI: <T extends AssistantToolUIRegistration>(definition: T) => T;
Name
Kind
Type
Requirement
definition
parameter
T
required
return
return value
T
n/a
Name
definition
Kind
parameter
Type
T
Requirement
required
Name
return
Kind
return value
Type
T
Requirement
n/a

Framework-neutral wrapper seam; adapters attach the resulting attributes to their host element.

DeclarationView source
makeAssistantVisiblets
declare function makeAssistantVisible<T>(component: T, _options?: AssistantVisibleOptions): T;
Name
Kind
Type
Requirement
component
parameter
T
required
_options
parameter
AssistantVisibleOptions
optional
return
return value
T
n/a
Name
component
Kind
parameter
Type
T
Requirement
required
Name
_options
Kind
parameter
Type
AssistantVisibleOptions
Requirement
optional
Name
return
Kind
return value
Type
T
Requirement
n/a
DeclarationView source
MarkdownDiagnosticts
type MarkdownDiagnostic = {
readonly code: MarkdownDiagnosticCode;
readonly severity: "warning" | "error";
readonly message: string;
readonly data?: Readonly<Record<string, unknown>>;
readonly position?: Position;
};
Name
Kind
Type
Requirement
code
property
MarkdownDiagnosticCode
required
data
property
Readonly<Record<string, unknown>>
optional
message
property
string
required
position
property
Position
optional
severity
property
"warning" | "error"
required
Name
code
Kind
property
Type
MarkdownDiagnosticCode
Requirement
required
Name
data
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
optional
Name
message
Kind
property
Type
string
Requirement
required
Name
position
Kind
property
Type
Position
Requirement
optional
Name
severity
Kind
property
Type
"warning" | "error"
Requirement
required
DeclarationView source
MarkdownDiagnosticCodets
type MarkdownDiagnosticCode = "markdown.unsafe-url" | "markdown.unclosed-fence" | "markdown.duplicate-footnote-id" | "markdown.unresolved-footnote-ref" | "markdown.unresolved-reference-link" | "markdown.raw-html-blocked" | "markdown.callout-ambiguous";
DeclarationView source
MarkdownDocumentts
type MarkdownDocument = {
readonly source: string;
readonly blocks: readonly BlockNode[];
readonly diagnostics: readonly MarkdownDiagnostic[];
};
Name
Kind
Type
Requirement
blocks
property
readonly BlockNode[]
required
diagnostics
property
readonly MarkdownDiagnostic[]
required
source
property
string
required
Name
blocks
Kind
property
Type
readonly BlockNode[]
Requirement
required
Name
diagnostics
Kind
property
Type
readonly MarkdownDiagnostic[]
Requirement
required
Name
source
Kind
property
Type
string
Requirement
required

MarkdownMount

interface
DeclarationView source
MarkdownMountts
interface MarkdownMount {
readonly document: MarkdownDocument;
readonly plan: ReturnType<typeof toRenderPlan>;
destroy(): void;
}
Name
Kind
Type
Requirement
destroy
method
() => void
required
document
property
MarkdownDocument
required
plan
property
ReturnType<typeof toRenderPlan>
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
document
Kind
property
Type
MarkdownDocument
Requirement
required
Name
plan
Kind
property
Type
ReturnType<typeof toRenderPlan>
Requirement
required
DeclarationView source
MarkdownNodeTypets
type MarkdownNodeType = "document" | "heading" | "paragraph" | "code-block" | "code-fence-custom" | "list" | "list-item" | "task-item" | "blockquote" | "callout" | "thematic-break" | "table" | "table-row" | "table-cell" | "details" | "emphasis" | "strong" | "strikethrough" | "code-span" | "link" | "autolink" | "image" | "footnote-ref" | "footnote-def" | "hard-break" | "html-blocked" | "text";
DeclarationView source
MAX_GENERATIVE_UI_CHILDRENts
export declare const MAX_GENERATIVE_UI_CHILDREN: 200;
DeclarationView source
MAX_GENERATIVE_UI_DEPTHts
export declare const MAX_GENERATIVE_UI_DEPTH: 32;
DeclarationView source
MAX_GENERATIVE_UI_NODESts
export declare const MAX_GENERATIVE_UI_NODES: 5000;
DeclarationView source
MCP_APP_FRAME_DEFAULT_INIT_TIMEOUT_MSts
export declare const MCP_APP_FRAME_DEFAULT_INIT_TIMEOUT_MS: 5000;
DeclarationView source
MCP_APP_FRAME_SANDBOXts
export declare const MCP_APP_FRAME_SANDBOX: "allow-scripts allow-same-origin";

McpAppFrame

class
DeclarationView source
McpAppFramets
declare class McpAppFrame {
readonly origin: string;
private readonly options;
private container;
private iframe;
private hostWindow;
private ready;
private disposed;
private sequence;
private timer;
private readonly queued;
private readonly pending;
private readonly listener;
constructor(options: McpAppFrameOptions);
mount(): HTMLIFrameElement;
mountInto(container: {
readonly appendChild: (iframe: HTMLIFrameElement) => unknown;
}): HTMLIFrameElement;
markReady(): void;
request<T = unknown>(method: string, params?: unknown): Promise<T>;
notify(method: string, params?: unknown): void;
dispose(): void;
private send;
}
Name
Kind
Type
Requirement
container
property
any
required
dispose
method
() => void
required
disposed
property
any
required
hostWindow
property
any
required
iframe
property
any
required
listener
property
any
required
markReady
method
() => void
required
mount
method
() => HTMLIFrameElement
required
mountInto
method
(container: { readonly appendChild: (iframe: HTMLIFrameElement) => unknown; }) => HTMLIFrameElement
required
notify
method
(method: string, params?: unknown) => void
required
options
property
any
required
origin
property
string
required
pending
property
any
required
queued
property
any
required
Name
container
Kind
property
Type
any
Requirement
required
Name
dispose
Kind
method
Type
() => void
Requirement
required
Name
disposed
Kind
property
Type
any
Requirement
required
Name
hostWindow
Kind
property
Type
any
Requirement
required
Name
iframe
Kind
property
Type
any
Requirement
required
Name
listener
Kind
property
Type
any
Requirement
required
Name
markReady
Kind
method
Type
() => void
Requirement
required
Name
mount
Kind
method
Type
() => HTMLIFrameElement
Requirement
required
Name
mountInto
Kind
method
Type
(container: { readonly appendChild: (iframe: HTMLIFrameElement) => unknown; }) => HTMLIFrameElement
Requirement
required
Name
notify
Kind
method
Type
(method: string, params?: unknown) => void
Requirement
required
Name
options
Kind
property
Type
any
Requirement
required
Name
origin
Kind
property
Type
string
Requirement
required
Name
pending
Kind
property
Type
any
Requirement
required
Name
queued
Kind
property
Type
any
Requirement
required
Name
ready
Kind
property
Type
any
Requirement
required
Name
request
Kind
method
Type
<T = unknown>(method: string, params?: unknown) => Promise<T>
Requirement
required
Name
send
Kind
property
Type
any
Requirement
required
Name
sequence
Kind
property
Type
any
Requirement
required
Name
timer
Kind
property
Type
any
Requirement
required
DeclarationView source
McpAppFrameOptionsts
type McpAppFrameOptions = {
readonly document?: Document;
readonly window?: MessageWindow;
readonly container?: {
readonly appendChild: (iframe: HTMLIFrameElement) => unknown;
};
readonly resourceUri: string;
readonly sandbox?: string;
readonly initTimeoutMs?: number;
readonly onMessage?: (message: McpAppFrameMessage) => void;
readonly onResize?: (size: {
readonly width?: number;
readonly height?: number;
}) => void;
readonly onLog?: (message: unknown) => void;
readonly onError?: (error: unknown) => void;
};
Name
Kind
Type
Requirement
container
property
{ readonly appendChild: (iframe: HTMLIFrameElement) => unknown; }
optional
document
property
Document
optional
initTimeoutMs
property
number
optional
onError
property
(error: unknown) => void
optional
onLog
property
(message: unknown) => void
optional
onMessage
property
(message: McpAppFrameMessage) => void
optional
onResize
property
(size: { readonly width?: number; readonly height?: number; }) => void
optional
resourceUri
property
string
required
sandbox
property
string
optional
window
property
MessageWindow
optional
Name
container
Kind
property
Type
{ readonly appendChild: (iframe: HTMLIFrameElement) => unknown; }
Requirement
optional
Name
document
Kind
property
Type
Document
Requirement
optional
Name
initTimeoutMs
Kind
property
Type
number
Requirement
optional
Name
onError
Kind
property
Type
(error: unknown) => void
Requirement
optional
Name
onLog
Kind
property
Type
(message: unknown) => void
Requirement
optional
Name
onMessage
Kind
property
Type
(message: McpAppFrameMessage) => void
Requirement
optional
Name
onResize
Kind
property
Type
(size: { readonly width?: number; readonly height?: number; }) => void
Requirement
optional
Name
resourceUri
Kind
property
Type
string
Requirement
required
Name
sandbox
Kind
property
Type
string
Requirement
optional
Name
window
Kind
property
Type
MessageWindow
Requirement
optional
DeclarationView source
MediaAnalyserLikets
type MediaAnalyserLike = {
readonly frequencyBinCount: number;
readonly getByteTimeDomainData: (target: Uint8Array) => void;
};
Name
Kind
Type
Requirement
frequencyBinCount
property
number
required
getByteTimeDomainData
property
(target: Uint8Array) => void
required
Name
frequencyBinCount
Kind
property
Type
number
Requirement
required
Name
getByteTimeDomainData
Kind
property
Type
(target: Uint8Array) => void
Requirement
required
DeclarationView source
MediaAudioContextConstructorLikets
type MediaAudioContextConstructorLike = new () => MediaAudioContextLike;
DeclarationView source
MediaAudioContextLikets
type MediaAudioContextLike = {
readonly createMediaStreamSource: (stream: MediaStreamLike) => {
readonly connect: (analyser: MediaAnalyserLike) => void;
};
readonly createAnalyser: () => MediaAnalyserLike;
readonly close?: () => void | Promise<void>;
};
Name
Kind
Type
Requirement
close
property
() => void | Promise<void>
optional
createAnalyser
property
() => MediaAnalyserLike
required
createMediaStreamSource
property
(stream: MediaStreamLike) => { readonly connect: (analyser: MediaAnalyserLike) => void; }
required
Name
close
Kind
property
Type
() => void | Promise<void>
Requirement
optional
Name
createAnalyser
Kind
property
Type
() => MediaAnalyserLike
Requirement
required
Name
createMediaStreamSource
Kind
property
Type
(stream: MediaStreamLike) => { readonly connect: (analyser: MediaAnalyserLike) => void; }
Requirement
required
DeclarationView source
MediaCapturets
type MediaCapture = {
readonly stream: MediaStreamLike;
readonly recorder: MediaRecorderLike;
readonly analyser?: MediaAnalyserLike;
readonly start: () => void;
readonly stop: () => Promise<Blob>;
readonly abort: (reason?: unknown) => Promise<void>;
readonly getVolume: () => number;
readonly dispose: () => void;
};
Name
Kind
Type
Requirement
abort
property
(reason?: unknown) => Promise<void>
required
analyser
property
MediaAnalyserLike
optional
dispose
property
() => void
required
getVolume
property
() => number
required
recorder
property
MediaRecorderLike
required
start
property
() => void
required
stop
property
() => Promise<Blob>
required
stream
property
MediaStreamLike
required
Name
abort
Kind
property
Type
(reason?: unknown) => Promise<void>
Requirement
required
Name
analyser
Kind
property
Type
MediaAnalyserLike
Requirement
optional
Name
dispose
Kind
property
Type
() => void
Requirement
required
Name
getVolume
Kind
property
Type
() => number
Requirement
required
Name
recorder
Kind
property
Type
MediaRecorderLike
Requirement
required
Name
start
Kind
property
Type
() => void
Requirement
required
Name
stop
Kind
property
Type
() => Promise<Blob>
Requirement
required
Name
stream
Kind
property
Type
MediaStreamLike
Requirement
required
DeclarationView source
MediaCaptureConstraintsts
type MediaCaptureConstraints = {
readonly audio: boolean | Record<string, unknown>;
};
Name
Kind
Type
Requirement
audio
property
boolean | Record<string, unknown>
required
Name
audio
Kind
property
Type
boolean | Record<string, unknown>
Requirement
required
DeclarationView source
MediaCaptureOptionsts
type MediaCaptureOptions = {
readonly constraints?: MediaCaptureConstraints;
readonly getUserMedia?: (constraints: MediaCaptureConstraints) => Promise<MediaStreamLike>;
readonly MediaRecorder?: MediaRecorderConstructorLike;
readonly AudioContext?: MediaAudioContextConstructorLike;
readonly mimeType?: string;
readonly timeslice?: number;
readonly signal?: AbortSignal;
};
Name
Kind
Type
Requirement
AudioContext
property
MediaAudioContextConstructorLike
optional
constraints
property
MediaCaptureConstraints
optional
getUserMedia
property
(constraints: MediaCaptureConstraints) => Promise<MediaStreamLike>
optional
MediaRecorder
property
MediaRecorderConstructorLike
optional
mimeType
property
string
optional
signal
property
AbortSignal
optional
timeslice
property
number
optional
Name
AudioContext
Kind
property
Type
MediaAudioContextConstructorLike
Requirement
optional
Name
constraints
Kind
property
Type
MediaCaptureConstraints
Requirement
optional
Name
getUserMedia
Kind
property
Type
(constraints: MediaCaptureConstraints) => Promise<MediaStreamLike>
Requirement
optional
Name
MediaRecorder
Kind
property
Type
MediaRecorderConstructorLike
Requirement
optional
Name
mimeType
Kind
property
Type
string
Requirement
optional
Name
signal
Kind
property
Type
AbortSignal
Requirement
optional
Name
timeslice
Kind
property
Type
number
Requirement
optional
DeclarationView source
MediaRecorderConstructorLikets
type MediaRecorderConstructorLike = new (stream: MediaStreamLike, options?: {
readonly mimeType?: string;
}) => MediaRecorderLike;
DeclarationView source
MediaRecorderDataEventLikets
type MediaRecorderDataEventLike = {
readonly data?: Blob;
};
Name
Kind
Type
Requirement
data
property
Blob
optional
Name
data
Kind
property
Type
Blob
Requirement
optional
DeclarationView source
MediaRecorderErrorEventLikets
type MediaRecorderErrorEventLike = {
readonly error?: unknown;
};
Name
Kind
Type
Requirement
error
property
unknown
optional
Name
error
Kind
property
Type
unknown
Requirement
optional
DeclarationView source
MediaRecorderLikets
type MediaRecorderLike = {
readonly state?: "inactive" | "recording" | "paused";
readonly start: (timeslice?: number) => void;
readonly stop: () => void;
readonly addEventListener: (type: string, listener: (event?: unknown) => void) => void;
readonly removeEventListener?: (type: string, listener: (event?: unknown) => void) => void;
};
Name
Kind
Type
Requirement
addEventListener
property
(type: string, listener: (event?: unknown) => void) => void
required
removeEventListener
property
(type: string, listener: (event?: unknown) => void) => void
optional
start
property
(timeslice?: number) => void
required
state
property
"inactive" | "recording" | "paused"
optional
stop
property
() => void
required
Name
addEventListener
Kind
property
Type
(type: string, listener: (event?: unknown) => void) => void
Requirement
required
Name
removeEventListener
Kind
property
Type
(type: string, listener: (event?: unknown) => void) => void
Requirement
optional
Name
start
Kind
property
Type
(timeslice?: number) => void
Requirement
required
Name
state
Kind
property
Type
"inactive" | "recording" | "paused"
Requirement
optional
Name
stop
Kind
property
Type
() => void
Requirement
required
DeclarationView source
MediaStreamLikets
type MediaStreamLike = {
readonly getTracks: () => readonly MediaStreamTrackLike[];
};
Name
Kind
Type
Requirement
getTracks
property
() => readonly MediaStreamTrackLike[]
required
Name
getTracks
Kind
property
Type
() => readonly MediaStreamTrackLike[]
Requirement
required
DeclarationView source
MediaStreamTrackLikets
type MediaStreamTrackLike = {
readonly stop: () => void;
};
Name
Kind
Type
Requirement
stop
property
() => void
required
Name
stop
Kind
property
Type
() => void
Requirement
required
DeclarationView source
mountAssistantActionBarts
declare function mountAssistantActionBar(container: HTMLElement, client: AssistantActionBarClientLike, options?: MountAssistantActionBarOptions): AssistantActionBarMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
client
parameter
AssistantActionBarClientLike
required
options
parameter
MountAssistantActionBarOptions
optional
return
return value
AssistantActionBarMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
client
Kind
parameter
Type
AssistantActionBarClientLike
Requirement
required
Name
options
Kind
parameter
Type
MountAssistantActionBarOptions
Requirement
optional
Name
return
Kind
return value
Type
AssistantActionBarMount
Requirement
n/a
DeclarationView source
MountAssistantActionBarOptionsts
interface MountAssistantActionBarOptions extends AssistantActionBarConnectOptions {}
DeclarationView source
mountAssistantComposerts
declare function mountAssistantComposer(container: HTMLElement, client: AssistantComposerClientLike, options?: MountAssistantComposerOptions): AssistantComposerMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
client
parameter
AssistantComposerClientLike
required
options
parameter
MountAssistantComposerOptions
optional
return
return value
AssistantComposerMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
client
Kind
parameter
Type
AssistantComposerClientLike
Requirement
required
Name
options
Kind
parameter
Type
MountAssistantComposerOptions
Requirement
optional
Name
return
Kind
return value
Type
AssistantComposerMount
Requirement
n/a
DeclarationView source
MountAssistantComposerOptionsts
interface MountAssistantComposerOptions extends AssistantComposerConnectOptions {}
DeclarationView source
mountAssistantThreadts
declare function mountAssistantThread(container: HTMLElement, client: AssistantThreadClientLike, options?: MountAssistantThreadOptions): AssistantThreadMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
client
parameter
AssistantThreadClientLike
required
options
parameter
MountAssistantThreadOptions
optional
return
return value
AssistantThreadMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
client
Kind
parameter
Type
AssistantThreadClientLike
Requirement
required
Name
options
Kind
parameter
Type
MountAssistantThreadOptions
Requirement
optional
Name
return
Kind
return value
Type
AssistantThreadMount
Requirement
n/a
DeclarationView source
MountAssistantThreadOptionsts
interface MountAssistantThreadOptions extends AssistantThreadConnectOptions {}
DeclarationView source
MountedServiceOptionsts
interface MountedServiceOptions<Input, Event extends EventObject, Command extends CommandObject> {
readonly input: Input;
readonly runCommand: (command: Command, tools: {
send: (event: Event) => void;
signal: AbortSignal;
}) => void | (() => void);
readonly meta: Omit<DevtoolsServiceMeta, "mountedAt" | "serviceId"> & {
readonly serviceId?: string;
};
}
Name
Kind
Type
Requirement
input
property
Input
required
meta
property
Omit<DevtoolsServiceMeta, "mountedAt" | "serviceId"> & { readonly serviceId?: string; }
required
runCommand
property
(command: Command, tools: { send: (event: Event) => void; signal: AbortSignal; }) => void | (() => void)
required
Name
input
Kind
property
Type
Input
Requirement
required
Name
meta
Kind
property
Type
Omit<DevtoolsServiceMeta, "mountedAt" | "serviceId"> & { readonly serviceId?: string; }
Requirement
required
Name
runCommand
Kind
property
Type
(command: Command, tools: { send: (event: Event) => void; signal: AbortSignal; }) => void | (() => void)
Requirement
required

mountGrid

function
DeclarationView source
mountGridts
declare function mountGrid<T>(container: HTMLElement, options: MountGridOptions<T>): GridMount<T>;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountGridOptions<T>
required
return
return value
GridMount<T>
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountGridOptions<T>
Requirement
required
Name
return
Kind
return value
Type
GridMount<T>
Requirement
n/a
DeclarationView source
MountGridOptionsts
type MountGridOptions<T> = GridConnectOptions<T> & {
readonly input?: Parameters<typeof gridMachine.initial>[0];
readonly seed?: string;
};
Name
Kind
Type
Requirement
input
property
Parameters<typeof gridMachine.initial>[0]
optional
seed
property
string
optional
Name
input
Kind
property
Type
Parameters<typeof gridMachine.initial>[0]
Requirement
optional
Name
seed
Kind
property
Type
string
Requirement
optional

mountMarkdown

function

Mounts a static Markdown render plan without a framework or HTML string sinks.

DeclarationView source
mountMarkdownts
declare function mountMarkdown(container: HTMLElement, source: string, options?: MountMarkdownOptions): MarkdownMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
source
parameter
string
required
options
parameter
MountMarkdownOptions
optional
return
return value
MarkdownMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
source
Kind
parameter
Type
string
Requirement
required
Name
options
Kind
parameter
Type
MountMarkdownOptions
Requirement
optional
Name
return
Kind
return value
Type
MarkdownMount
Requirement
n/a
DeclarationView source
MountMarkdownOptionsts
interface MountMarkdownOptions extends ParseOptions, RenderPlanOptions {
readonly ast?: MarkdownDocument;
readonly dir?: "ltr" | "rtl" | "auto";
readonly className?: string;
}
Name
Kind
Type
Requirement
ast
property
MarkdownDocument
optional
className
property
string
optional
dir
property
"ltr" | "rtl" | "auto"
optional
Name
ast
Kind
property
Type
MarkdownDocument
Requirement
optional
Name
className
Kind
property
Type
string
Requirement
optional
Name
dir
Kind
property
Type
"ltr" | "rtl" | "auto"
Requirement
optional

parse

function
DeclarationView source
parsets
declare function parse(source: string, options?: ParseOptions): MarkdownDocument;
Name
Kind
Type
Requirement
source
parameter
string
required
options
parameter
ParseOptions
optional
return
return value
MarkdownDocument
n/a
Name
source
Kind
parameter
Type
string
Requirement
required
Name
options
Kind
parameter
Type
ParseOptions
Requirement
optional
Name
return
Kind
return value
Type
MarkdownDocument
Requirement
n/a

parseDirective

function
DeclarationView source
parseDirectivets
declare function parseDirective(value: string): Directive | null;
Name
Kind
Type
Requirement
value
parameter
string
required
return
return value
Directive | null
n/a
Name
value
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
Directive | null
Requirement
n/a

parseIncremental

function
DeclarationView source
parseIncrementalts
declare function parseIncremental(previous: IncrementalState | undefined, source: string, options?: ParseOptions): {
readonly document: MarkdownDocument;
readonly state: IncrementalState;
};
Name
Kind
Type
Requirement
previous
parameter
IncrementalState | undefined
required
source
parameter
string
required
options
parameter
ParseOptions
optional
return
return value
{ readonly document: MarkdownDocument; readonly state: IncrementalState; }
n/a
Name
previous
Kind
parameter
Type
IncrementalState | undefined
Requirement
required
Name
source
Kind
parameter
Type
string
Requirement
required
Name
options
Kind
parameter
Type
ParseOptions
Requirement
optional
Name
return
Kind
return value
Type
{ readonly document: MarkdownDocument; readonly state: IncrementalState; }
Requirement
n/a

ParseOptions

interface
DeclarationView source
ParseOptionsts
interface ParseOptions {
readonly gfm?: boolean;
readonly footnotes?: boolean;
readonly callouts?: boolean;
readonly sourcePositions?: boolean;
readonly allowDataImage?: boolean;
}
Name
Kind
Type
Requirement
allowDataImage
property
boolean
optional
callouts
property
boolean
optional
footnotes
property
boolean
optional
gfm
property
boolean
optional
sourcePositions
property
boolean
optional
Name
allowDataImage
Kind
property
Type
boolean
Requirement
optional
Name
callouts
Kind
property
Type
boolean
Requirement
optional
Name
footnotes
Kind
property
Type
boolean
Requirement
optional
Name
gfm
Kind
property
Type
boolean
Requirement
optional
Name
sourcePositions
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
parseToEditorNodests
declare function parseToEditorNodes(source: string, options?: ParseOptions): readonly EditorBridgeNode[];
Name
Kind
Type
Requirement
source
parameter
string
required
options
parameter
ParseOptions
optional
return
return value
readonly EditorBridgeNode[]
n/a
Name
source
Kind
parameter
Type
string
Requirement
required
Name
options
Kind
parameter
Type
ParseOptions
Requirement
optional
Name
return
Kind
return value
Type
readonly EditorBridgeNode[]
Requirement
n/a

partEventName

function

Returns the lowercase DOM event name represented by a connector event key.

DeclarationView source
partEventNamets
declare function partEventName(key: string): string;
Name
Kind
Type
Requirement
key
parameter
string
required
return
return value
string
n/a
Name
key
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
string
Requirement
n/a
DeclarationView source
PointerDragControllerts
interface PointerDragController {
getState(): DragControllerState;
start(event: unknown): DragControllerState;
move(event: unknown): DragControllerState;
end(event?: unknown): DragControllerState;
cancel(): DragControllerState;
keyboardMove(event: unknown): DragControllerState;
}
Name
Kind
Type
Requirement
cancel
method
() => DragControllerState
required
end
method
(event?: unknown) => DragControllerState
required
getState
method
() => DragControllerState
required
keyboardMove
method
(event: unknown) => DragControllerState
required
move
method
(event: unknown) => DragControllerState
required
start
method
(event: unknown) => DragControllerState
required
Name
cancel
Kind
method
Type
() => DragControllerState
Requirement
required
Name
end
Kind
method
Type
(event?: unknown) => DragControllerState
Requirement
required
Name
getState
Kind
method
Type
() => DragControllerState
Requirement
required
Name
keyboardMove
Kind
method
Type
(event: unknown) => DragControllerState
Requirement
required
Name
move
Kind
method
Type
(event: unknown) => DragControllerState
Requirement
required
Name
start
Kind
method
Type
(event: unknown) => DragControllerState
Requirement
required

PointerEventLike

interface
DeclarationView source
PointerEventLikets
interface PointerEventLike {
readonly target?: unknown;
readonly currentTarget?: unknown;
readonly clientX?: number;
readonly clientY?: number;
readonly pointerId?: number;
preventDefault?(): void;
}
Name
Kind
Type
Requirement
clientX
property
number
optional
clientY
property
number
optional
currentTarget
property
unknown
optional
pointerId
property
number
optional
preventDefault
method
(() => void) | undefined
optional
target
property
unknown
optional
Name
clientX
Kind
property
Type
number
Requirement
optional
Name
clientY
Kind
property
Type
number
Requirement
optional
Name
currentTarget
Kind
property
Type
unknown
Requirement
optional
Name
pointerId
Kind
property
Type
number
Requirement
optional
Name
preventDefault
Kind
method
Type
(() => void) | undefined
Requirement
optional
Name
target
Kind
property
Type
unknown
Requirement
optional

Politeness

type

Concrete live-region announcer behind the ANNOUNCE command's `options.announce` seam (see `command-runner.ts` / `types.ts` — frozen). `createLiveRegionAnnouncer(options: { root, format })` returns `{ announce(key, params, politeness): void; destroy(): void }` where `announce` is signature-compatible with `CommandRunner`'s `options.announce`. SSR-safe: constructing the announcer touches no DOM. Live-region elements are created lazily on first `announce`. `root()` returning null is a silent no-op. Two regions, one per politeness: a `<div>` with `aria-live="polite"` / `"assertive"`, `aria-atomic="true"`, `data-scope="announcer"`, `data-part="live-region"`, `data-politeness="<level>"`, and functional visually-hidden inline styles only — no aesthetic styling, no classes. Appended to `root()`'s body (Document root => document.body; ShadowRoot or HTMLElement root => itself). Repeat-safe: announcing the same message twice re-announces — textContent is cleared immediately, then set on a queued macrotask (setTimeout 0), so assistive tech observes an actual mutation even for a repeated message. `destroy()` cancels any pending tasks and removes both regions; it is idempotent. Locale formatting contract: this module never contains message strings — `format` owns wording. `formatFromMessages` adapts a plain message-table into a `format` function; an unknown key falls back to the key itself as a development-visible fallback. No English default table for Select is defined here.

DeclarationView source
Politenessts
type Politeness = "polite" | "assertive";

Position

type
DeclarationView source
Positionts
type Position = {
readonly start: PositionPoint;
readonly end: PositionPoint;
};
Name
Kind
Type
Requirement
end
property
PositionPoint
required
start
property
PositionPoint
required
Name
end
Kind
property
Type
PositionPoint
Requirement
required
Name
start
Kind
property
Type
PositionPoint
Requirement
required
DeclarationView source
PositionPointts
type PositionPoint = {
readonly line: number;
readonly column: number;
readonly offset: number;
};
Name
Kind
Type
Requirement
column
property
number
required
line
property
number
required
offset
property
number
required
Name
column
Kind
property
Type
number
Requirement
required
Name
line
Kind
property
Type
number
Requirement
required
Name
offset
Kind
property
Type
number
Requirement
required

projectColumns

function
DeclarationView source
projectColumnsts
declare function projectColumns<T>(columnDefs: readonly GridColumnDef<T>[], columnState: GridColumnState): GridColumnProjection<T>;
Name
Kind
Type
Requirement
columnDefs
parameter
readonly GridColumnDef<T>[]
required
columnState
parameter
GridColumnState
required
return
return value
GridColumnProjection<T>
n/a
Name
columnDefs
Kind
parameter
Type
readonly GridColumnDef<T>[]
Requirement
required
Name
columnState
Kind
parameter
Type
GridColumnState
Requirement
required
Name
return
Kind
return value
Type
GridColumnProjection<T>
Requirement
n/a

Remote rows are already sorted, filtered and paged by their source.

DeclarationView source
projectRemoteRowsts
declare function projectRemoteRows<T>(rows: readonly T[], options: {
readonly getRowId: (row: T, absoluteIndex: number) => string;
readonly baseIndex?: number;
readonly total: number;
}): GridRowProjection<T>;
Name
Kind
Type
Requirement
rows
parameter
readonly T[]
required
options
parameter
{ readonly getRowId: (row: T, absoluteIndex: number) => string; readonly baseIndex?: number; readonly total: number; }
required
return
return value
GridRowProjection<T>
n/a
Name
rows
Kind
parameter
Type
readonly T[]
Requirement
required
Name
options
Kind
parameter
Type
{ readonly getRowId: (row: T, absoluteIndex: number) => string; readonly baseIndex?: number; readonly total: number; }
Requirement
required
Name
return
Kind
return value
Type
GridRowProjection<T>
Requirement
n/a

projectRows

function
DeclarationView source
projectRowsts
declare function projectRows<T>(rows: readonly T[], model: GridRowProjectionModel<T>, cache?: GridRowProjectionCache<T>): GridRowProjection<T>;
Name
Kind
Type
Requirement
rows
parameter
readonly T[]
required
model
parameter
GridRowProjectionModel<T>
required
cache
parameter
GridRowProjectionCache<T>
optional
return
return value
GridRowProjection<T>
n/a
Name
rows
Kind
parameter
Type
readonly T[]
Requirement
required
Name
model
Kind
parameter
Type
GridRowProjectionModel<T>
Requirement
required
Name
cache
Kind
parameter
Type
GridRowProjectionCache<T>
Requirement
optional
Name
return
Kind
return value
Type
GridRowProjection<T>
Requirement
n/a

queryTabbable

function
DeclarationView source
queryTabbablets
declare function queryTabbable(container: MinimalContainerLike): MinimalTabbableLike[];
Name
Kind
Type
Requirement
container
parameter
MinimalContainerLike
required
return
return value
MinimalTabbableLike[]
n/a
Name
container
Kind
parameter
Type
MinimalContainerLike
Requirement
required
Name
return
Kind
return value
Type
MinimalTabbableLike[]
Requirement
n/a
DeclarationView source
radioGroupAnatomyts
export declare const radioGroupAnatomy: readonly ["root", "label", "description", "item", "item-input", "item-control", "item-indicator", "item-label"];
DeclarationView source
readVisibleRegionts
declare function readVisibleRegion(root: VisibleRegionElement, options?: VisibleRegionOptions): VisibleRegion;
Name
Kind
Type
Requirement
root
parameter
VisibleRegionElement
required
options
parameter
VisibleRegionOptions
optional
return
return value
VisibleRegion
n/a
Name
root
Kind
parameter
Type
VisibleRegionElement
Requirement
required
Name
options
Kind
parameter
Type
VisibleRegionOptions
Requirement
optional
Name
return
Kind
return value
Type
VisibleRegion
Requirement
n/a
DeclarationView source
registerAssistantContextts
export declare const registerAssistantContext: (client: AssistantModelContextClient, getContext: () => AssistantModelContext, options?: AssistantModelContextRegistrationOptions) => (() => void);
Name
Kind
Type
Requirement
client
parameter
AssistantModelContextClient
required
getContext
parameter
() => AssistantModelContext
required
options
parameter
AssistantModelContextRegistrationOptions
optional
return
return value
(() => void)
n/a
Name
client
Kind
parameter
Type
AssistantModelContextClient
Requirement
required
Name
getContext
Kind
parameter
Type
() => AssistantModelContext
Requirement
required
Name
options
Kind
parameter
Type
AssistantModelContextRegistrationOptions
Requirement
optional
Name
return
Kind
return value
Type
(() => void)
Requirement
n/a
DeclarationView source
registerAssistantInstructionsts
export declare const registerAssistantInstructions: (client: AssistantModelContextClient, system: string, options?: AssistantModelContextRegistrationOptions) => (() => void);
Name
Kind
Type
Requirement
client
parameter
AssistantModelContextClient
required
system
parameter
string
required
options
parameter
AssistantModelContextRegistrationOptions
optional
return
return value
(() => void)
n/a
Name
client
Kind
parameter
Type
AssistantModelContextClient
Requirement
required
Name
system
Kind
parameter
Type
string
Requirement
required
Name
options
Kind
parameter
Type
AssistantModelContextRegistrationOptions
Requirement
optional
Name
return
Kind
return value
Type
(() => void)
Requirement
n/a
DeclarationView source
renderGenerativeUIts
export declare const renderGenerativeUI: (spec: unknown) => GenerativeUIRenderNode | readonly GenerativeUIRenderNode[];
Name
Kind
Type
Requirement
spec
parameter
unknown
required
return
return value
GenerativeUIRenderNode | readonly GenerativeUIRenderNode[]
n/a
Name
spec
Kind
parameter
Type
unknown
Requirement
required
Name
return
Kind
return value
Type
GenerativeUIRenderNode | readonly GenerativeUIRenderNode[]
Requirement
n/a

RenderPlan

interface
DeclarationView source
RenderPlants
interface RenderPlan {
readonly nodes: readonly RenderPlanNode[];
readonly interactive: boolean;
}
Name
Kind
Type
Requirement
interactive
property
boolean
required
nodes
property
readonly RenderPlanNode[]
required
Name
interactive
Kind
property
Type
boolean
Requirement
required
Name
nodes
Kind
property
Type
readonly RenderPlanNode[]
Requirement
required

RenderPlanNode

interface
DeclarationView source
RenderPlanNodets
interface RenderPlanNode {
readonly part: MarkdownNodeType;
readonly props: Readonly<Record<string, unknown>>;
readonly children: readonly RenderPlanNode[];
readonly key: string;
readonly text?: string;
readonly element?: string;
}
Name
Kind
Type
Requirement
children
property
readonly RenderPlanNode[]
required
element
property
string
optional
key
property
string
required
part
property
MarkdownNodeType
required
props
property
Readonly<Record<string, unknown>>
required
text
property
string
optional
Name
children
Kind
property
Type
readonly RenderPlanNode[]
Requirement
required
Name
element
Kind
property
Type
string
Requirement
optional
Name
key
Kind
property
Type
string
Requirement
required
Name
part
Kind
property
Type
MarkdownNodeType
Requirement
required
Name
props
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
required
Name
text
Kind
property
Type
string
Requirement
optional

RenderPlanOptions

interface
DeclarationView source
RenderPlanOptionsts
interface RenderPlanOptions {
readonly components?: Partial<Record<MarkdownNodeType, unknown>>;
readonly code?: Readonly<Record<string, unknown>>;
readonly highlight?: (code: string, lang: string | undefined) => readonly HighlightToken[];
}
Name
Kind
Type
Requirement
code
property
Readonly<Record<string, unknown>>
optional
components
property
Partial<Record<MarkdownNodeType, unknown>>
optional
highlight
property
(code: string, lang: string | undefined) => readonly HighlightToken[]
optional
Name
code
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
optional
Name
components
Kind
property
Type
Partial<Record<MarkdownNodeType, unknown>>
Requirement
optional
Name
highlight
Kind
property
Type
(code: string, lang: string | undefined) => readonly HighlightToken[]
Requirement
optional
DeclarationView source
RenderTokents
type RenderToken = {
readonly text: string;
readonly tone?: CodeBlockTokenTone;
};
Name
Kind
Type
Requirement
text
property
string
required
tone
property
CodeBlockTokenTone
optional
Name
text
Kind
property
Type
string
Requirement
required
Name
tone
Kind
property
Type
CodeBlockTokenTone
Requirement
optional

resolveDataUI

function
DeclarationView source
resolveDataUIts
declare function resolveDataUI<TResult = unknown, TData = unknown>(options: DataUIResolverOptions<TResult, TData>): TResult | null;
Name
Kind
Type
Requirement
options
parameter
DataUIResolverOptions<TResult, TData>
required
return
return value
TResult | null
n/a
Name
options
Kind
parameter
Type
DataUIResolverOptions<TResult, TData>
Requirement
required
Name
return
Kind
return value
Type
TResult | null
Requirement
n/a
DeclarationView source
resolveGenerativeUIComponentts
export declare const resolveGenerativeUIComponent: <T = GenerativeUIRenderNode>(name: string, options?: GenerativeUIRendererOptions<T>) => GenerativeUIComponentRenderer<T> | undefined;
Name
Kind
Type
Requirement
name
parameter
string
required
options
parameter
GenerativeUIRendererOptions<T>
optional
return
return value
GenerativeUIComponentRenderer<T> | undefined
n/a
Name
name
Kind
parameter
Type
string
Requirement
required
Name
options
Kind
parameter
Type
GenerativeUIRendererOptions<T>
Requirement
optional
Name
return
Kind
return value
Type
GenerativeUIComponentRenderer<T> | undefined
Requirement
n/a

Resolves a browser Selection into a quote only when it belongs to one message.

DeclarationView source
resolveSelectionQuotets
declare function resolveSelectionQuote(selection: SelectionLike | null | undefined, root: SelectionObserverOptions["root"]): SelectionObserverSelection | null;
Name
Kind
Type
Requirement
selection
parameter
SelectionLike | null | undefined
required
root
parameter
SelectionObserverOptions["root"]
required
return
return value
SelectionObserverSelection | null
n/a
Name
selection
Kind
parameter
Type
SelectionLike | null | undefined
Requirement
required
Name
root
Kind
parameter
Type
SelectionObserverOptions["root"]
Requirement
required
Name
return
Kind
return value
Type
SelectionObserverSelection | null
Requirement
n/a

resolveTabTarget

function

An active element outside the tracked set is treated as index -1: forwards enters at the first element, backwards enters at the last.

DeclarationView source
resolveTabTargetts
declare function resolveTabTarget(tabbable: readonly MinimalTabbableLike[], active: unknown, backwards: boolean): MinimalTabbableLike | null;
Name
Kind
Type
Requirement
tabbable
parameter
readonly MinimalTabbableLike[]
required
active
parameter
unknown
required
backwards
parameter
boolean
required
return
return value
MinimalTabbableLike | null
n/a
Name
tabbable
Kind
parameter
Type
readonly MinimalTabbableLike[]
Requirement
required
Name
active
Kind
parameter
Type
unknown
Requirement
required
Name
backwards
Kind
parameter
Type
boolean
Requirement
required
Name
return
Kind
return value
Type
MinimalTabbableLike | null
Requirement
n/a

resolveToolUI

function
DeclarationView source
resolveToolUIts
declare function resolveToolUI<TResult = unknown, TPart = unknown>(options: ToolUIResolverOptions<TResult, TPart>): TResult | string | null;
Name
Kind
Type
Requirement
options
parameter
ToolUIResolverOptions<TResult, TPart>
required
return
return value
TResult | string | null
n/a
Name
options
Kind
parameter
Type
ToolUIResolverOptions<TResult, TPart>
Requirement
required
Name
return
Kind
return value
Type
TResult | string | null
Requirement
n/a
DeclarationView source
restoreNativeCheckedts
declare function restoreNativeChecked(input: {
checked: boolean;
} | null, committed: boolean): void;
Name
Kind
Type
Requirement
input
parameter
{ checked: boolean; } | null
required
committed
parameter
boolean
required
return
return value
void
n/a
Name
input
Kind
parameter
Type
{ checked: boolean; } | null
Requirement
required
Name
committed
Kind
parameter
Type
boolean
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a
DeclarationView source
restoreNativeValuets
declare function restoreNativeValue(input: {
value: string;
} | null, committed: string): void;
Name
Kind
Type
Requirement
input
parameter
{ value: string; } | null
required
committed
parameter
string
required
return
return value
void
n/a
Name
input
Kind
parameter
Type
{ value: string; } | null
Requirement
required
Name
committed
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a

rowsToTSV

function
DeclarationView source
rowsToTSVts
declare function rowsToTSV(rows: readonly (readonly string[])[], options?: ClipboardTSVOptions): string;
Name
Kind
Type
Requirement
rows
parameter
readonly (readonly string[])[]
required
options
parameter
ClipboardTSVOptions
optional
return
return value
string
n/a
Name
rows
Kind
parameter
Type
readonly (readonly string[])[]
Requirement
required
Name
options
Kind
parameter
Type
ClipboardTSVOptions
Requirement
optional
Name
return
Kind
return value
Type
string
Requirement
n/a

sanitizeUrl

function
DeclarationView source
sanitizeUrlts
declare function sanitizeUrl(raw: string, options?: {
readonly allowDataImage?: boolean;
}): UrlSanitizeResult;
Name
Kind
Type
Requirement
raw
parameter
string
required
options
parameter
{ readonly allowDataImage?: boolean; }
optional
return
return value
UrlSanitizeResult
n/a
Name
raw
Kind
parameter
Type
string
Requirement
required
Name
options
Kind
parameter
Type
{ readonly allowDataImage?: boolean; }
Requirement
optional
Name
return
Kind
return value
Type
UrlSanitizeResult
Requirement
n/a
DeclarationView source
SelectionObserverApits
interface SelectionObserverApi {
getState(): SelectionObserverState;
subscribe(listener: () => void): () => void;
refresh(): void;
clear(): void;
destroy(): void;
}
Name
Kind
Type
Requirement
clear
method
() => void
required
destroy
method
() => void
required
getState
method
() => SelectionObserverState
required
refresh
method
() => void
required
subscribe
method
(listener: () => void) => () => void
required
Name
clear
Kind
method
Type
() => void
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
getState
Kind
method
Type
() => SelectionObserverState
Requirement
required
Name
refresh
Kind
method
Type
() => void
Requirement
required
Name
subscribe
Kind
method
Type
(listener: () => void) => () => void
Requirement
required
DeclarationView source
SelectionObserverOptionsts
interface SelectionObserverOptions {
readonly document: EventTargetLike;
readonly root: EventTargetLike & {
contains?: (...args: any[]) => boolean;
};
readonly getSelection: () => SelectionLike | null | undefined;
}
Name
Kind
Type
Requirement
document
property
EventTargetLike
required
getSelection
property
() => SelectionLike | null | undefined
required
root
property
EventTargetLike & { contains?: (...args: any[]) => boolean; }
required
Name
document
Kind
property
Type
EventTargetLike
Requirement
required
Name
getSelection
Kind
property
Type
() => SelectionLike | null | undefined
Requirement
required
Name
root
Kind
property
Type
EventTargetLike & { contains?: (...args: any[]) => boolean; }
Requirement
required

DOM boundary for assistant message selection. The observer is deliberately not a statechart: a browser Selection and its geometry are ephemeral DOM facts, not durable UI state. Adapters own the lifecycle and subscribe to this small snapshot API.

DeclarationView source
SelectionObserverRectts
interface SelectionObserverRect {
readonly top: number;
readonly left: number;
readonly right: number;
readonly bottom: number;
readonly width: number;
readonly height: number;
}
Name
Kind
Type
Requirement
bottom
property
number
required
height
property
number
required
left
property
number
required
right
property
number
required
top
property
number
required
width
property
number
required
Name
bottom
Kind
property
Type
number
Requirement
required
Name
height
Kind
property
Type
number
Requirement
required
Name
left
Kind
property
Type
number
Requirement
required
Name
right
Kind
property
Type
number
Requirement
required
Name
top
Kind
property
Type
number
Requirement
required
Name
width
Kind
property
Type
number
Requirement
required
DeclarationView source
SelectionObserverSelectionts
interface SelectionObserverSelection {
readonly text: string;
readonly messageId: string;
readonly rect: SelectionObserverRect;
readonly range: unknown;
}
Name
Kind
Type
Requirement
messageId
property
string
required
range
property
unknown
required
rect
property
SelectionObserverRect
required
text
property
string
required
Name
messageId
Kind
property
Type
string
Requirement
required
Name
range
Kind
property
Type
unknown
Requirement
required
Name
rect
Kind
property
Type
SelectionObserverRect
Requirement
required
Name
text
Kind
property
Type
string
Requirement
required
DeclarationView source
serializeMarkdownts
declare function serializeMarkdown(document: MarkdownDocument, options?: {
readonly lineWidth?: number;
}): string;
Name
Kind
Type
Requirement
document
parameter
MarkdownDocument
required
options
parameter
{ readonly lineWidth?: number; }
optional
return
return value
string
n/a
Name
document
Kind
parameter
Type
MarkdownDocument
Requirement
required
Name
options
Kind
parameter
Type
{ readonly lineWidth?: number; }
Requirement
optional
Name
return
Kind
return value
Type
string
Requirement
n/a
DeclarationView source
SmoothTextOptionsts
type SmoothTextOptions = {
readonly drainMs?: number;
readonly maxCharsPerFrame?: number;
};
Name
Kind
Type
Requirement
drainMs
property
number
optional
maxCharsPerFrame
property
number
optional
Name
drainMs
Kind
property
Type
number
Requirement
optional
Name
maxCharsPerFrame
Kind
property
Type
number
Requirement
optional
DeclarationView source
SmoothTextSchedulerts
type SmoothTextScheduler = {
request(callback: () => void, delayMs: number): unknown;
cancel(handle: unknown): void;
};
Name
Kind
Type
Requirement
cancel
method
(handle: unknown) => void
required
request
method
(callback: () => void, delayMs: number) => unknown
required
Name
cancel
Kind
method
Type
(handle: unknown) => void
Requirement
required
Name
request
Kind
method
Type
(callback: () => void, delayMs: number) => unknown
Requirement
required
DeclarationView source
TABBABLE_SELECTORts
export declare const TABBABLE_SELECTOR: "a[href],button:not([disabled]),input:not([disabled]),select:not([disabled]),textarea:not([disabled]),[tabindex]:not([tabindex=\"-1\"])";
DeclarationView source
ThreadViewportStorets
type ThreadViewportStore = {
getState(): ThreadViewportState;
subscribe(listener: () => void): () => void;
setState(next: Partial<ThreadViewportState>): void;
follow(): void;
suspend(): void;
};
Name
Kind
Type
Requirement
follow
method
() => void
required
getState
method
() => ThreadViewportState
required
setState
method
(next: Partial<ThreadViewportState>) => void
required
subscribe
method
(listener: () => void) => () => void
required
suspend
method
() => void
required
Name
follow
Kind
method
Type
() => void
Requirement
required
Name
getState
Kind
method
Type
() => ThreadViewportState
Requirement
required
Name
setState
Kind
method
Type
(next: Partial<ThreadViewportState>) => void
Requirement
required
Name
subscribe
Kind
method
Type
(listener: () => void) => () => void
Requirement
required
Name
suspend
Kind
method
Type
() => void
Requirement
required
DeclarationView source
ToolRenderContextts
type ToolRenderContext<TPart = unknown> = {
readonly part: TPart;
readonly toolName: string;
readonly args: unknown;
};
Name
Kind
Type
Requirement
args
property
unknown
required
part
property
TPart
required
toolName
property
string
required
Name
args
Kind
property
Type
unknown
Requirement
required
Name
part
Kind
property
Type
TPart
Requirement
required
Name
toolName
Kind
property
Type
string
Requirement
required
DeclarationView source
ToolRendererts
type ToolRenderer<TResult, TPart = unknown> = TResult | null | undefined | ((context: ToolRenderContext<TPart>) => unknown);
DeclarationView source
ToolUIResolverOptionsts
type ToolUIResolverOptions<TResult = unknown, TPart = unknown> = {
readonly part?: TPart;
readonly toolName?: string;
readonly name?: string;
readonly by_name?: Readonly<Record<string, ToolRenderer<TResult, TPart>>>;
readonly byName?: Readonly<Record<string, ToolRenderer<TResult, TPart>>>;
readonly toolkit?: {
readonly render?: ToolRenderer<TResult, TPart>;
readonly renderText?: ToolRenderer<string, TPart>;
};
readonly mcpApp?: ToolRenderer<TResult, TPart>;
readonly mcpAppRenderer?: ToolRenderer<TResult, TPart>;
readonly Fallback?: ToolRenderer<TResult, TPart>;
readonly fallback?: ToolRenderer<TResult, TPart>;
readonly useInlineRender?: boolean;
};
Name
Kind
Type
Requirement
by_name
property
Readonly<Record<string, ToolRenderer<TResult, TPart>>>
optional
byName
property
Readonly<Record<string, ToolRenderer<TResult, TPart>>>
optional
fallback
property
ToolRenderer<TResult, TPart>
optional
Fallback
property
ToolRenderer<TResult, TPart>
optional
mcpApp
property
ToolRenderer<TResult, TPart>
optional
mcpAppRenderer
property
ToolRenderer<TResult, TPart>
optional
name
property
string
optional
part
property
TPart
optional
toolkit
property
{ readonly render?: ToolRenderer<TResult, TPart>; readonly renderText?: ToolRenderer<string, TPart>; }
optional
toolName
property
string
optional
useInlineRender
property
boolean
optional
Name
by_name
Kind
property
Type
Readonly<Record<string, ToolRenderer<TResult, TPart>>>
Requirement
optional
Name
byName
Kind
property
Type
Readonly<Record<string, ToolRenderer<TResult, TPart>>>
Requirement
optional
Name
fallback
Kind
property
Type
ToolRenderer<TResult, TPart>
Requirement
optional
Name
Fallback
Kind
property
Type
ToolRenderer<TResult, TPart>
Requirement
optional
Name
mcpApp
Kind
property
Type
ToolRenderer<TResult, TPart>
Requirement
optional
Name
mcpAppRenderer
Kind
property
Type
ToolRenderer<TResult, TPart>
Requirement
optional
Name
name
Kind
property
Type
string
Requirement
optional
Name
part
Kind
property
Type
TPart
Requirement
optional
Name
toolkit
Kind
property
Type
{ readonly render?: ToolRenderer<TResult, TPart>; readonly renderText?: ToolRenderer<string, TPart>; }
Requirement
optional
Name
toolName
Kind
property
Type
string
Requirement
optional
Name
useInlineRender
Kind
property
Type
boolean
Requirement
optional

toRenderPlan

function
DeclarationView source
toRenderPlants
declare function toRenderPlan(document: MarkdownDocument, options?: RenderPlanOptions): RenderPlan;
Name
Kind
Type
Requirement
document
parameter
MarkdownDocument
required
options
parameter
RenderPlanOptions
optional
return
return value
RenderPlan
n/a
Name
document
Kind
parameter
Type
MarkdownDocument
Requirement
required
Name
options
Kind
parameter
Type
RenderPlanOptions
Requirement
optional
Name
return
Kind
return value
Type
RenderPlan
Requirement
n/a
DeclarationView source
TriggerPopoverAdapterts
interface TriggerPopoverAdapter {
readonly categories: () => readonly string[];
readonly categoryItems: (category: string, query?: string) => readonly TriggerPopoverItem[];
readonly search?: (query: string) => readonly TriggerPopoverItem[];
}
Name
Kind
Type
Requirement
categories
property
() => readonly string[]
required
categoryItems
property
(category: string, query?: string) => readonly TriggerPopoverItem[]
required
Name
categories
Kind
property
Type
() => readonly string[]
Requirement
required
Name
categoryItems
Kind
property
Type
(category: string, query?: string) => readonly TriggerPopoverItem[]
Requirement
required
Name
search
Kind
property
Type
(query: string) => readonly TriggerPopoverItem[]
Requirement
optional
DeclarationView source
TriggerPopoverFormatterts
type TriggerPopoverFormatter = (item: TriggerPopoverItem) => string;

TriggerPopoverItem

interface
DeclarationView source
TriggerPopoverItemts
interface TriggerPopoverItem {
readonly id: string;
readonly label: string;
readonly category: string;
readonly type?: string;
readonly description?: string;
readonly disabled?: boolean;
}
Name
Kind
Type
Requirement
category
property
string
required
description
property
string
optional
disabled
property
boolean
optional
id
property
string
required
label
property
string
required
type
property
string
optional
Name
category
Kind
property
Type
string
Requirement
required
Name
description
Kind
property
Type
string
Requirement
optional
Name
disabled
Kind
property
Type
boolean
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required
Name
label
Kind
property
Type
string
Requirement
required
Name
type
Kind
property
Type
string
Requirement
optional
DeclarationView source
TriggerPopoverRegistryts
interface TriggerPopoverRegistry {
update(text: string): boolean;
close(): void;
handleKey(key: string): TriggerPopoverItem | null;
select(item: TriggerPopoverItem): string;
applySelection(text: string, item: TriggerPopoverItem): string;
setSelectionBehavior(behavior?: TriggerPopoverSelectionBehavior): void;
selectCategory(category: string): boolean;
subscribe(listener: () => void): () => void;
getState(): TriggerPopoverState;
readonly char: string;
}
Name
Kind
Type
Requirement
applySelection
method
(text: string, item: TriggerPopoverItem) => string
required
char
property
string
required
close
method
() => void
required
getState
method
() => TriggerPopoverState
required
handleKey
method
(key: string) => TriggerPopoverItem | null
required
select
method
(item: TriggerPopoverItem) => string
required
selectCategory
method
(category: string) => boolean
required
setSelectionBehavior
method
(behavior?: TriggerPopoverSelectionBehavior) => void
required
subscribe
method
(listener: () => void) => () => void
required
update
method
(text: string) => boolean
required
Name
applySelection
Kind
method
Type
(text: string, item: TriggerPopoverItem) => string
Requirement
required
Name
char
Kind
property
Type
string
Requirement
required
Name
close
Kind
method
Type
() => void
Requirement
required
Name
getState
Kind
method
Type
() => TriggerPopoverState
Requirement
required
Name
handleKey
Kind
method
Type
(key: string) => TriggerPopoverItem | null
Requirement
required
Name
select
Kind
method
Type
(item: TriggerPopoverItem) => string
Requirement
required
Name
selectCategory
Kind
method
Type
(category: string) => boolean
Requirement
required
Name
setSelectionBehavior
Kind
method
Type
(behavior?: TriggerPopoverSelectionBehavior) => void
Requirement
required
Name
subscribe
Kind
method
Type
(listener: () => void) => () => void
Requirement
required
Name
update
Kind
method
Type
(text: string) => boolean
Requirement
required
DeclarationView source
TriggerPopoverRegistryOptionsts
interface TriggerPopoverRegistryOptions {
readonly char?: string;
readonly adapter: TriggerPopoverAdapter;
}
Name
Kind
Type
Requirement
adapter
property
TriggerPopoverAdapter
required
char
property
string
optional
Name
adapter
Kind
property
Type
TriggerPopoverAdapter
Requirement
required
Name
char
Kind
property
Type
string
Requirement
optional
DeclarationView source
TriggerPopoverSelectionBehaviorts
interface TriggerPopoverSelectionBehavior {
readonly formatter?: TriggerPopoverFormatter;
readonly onInserted?: (item: TriggerPopoverItem) => void;
readonly onExecute?: (item: TriggerPopoverItem) => void;
readonly removeOnExecute?: boolean;
}
Name
Kind
Type
Requirement
formatter
property
TriggerPopoverFormatter
optional
onExecute
property
(item: TriggerPopoverItem) => void
optional
onInserted
property
(item: TriggerPopoverItem) => void
optional
removeOnExecute
property
boolean
optional
Name
formatter
Kind
property
Type
TriggerPopoverFormatter
Requirement
optional
Name
onExecute
Kind
property
Type
(item: TriggerPopoverItem) => void
Requirement
optional
Name
onInserted
Kind
property
Type
(item: TriggerPopoverItem) => void
Requirement
optional
Name
removeOnExecute
Kind
property
Type
boolean
Requirement
optional

tsvToRows

function
DeclarationView source
tsvToRowsts
declare function tsvToRows(text: string, options?: ClipboardTSVOptions): string[][];
Name
Kind
Type
Requirement
text
parameter
string
required
options
parameter
ClipboardTSVOptions
optional
return
return value
string[][]
n/a
Name
text
Kind
parameter
Type
string
Requirement
required
Name
options
Kind
parameter
Type
ClipboardTSVOptions
Requirement
optional
Name
return
Kind
return value
Type
string[][]
Requirement
n/a

TurnAnchor

type
DeclarationView source
TurnAnchorts
type TurnAnchor = {
readonly id: string;
readonly top: number;
};
Name
Kind
Type
Requirement
id
property
string
required
top
property
number
required
Name
id
Kind
property
Type
string
Requirement
required
Name
top
Kind
property
Type
number
Requirement
required
DeclarationView source
TurnAnchorControllerts
type TurnAnchorController = {
register(anchor: TurnAnchor): void;
unregister(id: string): void;
resolveTop(viewportTop: number, footerInset?: number, clamp?: number): number | null;
scrollTo(id: string, options?: Parameters<MessageScrollerController["scrollToMessage"]>[1]): boolean;
};
Name
Kind
Type
Requirement
register
method
(anchor: TurnAnchor) => void
required
resolveTop
method
(viewportTop: number, footerInset?: number, clamp?: number) => number | null
required
scrollTo
method
(id: string, options?: Parameters<MessageScrollerController["scrollToMessage"]>[1]) => boolean
required
unregister
method
(id: string) => void
required
Name
register
Kind
method
Type
(anchor: TurnAnchor) => void
Requirement
required
Name
resolveTop
Kind
method
Type
(viewportTop: number, footerInset?: number, clamp?: number) => number | null
Requirement
required
Name
scrollTo
Kind
method
Type
(id: string, options?: Parameters<MessageScrollerController["scrollToMessage"]>[1]) => boolean
Requirement
required
Name
unregister
Kind
method
Type
(id: string) => void
Requirement
required
DeclarationView source
UrlSanitizeResultts
type UrlSanitizeResult = {
readonly ok: true;
readonly url: string;
} | {
readonly ok: false;
readonly reason: "unsafe-scheme" | "malformed";
};
DeclarationView source
useAssistantDataUIts
export declare const useAssistantDataUI: <TResult = unknown, TData = unknown>(options: DataUIResolverOptions<TResult, TData>) => TResult | null;
Name
Kind
Type
Requirement
options
parameter
DataUIResolverOptions<TResult, TData>
required
return
return value
TResult | null
n/a
Name
options
Kind
parameter
Type
DataUIResolverOptions<TResult, TData>
Requirement
required
Name
return
Kind
return value
Type
TResult | null
Requirement
n/a
DeclarationView source
useAssistantToolts
export declare const useAssistantTool: <T>(definition: T) => T;
Name
Kind
Type
Requirement
definition
parameter
T
required
return
return value
T
n/a
Name
definition
Kind
parameter
Type
T
Requirement
required
Name
return
Kind
return value
Type
T
Requirement
n/a
DeclarationView source
useAssistantToolUIts
export declare const useAssistantToolUI: typeof useInlineRender;
Name
Kind
Type
Requirement
options
parameter
ToolUIResolverOptions<TResult, TPart>
required
return
return value
TResult | string | null
n/a
Name
options
Kind
parameter
Type
ToolUIResolverOptions<TResult, TPart>
Requirement
required
Name
return
Kind
return value
Type
TResult | string | null
Requirement
n/a
DeclarationView source
useInlineRenderts
export declare const useInlineRender: <TResult = unknown, TPart = unknown>(options: ToolUIResolverOptions<TResult, TPart>) => TResult | string | null;
Name
Kind
Type
Requirement
options
parameter
ToolUIResolverOptions<TResult, TPart>
required
return
return value
TResult | string | null
n/a
Name
options
Kind
parameter
Type
ToolUIResolverOptions<TResult, TPart>
Requirement
required
Name
return
Kind
return value
Type
TResult | string | null
Requirement
n/a
DeclarationView source
validateGridRowIdsts
declare function validateGridRowIds<T>(rows: readonly T[], getRowId: (row: T, index: number) => string): readonly DiagnosticObject[];
Name
Kind
Type
Requirement
rows
parameter
readonly T[]
required
getRowId
parameter
(row: T, index: number) => string
required
return
return value
readonly DiagnosticObject[]
n/a
Name
rows
Kind
parameter
Type
readonly T[]
Requirement
required
Name
getRowId
Kind
parameter
Type
(row: T, index: number) => string
Requirement
required
Name
return
Kind
return value
Type
readonly DiagnosticObject[]
Requirement
n/a

VirtualItem

interface
DeclarationView source
VirtualItemts
interface VirtualItem {
readonly index: number;
readonly key: string | number;
readonly start: number;
readonly size: number;
}
Name
Kind
Type
Requirement
index
property
number
required
key
property
string | number
required
size
property
number
required
start
property
number
required
Name
index
Kind
property
Type
number
Requirement
required
Name
key
Kind
property
Type
string | number
Requirement
required
Name
size
Kind
property
Type
number
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required

Virtualizer

interface
DeclarationView source
Virtualizerts
interface Virtualizer {
attach(): void;
destroy(): void;
measureElement(index: number, element: Element): void;
scrollToIndex(index: number, options?: {
readonly align?: "start" | "center" | "end" | "auto";
}): void;
getVirtualWindow(): VirtualWindow;
getVirtualItems(): readonly VirtualItem[];
getTotalSize(): number;
subscribe(listener: () => void): () => void;
listenerCount(): number;
observerCount(): number;
}
Name
Kind
Type
Requirement
attach
method
() => void
required
destroy
method
() => void
required
getTotalSize
method
() => number
required
getVirtualItems
method
() => readonly VirtualItem[]
required
getVirtualWindow
method
() => VirtualWindow
required
listenerCount
method
() => number
required
measureElement
method
(index: number, element: Element) => void
required
observerCount
method
() => number
required
scrollToIndex
method
(index: number, options?: { readonly align?: "start" | "center" | "end" | "auto"; }) => void
required
subscribe
method
(listener: () => void) => () => void
required
Name
attach
Kind
method
Type
() => void
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
getTotalSize
Kind
method
Type
() => number
Requirement
required
Name
getVirtualItems
Kind
method
Type
() => readonly VirtualItem[]
Requirement
required
Name
getVirtualWindow
Kind
method
Type
() => VirtualWindow
Requirement
required
Name
listenerCount
Kind
method
Type
() => number
Requirement
required
Name
measureElement
Kind
method
Type
(index: number, element: Element) => void
Requirement
required
Name
observerCount
Kind
method
Type
() => number
Requirement
required
Name
scrollToIndex
Kind
method
Type
(index: number, options?: { readonly align?: "start" | "center" | "end" | "auto"; }) => void
Requirement
required
Name
subscribe
Kind
method
Type
(listener: () => void) => () => void
Requirement
required

VirtualizerOptions

interface
DeclarationView source
VirtualizerOptionsts
interface VirtualizerOptions {
readonly count: number | (() => number);
readonly getScrollElement: () => HTMLElement | null;
readonly estimateSize: (index: number) => number;
readonly overscan?: number;
readonly horizontal?: boolean;
readonly getItemKey?: (index: number) => string | number;
readonly onChange?: (window: VirtualWindow) => void;
}
Name
Kind
Type
Requirement
count
property
number | (() => number)
required
estimateSize
property
(index: number) => number
required
getItemKey
property
(index: number) => string | number
optional
getScrollElement
property
() => HTMLElement | null
required
horizontal
property
boolean
optional
onChange
property
(window: VirtualWindow) => void
optional
overscan
property
number
optional
Name
count
Kind
property
Type
number | (() => number)
Requirement
required
Name
estimateSize
Kind
property
Type
(index: number) => number
Requirement
required
Name
getItemKey
Kind
property
Type
(index: number) => string | number
Requirement
optional
Name
getScrollElement
Kind
property
Type
() => HTMLElement | null
Requirement
required
Name
horizontal
Kind
property
Type
boolean
Requirement
optional
Name
onChange
Kind
property
Type
(window: VirtualWindow) => void
Requirement
optional
Name
overscan
Kind
property
Type
number
Requirement
optional
DeclarationView source
VirtualWindowts
type VirtualWindow = {
readonly start: number;
readonly end: number;
readonly offsets: readonly number[];
readonly totalSize: number;
};
Name
Kind
Type
Requirement
end
property
number
required
offsets
property
readonly number[]
required
start
property
number
required
totalSize
property
number
required
Name
end
Kind
property
Type
number
Requirement
required
Name
offsets
Kind
property
Type
readonly number[]
Requirement
required
Name
start
Kind
property
Type
number
Requirement
required
Name
totalSize
Kind
property
Type
number
Requirement
required
DeclarationView source
VISIBLE_REGION_ATTRIBUTEts
export declare const VISIBLE_REGION_ATTRIBUTE: "data-aui-visible";
DeclarationView source
VisibleRegionts
type VisibleRegion = {
readonly outerHTML: string;
readonly clickIds: readonly string[];
readonly editIds: readonly string[];
readonly nested: boolean;
readonly truncated: boolean;
};
Name
Kind
Type
Requirement
clickIds
property
readonly string[]
required
editIds
property
readonly string[]
required
nested
property
boolean
required
outerHTML
property
string
required
truncated
property
boolean
required
Name
clickIds
Kind
property
Type
readonly string[]
Requirement
required
Name
editIds
Kind
property
Type
readonly string[]
Requirement
required
Name
nested
Kind
property
Type
boolean
Requirement
required
Name
outerHTML
Kind
property
Type
string
Requirement
required
Name
truncated
Kind
property
Type
boolean
Requirement
required
DeclarationView source
VisibleRegionControllerts
type VisibleRegionController = {
readonly capture: () => VisibleRegion;
readonly click: (id: string) => boolean;
readonly edit: (id: string, value: unknown) => boolean;
readonly dispose: () => void;
};
Name
Kind
Type
Requirement
capture
property
() => VisibleRegion
required
click
property
(id: string) => boolean
required
dispose
property
() => void
required
edit
property
(id: string, value: unknown) => boolean
required
Name
capture
Kind
property
Type
() => VisibleRegion
Requirement
required
Name
click
Kind
property
Type
(id: string) => boolean
Requirement
required
Name
dispose
Kind
property
Type
() => void
Requirement
required
Name
edit
Kind
property
Type
(id: string, value: unknown) => boolean
Requirement
required
DeclarationView source
VisibleRegionElementts
type VisibleRegionElement = {
readonly outerHTML: string;
readonly value?: unknown;
readonly getAttribute?: (name: string) => string | null;
readonly querySelectorAll?: (selector: string) => readonly VisibleRegionElement[];
readonly dispatchEvent?: (event: VisibleRegionEvent) => boolean;
readonly ownerDocument?: {
readonly createEvent?: (type: string) => {
initEvent?: (name: string, bubbles: boolean, cancelable: boolean) => void;
initCustomEvent?: (name: string, bubbles: boolean, cancelable: boolean, detail: unknown) => void;
};
};
};
Name
Kind
Type
Requirement
dispatchEvent
property
(event: VisibleRegionEvent) => boolean
optional
getAttribute
property
(name: string) => string | null
optional
outerHTML
property
string
required
ownerDocument
property
{ readonly createEvent?: (type: string) => { initEvent?: (name: string, bubbles: boolean, cancelable: boolean) => void; initCustomEvent?: (name: string, bubbles: boolean, cancelable: boolean, detail: unknown) => void; }; }
optional
querySelectorAll
property
(selector: string) => readonly VisibleRegionElement[]
optional
value
property
unknown
optional
Name
dispatchEvent
Kind
property
Type
(event: VisibleRegionEvent) => boolean
Requirement
optional
Name
getAttribute
Kind
property
Type
(name: string) => string | null
Requirement
optional
Name
outerHTML
Kind
property
Type
string
Requirement
required
Name
ownerDocument
Kind
property
Type
{ readonly createEvent?: (type: string) => { initEvent?: (name: string, bubbles: boolean, cancelable: boolean) => void; initCustomEvent?: (name: string, bubbles: boolean, cancelable: boolean, detail: unknown) => void; }; }
Requirement
optional
Name
querySelectorAll
Kind
property
Type
(selector: string) => readonly VisibleRegionElement[]
Requirement
optional
Name
value
Kind
property
Type
unknown
Requirement
optional
DeclarationView source
VisibleRegionEventts
type VisibleRegionEvent = {
readonly type: string;
readonly detail?: unknown;
};
Name
Kind
Type
Requirement
detail
property
unknown
optional
type
property
string
required
Name
detail
Kind
property
Type
unknown
Requirement
optional
Name
type
Kind
property
Type
string
Requirement
required
DeclarationView source
VisibleRegionOptionsts
type VisibleRegionOptions = {
readonly maxHtmlLength?: number;
readonly maxInteractionIds?: number;
};
Name
Kind
Type
Requirement
maxHtmlLength
property
number
optional
maxInteractionIds
property
number
optional
Name
maxHtmlLength
Kind
property
Type
number
Requirement
optional
Name
maxInteractionIds
Kind
property
Type
number
Requirement
optional

Layers and overlays

DeclarationView source
activateAssistantModalLayerts
declare function activateAssistantModalLayer(service: AssistantModalService, scope: PartScope, document: Document, options?: Pick<AssistantModalConnectOptions, "modal" | "dissmissOnInteractOutside" | "dismissOnInteractOutside">): () => void;
Name
Kind
Type
Requirement
service
parameter
AssistantModalService
required
scope
parameter
PartScope
required
document
parameter
Document
required
options
parameter
Pick<AssistantModalConnectOptions, "modal" | "dissmissOnInteractOutside" | "dismissOnInteractOutside">
optional
return
return value
() => void
n/a
Name
service
Kind
parameter
Type
AssistantModalService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
document
Kind
parameter
Type
Document
Requirement
required
Name
options
Kind
parameter
Type
Pick<AssistantModalConnectOptions, "modal" | "dissmissOnInteractOutside" | "dismissOnInteractOutside">
Requirement
optional
Name
return
Kind
return value
Type
() => void
Requirement
n/a

Shared overlay activation seam. Component connectors retain their public activation names and machine-specific containment, while this module owns the layer-handle lifecycle and makes the layer stack the only implementation.

DeclarationView source
activateOverlayLayerts
declare function activateOverlayLayer(options: LayerOptions): LayerHandle;
Name
Kind
Type
Requirement
options
parameter
LayerOptions
required
return
return value
LayerHandle
n/a
Name
options
Kind
parameter
Type
LayerOptions
Requirement
required
Name
return
Kind
return value
Type
LayerHandle
Requirement
n/a

LayerHandle

interface
DeclarationView source
LayerHandlets
interface LayerHandle {
/** Idempotent. Pops this layer wherever it sits in the stack; never
* touches focus or scroll beyond releasing this layer's own scroll
* lock (if any) — those are the other managers' jobs. */
release(): void;
}
Name
Kind
Type
Requirement
Description
release
method
() => void
required
Idempotent. Pops this layer wherever it sits in the stack; never touches focus or scroll beyond releasing this layer's own scroll lock (if any) — those are the other managers' jobs.
Name
release
Kind
method
Type
() => void
Requirement
required
Description
Idempotent. Pops this layer wherever it sits in the stack; never touches focus or scroll beyond releasing this layer's own scroll lock (if any) — those are the other managers' jobs.

LayerOptions

interface
DeclarationView source
LayerOptionsts
interface LayerOptions {
/** Dismissal intent — forward to the machine; never mutate state here. */
readonly onDismiss: (reason: "escape" | "outside-click") => void;
/** The layer's containment set: pointerdown inside any of these elements
* is NOT an outside click. Re-evaluated per event (portals/mounting). */
readonly getElements: () => readonly Element[];
/** Document owning the listeners; from the part scope's root — never a
* bare global lookup (shadow-root/iframe safety). */
readonly document: Document;
/** Modal layers also lock scroll while topmost (see lockScroll). */
readonly modal?: boolean;
}
Name
Kind
Type
Requirement
Description
document
property
Document
required
Document owning the listeners; from the part scope's root — never a bare global lookup (shadow-root/iframe safety).
getElements
property
() => readonly Element[]
required
The layer's containment set: pointerdown inside any of these elements is NOT an outside click. Re-evaluated per event (portals/mounting).
modal
property
boolean
optional
Modal layers also lock scroll while topmost (see lockScroll).
onDismiss
property
(reason: "escape" | "outside-click") => void
required
Dismissal intent — forward to the machine; never mutate state here.
Name
document
Kind
property
Type
Document
Requirement
required
Description
Document owning the listeners; from the part scope's root — never a bare global lookup (shadow-root/iframe safety).
Name
getElements
Kind
property
Type
() => readonly Element[]
Requirement
required
Description
The layer's containment set: pointerdown inside any of these elements is NOT an outside click. Re-evaluated per event (portals/mounting).
Name
modal
Kind
property
Type
boolean
Requirement
optional
Description
Modal layers also lock scroll while topmost (see lockScroll).
Name
onDismiss
Kind
property
Type
(reason: "escape" | "outside-click") => void
Requirement
required
Description
Dismissal intent — forward to the machine; never mutate state here.

lockScroll

function
DeclarationView source
lockScrollts
declare function lockScroll(document: Document): ScrollLockHandle;
Name
Kind
Type
Requirement
document
parameter
Document
required
return
return value
ScrollLockHandle
n/a
Name
document
Kind
parameter
Type
Document
Requirement
required
Name
return
Kind
return value
Type
ScrollLockHandle
Requirement
n/a

pushLayer

function
DeclarationView source
pushLayerts
declare function pushLayer(options: LayerOptions): LayerHandle;
Name
Kind
Type
Requirement
options
parameter
LayerOptions
required
return
return value
LayerHandle
n/a
Name
options
Kind
parameter
Type
LayerOptions
Requirement
required
Name
return
Kind
return value
Type
LayerHandle
Requirement
n/a

ScrollLockHandle

interface

Reference-counted scroll lock, per `Document`. Frozen contract: `layers.spec.md`. DOM access is entirely duck-typed against the `document` passed in (including its `defaultView` for `innerWidth` — never a bare global `window` lookup).

DeclarationView source
ScrollLockHandlets
interface ScrollLockHandle {
/** Idempotent per handle. */
release(): void;
}
Name
Kind
Type
Requirement
Description
release
method
() => void
required
Idempotent per handle.
Name
release
Kind
method
Type
() => void
Requirement
required
Description
Idempotent per handle.

Announcements and messages

`AnnouncerMessages` maps a semantic ANNOUNCE key to a formatter function. No default table is provided here — consumers (e.g. the Select connector's locale layer) own their own wording.

DeclarationView source
AnnouncerMessagests
type AnnouncerMessages = Record<string, (params: {
readonly [key: string]: string | number | null;
}) => string>;
DeclarationView source
assistantMessageAnatomyts
export declare const assistantMessageAnatomy: {
readonly scope: "assistant-message";
readonly parts: readonly ["root", "parts", "grouped-parts", "part", "generative-ui", "attachments", "attachment", "error", "quote"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "parts", "grouped-parts", "part", "generative-ui", "attachments", "attachment", "error", "quote"]
required
scope
property
"assistant-message"
required
Name
parts
Kind
property
Type
readonly ["root", "parts", "grouped-parts", "part", "generative-ui", "attachments", "attachment", "error", "quote"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-message"
Requirement
required
DeclarationView source
AssistantMessageApits
interface AssistantMessageApi {
rootProps(): PartProps;
partsProps(): PartProps;
groupedPartsProps(): PartProps;
partProps(index: number): PartProps;
errorProps(): PartProps;
quoteProps(): PartProps;
readonly isHovering: boolean;
}
Name
Kind
Type
Requirement
errorProps
method
() => PartProps
required
groupedPartsProps
method
() => PartProps
required
isHovering
property
boolean
required
partProps
method
(index: number) => PartProps
required
partsProps
method
() => PartProps
required
quoteProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
Name
errorProps
Kind
method
Type
() => PartProps
Requirement
required
Name
groupedPartsProps
Kind
method
Type
() => PartProps
Requirement
required
Name
isHovering
Kind
property
Type
boolean
Requirement
required
Name
partProps
Kind
method
Type
(index: number) => PartProps
Requirement
required
Name
partsProps
Kind
method
Type
() => PartProps
Requirement
required
Name
quoteProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
AssistantMessageConnectOptionsts
interface AssistantMessageConnectOptions {
readonly messageId: string;
readonly role?: "user" | "assistant" | "system";
readonly getIsHovering?: () => boolean;
readonly onHoverChange?: (isHovering: boolean) => void;
}
Name
Kind
Type
Requirement
getIsHovering
property
() => boolean
optional
messageId
property
string
required
onHoverChange
property
(isHovering: boolean) => void
optional
role
property
"user" | "assistant" | "system"
optional
Name
getIsHovering
Kind
property
Type
() => boolean
Requirement
optional
Name
messageId
Kind
property
Type
string
Requirement
required
Name
onHoverChange
Kind
property
Type
(isHovering: boolean) => void
Requirement
optional
Name
role
Kind
property
Type
"user" | "assistant" | "system"
Requirement
optional
DeclarationView source
AssistantMessagePartts
type AssistantMessagePart = (typeof assistantMessageAnatomy.parts)[number];
DeclarationView source
assistantMessagePartAnatomyts
export declare const assistantMessagePartAnatomy: {
readonly scope: "assistant-message-part";
readonly parts: readonly ["root", "text", "image", "in-progress"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "text", "image", "in-progress"]
required
scope
property
"assistant-message-part"
required
Name
parts
Kind
property
Type
readonly ["root", "text", "image", "in-progress"]
Requirement
required
Name
scope
Kind
property
Type
"assistant-message-part"
Requirement
required
DeclarationView source
AssistantMessagePartApits
interface AssistantMessagePartApi {
rootProps(): PartProps;
textProps(): PartProps;
imageProps(): PartProps;
inProgressProps(): PartProps;
readonly status: string | undefined;
}
Name
Kind
Type
Requirement
imageProps
method
() => PartProps
required
inProgressProps
method
() => PartProps
required
rootProps
method
() => PartProps
required
status
property
string | undefined
required
textProps
method
() => PartProps
required
Name
imageProps
Kind
method
Type
() => PartProps
Requirement
required
Name
inProgressProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
status
Kind
property
Type
string | undefined
Requirement
required
Name
textProps
Kind
method
Type
() => PartProps
Requirement
required
DeclarationView source
AssistantMessagePartConnectOptionsts
interface AssistantMessagePartConnectOptions {
readonly index: number;
readonly part: AssistantMessagePartValue;
}
Name
Kind
Type
Requirement
index
property
number
required
part
property
AssistantMessagePartValue
required
Name
index
Kind
property
Type
number
Requirement
required
Name
part
Kind
property
Type
AssistantMessagePartValue
Requirement
required
DeclarationView source
AssistantMessagePartGroupts
type AssistantMessagePartGroup<TPart extends AssistantMessagePartLike = AssistantMessagePartLike> = {
readonly key: string;
readonly type: string;
readonly parts: readonly TPart[];
readonly standalone?: boolean;
};
Name
Kind
Type
Requirement
key
property
string
required
parts
property
readonly TPart[]
required
standalone
property
boolean
optional
type
property
string
required
Name
key
Kind
property
Type
string
Requirement
required
Name
parts
Kind
property
Type
readonly TPart[]
Requirement
required
Name
standalone
Kind
property
Type
boolean
Requirement
optional
Name
type
Kind
property
Type
string
Requirement
required
DeclarationView source
AssistantMessagePartLikets
type AssistantMessagePartLike = {
readonly type: string;
readonly [key: string]: unknown;
};
Name
Kind
Type
Requirement
type
property
string
required
Name
type
Kind
property
Type
string
Requirement
required
DeclarationView source
AssistantMessagePartPartts
type AssistantMessagePartPart = (typeof assistantMessagePartAnatomy.parts)[number];
DeclarationView source
AssistantMessagePartValuets
type AssistantMessagePartValue = {
readonly type: string;
readonly status?: {
readonly type: string;
};
readonly [key: string]: unknown;
};
Name
Kind
Type
Requirement
status
property
{ readonly type: string; }
optional
type
property
string
required
Name
status
Kind
property
Type
{ readonly type: string; }
Requirement
optional
Name
type
Kind
property
Type
string
Requirement
required
DeclarationView source
connectAssistantMessagets
declare function connectAssistantMessage(_client: unknown, scope: PartScope, options: AssistantMessageConnectOptions): AssistantMessageApi;
Name
Kind
Type
Requirement
_client
parameter
unknown
required
scope
parameter
PartScope
required
options
parameter
AssistantMessageConnectOptions
required
return
return value
AssistantMessageApi
n/a
Name
_client
Kind
parameter
Type
unknown
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantMessageConnectOptions
Requirement
required
Name
return
Kind
return value
Type
AssistantMessageApi
Requirement
n/a
DeclarationView source
connectAssistantMessagePartts
declare function connectAssistantMessagePart(scope: PartScope, options: AssistantMessagePartConnectOptions): AssistantMessagePartApi;
Name
Kind
Type
Requirement
scope
parameter
PartScope
required
options
parameter
AssistantMessagePartConnectOptions
required
return
return value
AssistantMessagePartApi
n/a
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
AssistantMessagePartConnectOptions
Requirement
required
Name
return
Kind
return value
Type
AssistantMessagePartApi
Requirement
n/a
DeclarationView source
createLiveRegionAnnouncerts
declare function createLiveRegionAnnouncer(options: LiveRegionAnnouncerOptions): LiveRegionAnnouncer;
Name
Kind
Type
Requirement
options
parameter
LiveRegionAnnouncerOptions
required
return
return value
LiveRegionAnnouncer
n/a
Name
options
Kind
parameter
Type
LiveRegionAnnouncerOptions
Requirement
required
Name
return
Kind
return value
Type
LiveRegionAnnouncer
Requirement
n/a

ExportableMessage

interface
DeclarationView source
ExportableMessagets
interface ExportableMessage {
readonly [key: string]: unknown;
readonly role?: string;
readonly content?: readonly ExportableMessagePart[];
}
Name
Kind
Type
Requirement
content
property
readonly ExportableMessagePart[]
optional
role
property
string
optional
Name
content
Kind
property
Type
readonly ExportableMessagePart[]
Requirement
optional
Name
role
Kind
property
Type
string
Requirement
optional
DeclarationView source
ExportableMessagePartts
interface ExportableMessagePart {
readonly id?: string;
readonly type?: string;
readonly sourceType?: string;
readonly toolCallId?: string;
readonly text?: string;
readonly title?: string;
readonly url?: string;
readonly filename?: string;
readonly image?: string;
readonly data?: unknown;
readonly name?: string;
readonly toolName?: string;
readonly args?: unknown;
readonly result?: unknown;
readonly isError?: boolean;
readonly argsText?: string;
}
Name
Kind
Type
Requirement
args
property
unknown
optional
argsText
property
string
optional
data
property
unknown
optional
filename
property
string
optional
id
property
string
optional
image
property
string
optional
isError
property
boolean
optional
name
property
string
optional
result
property
unknown
optional
sourceType
property
string
optional
text
property
string
optional
title
property
string
optional
toolCallId
property
string
optional
toolName
property
string
optional
Name
args
Kind
property
Type
unknown
Requirement
optional
Name
argsText
Kind
property
Type
string
Requirement
optional
Name
data
Kind
property
Type
unknown
Requirement
optional
Name
filename
Kind
property
Type
string
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
optional
Name
image
Kind
property
Type
string
Requirement
optional
Name
isError
Kind
property
Type
boolean
Requirement
optional
Name
name
Kind
property
Type
string
Requirement
optional
Name
result
Kind
property
Type
unknown
Requirement
optional
Name
sourceType
Kind
property
Type
string
Requirement
optional
Name
text
Kind
property
Type
string
Requirement
optional
Name
title
Kind
property
Type
string
Requirement
optional
Name
toolCallId
Kind
property
Type
string
Requirement
optional
Name
toolName
Kind
property
Type
string
Requirement
optional
Name
type
Kind
property
Type
string
Requirement
optional
Name
url
Kind
property
Type
string
Requirement
optional
DeclarationView source
exportMessageMarkdownts
declare function exportMessageMarkdown(message: ExportableMessage): string;
Name
Kind
Type
Requirement
message
parameter
ExportableMessage
required
return
return value
string
n/a
Name
message
Kind
parameter
Type
ExportableMessage
Requirement
required
Name
return
Kind
return value
Type
string
Requirement
n/a

Adapts a message table into a `format` function; unknown keys fall back to the key itself.

DeclarationView source
formatFromMessagests
declare function formatFromMessages(messages: AnnouncerMessages): (key: string, params: {
readonly [key: string]: string | number | null;
}) => string;
Name
Kind
Type
Requirement
messages
parameter
AnnouncerMessages
required
return
return value
(key: string, params: { readonly [key: string]: string | number | null; }) => string
n/a
Name
messages
Kind
parameter
Type
AnnouncerMessages
Requirement
required
Name
return
Kind
return value
Type
(key: string, params: { readonly [key: string]: string | number | null; }) => string
Requirement
n/a
DeclarationView source
groupMessagePartsts
declare function groupMessageParts<TPart extends AssistantMessagePartLike>(parts: readonly TPart[], options?: GroupMessagePartsOptions): readonly AssistantMessagePartGroup<TPart>[];
Name
Kind
Type
Requirement
parts
parameter
readonly TPart[]
required
options
parameter
GroupMessagePartsOptions
optional
return
return value
readonly AssistantMessagePartGroup<TPart>[]
n/a
Name
parts
Kind
parameter
Type
readonly TPart[]
Requirement
required
Name
options
Kind
parameter
Type
GroupMessagePartsOptions
Requirement
optional
Name
return
Kind
return value
Type
readonly AssistantMessagePartGroup<TPart>[]
Requirement
n/a
DeclarationView source
GroupMessagePartsOptionsts
interface GroupMessagePartsOptions {
readonly groupBy?: (part: AssistantMessagePartLike) => string | null;
readonly groupPartByType?: boolean;
}
Name
Kind
Type
Requirement
groupBy
property
(part: AssistantMessagePartLike) => string | null
optional
groupPartByType
property
boolean
optional
Name
groupBy
Kind
property
Type
(part: AssistantMessagePartLike) => string | null
Requirement
optional
Name
groupPartByType
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
LiveRegionAnnouncerts
interface LiveRegionAnnouncer {
announce(key: string, params: {
readonly [key: string]: string | number | null;
}, politeness: Politeness): void;
destroy(): void;
}
Name
Kind
Type
Requirement
announce
method
(key: string, params: { readonly [key: string]: string | number | null; }, politeness: Politeness) => void
required
destroy
method
() => void
required
Name
announce
Kind
method
Type
(key: string, params: { readonly [key: string]: string | number | null; }, politeness: Politeness) => void
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
DeclarationView source
LiveRegionAnnouncerOptionsts
interface LiveRegionAnnouncerOptions {
readonly root: () => AnnouncerRoot | null;
readonly format: (key: string, params: {
readonly [key: string]: string | number | null;
}) => string;
}
Name
Kind
Type
Requirement
format
property
(key: string, params: { readonly [key: string]: string | number | null; }) => string
required
root
property
() => AnnouncerRoot | null
required
Name
format
Kind
property
Type
(key: string, params: { readonly [key: string]: string | number | null; }) => string
Requirement
required
Name
root
Kind
property
Type
() => AnnouncerRoot | null
Requirement
required
DeclarationView source
markdownDiagnosticMessagests
export declare const markdownDiagnosticMessages: Readonly<Record<MarkdownDiagnosticCode, string>>;
DeclarationView source
McpAppFrameMessagets
type McpAppFrameMessage = {
readonly jsonrpc: "2.0";
readonly id?: string | number;
readonly method?: string;
readonly params?: unknown;
readonly result?: unknown;
readonly error?: {
readonly code: number;
readonly message: string;
readonly data?: unknown;
};
};
Name
Kind
Type
Requirement
error
property
{ readonly code: number; readonly message: string; readonly data?: unknown; }
optional
id
property
string | number
optional
jsonrpc
property
"2.0"
required
method
property
string
optional
params
property
unknown
optional
result
property
unknown
optional
Name
error
Kind
property
Type
{ readonly code: number; readonly message: string; readonly data?: unknown; }
Requirement
optional
Name
id
Kind
property
Type
string | number
Requirement
optional
Name
jsonrpc
Kind
property
Type
"2.0"
Requirement
required
Name
method
Kind
property
Type
string
Requirement
optional
Name
params
Kind
property
Type
unknown
Requirement
optional
Name
result
Kind
property
Type
unknown
Requirement
optional
DeclarationView source
MessageParamsts
type MessageParams = {
readonly [key: string]: string | number | null;
};
DeclarationView source
MessageTablets
type MessageTable = AnnouncerMessages;

resolveMessage

function

Resolve a component message key, allowing consumers to override one entry.

DeclarationView source
resolveMessagets
declare function resolveMessage(defaults: MessageTable, overrides: Partial<MessageTable> | undefined, key: string, params?: MessageParams): string;
Name
Kind
Type
Requirement
defaults
parameter
MessageTable
required
overrides
parameter
Partial<MessageTable> | undefined
required
key
parameter
string
required
params
parameter
MessageParams
optional
return
return value
string
n/a
Name
defaults
Kind
parameter
Type
MessageTable
Requirement
required
Name
overrides
Kind
parameter
Type
Partial<MessageTable> | undefined
Requirement
required
Name
key
Kind
parameter
Type
string
Requirement
required
Name
params
Kind
parameter
Type
MessageParams
Requirement
optional
Name
return
Kind
return value
Type
string
Requirement
n/a

Parts and prop bags

DeclarationView source
applyVisuallyHiddenStylets
declare function applyVisuallyHiddenStyle(style: {
setProperty(name: string, value: string): void;
}): void;
Name
Kind
Type
Requirement
style
parameter
{ setProperty(name: string, value: string): void; }
required
return
return value
void
n/a
Name
style
Kind
parameter
Type
{ setProperty(name: string, value: string): void; }
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a
DeclarationView source
AssistantComposerScopeLikets
interface AssistantComposerScopeLike {
getState(): AssistantComposerStateLike;
subscribe?(listener: () => void): () => void;
setText?(text: string): unknown;
send?(options?: {
readonly steer?: boolean;
}): unknown;
cancel?(): unknown;
setQuote?(quote?: unknown): unknown;
removeAttachment?(id: string): unknown;
endEdit?(): unknown;
}
Name
Kind
Type
Requirement
cancel
method
(() => unknown) | undefined
optional
endEdit
method
(() => unknown) | undefined
optional
getState
method
() => AssistantComposerStateLike
required
removeAttachment
method
((id: string) => unknown) | undefined
optional
send
method
((options?: { readonly steer?: boolean; }) => unknown) | undefined
optional
setQuote
method
((quote?: unknown) => unknown) | undefined
optional
setText
method
((text: string) => unknown) | undefined
optional
subscribe
method
((listener: () => void) => () => void) | undefined
optional
Name
cancel
Kind
method
Type
(() => unknown) | undefined
Requirement
optional
Name
endEdit
Kind
method
Type
(() => unknown) | undefined
Requirement
optional
Name
getState
Kind
method
Type
() => AssistantComposerStateLike
Requirement
required
Name
removeAttachment
Kind
method
Type
((id: string) => unknown) | undefined
Requirement
optional
Name
send
Kind
method
Type
((options?: { readonly steer?: boolean; }) => unknown) | undefined
Requirement
optional
Name
setQuote
Kind
method
Type
((quote?: unknown) => unknown) | undefined
Requirement
optional
Name
setText
Kind
method
Type
((text: string) => unknown) | undefined
Requirement
optional
Name
subscribe
Kind
method
Type
((listener: () => void) => () => void) | undefined
Requirement
optional
DeclarationView source
AssistantComposerStateLikets
interface AssistantComposerStateLike {
readonly value?: string;
readonly text?: string;
readonly mode?: "new" | "edit";
readonly isEmpty?: boolean;
readonly isEditing?: boolean;
readonly canSend?: boolean;
readonly canCancel?: boolean;
readonly isSendDisabled?: boolean;
readonly quote?: unknown;
readonly attachments?: readonly AssistantComposerAttachmentLike[];
readonly dictation?: {
readonly transcript?: string;
readonly isActive?: boolean;
readonly inputDisabled?: boolean;
};
readonly queue?: {
readonly items?: readonly unknown[];
};
readonly context?: {
readonly text?: string;
readonly mode?: "new" | "edit";
readonly isSendDisabled?: boolean;
readonly quote?: unknown;
};
}
Name
Kind
Type
Requirement
attachments
property
readonly AssistantComposerAttachmentLike[]
optional
canCancel
property
boolean
optional
canSend
property
boolean
optional
context
property
{ readonly text?: string; readonly mode?: "new" | "edit"; readonly isSendDisabled?: boolean; readonly quote?: unknown; }
optional
dictation
property
{ readonly transcript?: string; readonly isActive?: boolean; readonly inputDisabled?: boolean; }
optional
isEditing
property
boolean
optional
isEmpty
property
boolean
optional
isSendDisabled
property
boolean
optional
mode
property
"new" | "edit"
optional
queue
property
{ readonly items?: readonly unknown[]; }
optional
quote
property
unknown
optional
text
property
string
optional
value
property
string
optional
Name
attachments
Kind
property
Type
readonly AssistantComposerAttachmentLike[]
Requirement
optional
Name
canCancel
Kind
property
Type
boolean
Requirement
optional
Name
canSend
Kind
property
Type
boolean
Requirement
optional
Name
context
Kind
property
Type
{ readonly text?: string; readonly mode?: "new" | "edit"; readonly isSendDisabled?: boolean; readonly quote?: unknown; }
Requirement
optional
Name
dictation
Kind
property
Type
{ readonly transcript?: string; readonly isActive?: boolean; readonly inputDisabled?: boolean; }
Requirement
optional
Name
isEditing
Kind
property
Type
boolean
Requirement
optional
Name
isEmpty
Kind
property
Type
boolean
Requirement
optional
Name
isSendDisabled
Kind
property
Type
boolean
Requirement
optional
Name
mode
Kind
property
Type
"new" | "edit"
Requirement
optional
Name
queue
Kind
property
Type
{ readonly items?: readonly unknown[]; }
Requirement
optional
Name
quote
Kind
property
Type
unknown
Requirement
optional
Name
text
Kind
property
Type
string
Requirement
optional
Name
value
Kind
property
Type
string
Requirement
optional
DeclarationView source
AssistantMcpAddFormStatets
type AssistantMcpAddFormState = {
readonly status: AssistantMcpAddFormStatus;
readonly values: Readonly<Record<string, unknown>>;
readonly error?: unknown;
};
Name
Kind
Type
Requirement
error
property
unknown
optional
status
property
AssistantMcpAddFormStatus
required
values
property
Readonly<Record<string, unknown>>
required
Name
error
Kind
property
Type
unknown
Requirement
optional
Name
status
Kind
property
Type
AssistantMcpAddFormStatus
Requirement
required
Name
values
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
required
DeclarationView source
AssistantMcpConnectionStatets
type AssistantMcpConnectionState = "disconnected" | "connecting" | "connected" | "error";
DeclarationView source
AssistantMcpElicitationStatets
type AssistantMcpElicitationState = {
readonly status: AssistantMcpElicitationStatus;
readonly request: unknown;
readonly response?: unknown;
};
Name
Kind
Type
Requirement
request
property
unknown
required
response
property
unknown
optional
status
property
AssistantMcpElicitationStatus
required
Name
request
Kind
property
Type
unknown
Requirement
required
Name
response
Kind
property
Type
unknown
Requirement
optional
Name
status
Kind
property
Type
AssistantMcpElicitationStatus
Requirement
required
DeclarationView source
AssistantMcpManagerStatets
type AssistantMcpManagerState = {
readonly servers: readonly AssistantMcpServerState[];
readonly isHydrated: boolean;
};
Name
Kind
Type
Requirement
isHydrated
property
boolean
required
servers
property
readonly AssistantMcpServerState[]
required
Name
isHydrated
Kind
property
Type
boolean
Requirement
required
Name
servers
Kind
property
Type
readonly AssistantMcpServerState[]
Requirement
required
DeclarationView source
AssistantMcpServerStatets
type AssistantMcpServerState = {
readonly serverId: string;
readonly name?: string;
readonly connectionState: AssistantMcpConnectionState;
readonly tools: readonly string[];
readonly error?: unknown;
};
Name
Kind
Type
Requirement
connectionState
property
AssistantMcpConnectionState
required
error
property
unknown
optional
name
property
string
optional
serverId
property
string
required
tools
property
readonly string[]
required
Name
connectionState
Kind
property
Type
AssistantMcpConnectionState
Requirement
required
Name
error
Kind
property
Type
unknown
Requirement
optional
Name
name
Kind
property
Type
string
Requirement
optional
Name
serverId
Kind
property
Type
string
Requirement
required
Name
tools
Kind
property
Type
readonly string[]
Requirement
required
DeclarationView source
ClassifiedPartPropsts
interface ClassifiedPartProps {
readonly attrs: PartProps;
readonly events: Readonly<Record<string, unknown>>;
readonly ref: unknown;
}
Name
Kind
Type
Requirement
attrs
property
PartProps
required
events
property
Readonly<Record<string, unknown>>
required
ref
property
unknown
required
Name
attrs
Kind
property
Type
PartProps
Requirement
required
Name
events
Kind
property
Type
Readonly<Record<string, unknown>>
Requirement
required
Name
ref
Kind
property
Type
unknown
Requirement
required

Splits framework-neutral connector props into attrs, events, and ref.

DeclarationView source
classifyPartPropsts
declare function classifyPartProps(props: PartProps): ClassifiedPartProps;
Name
Kind
Type
Requirement
props
parameter
PartProps
required
return
return value
ClassifiedPartProps
n/a
Name
props
Kind
parameter
Type
PartProps
Requirement
required
Name
return
Kind
return value
Type
ClassifiedPartProps
Requirement
n/a

ClipboardState

interface
DeclarationView source
ClipboardStatets
interface ClipboardState {
readonly copied: boolean;
readonly text?: string;
}
Name
Kind
Type
Requirement
copied
property
boolean
required
text
property
string
optional
Name
copied
Kind
property
Type
boolean
Requirement
required
Name
text
Kind
property
Type
string
Requirement
optional

createPartScope

function
DeclarationView source
createPartScopets
declare function createPartScope(options: {
seed: string;
root?: () => Document | ShadowRoot | HTMLElement | null;
}): PartScope;
Name
Kind
Type
Requirement
options
parameter
{ seed: string; root?: () => Document | ShadowRoot | HTMLElement | null; }
required
return
return value
PartScope
n/a
Name
options
Kind
parameter
Type
{ seed: string; root?: () => Document | ShadowRoot | HTMLElement | null; }
Requirement
required
Name
return
Kind
return value
Type
PartScope
Requirement
n/a

createScopeSeed

function
DeclarationView source
createScopeSeedts
declare function createScopeSeed(counterRef?: {
current: number;
}): string;
Name
Kind
Type
Requirement
counterRef
parameter
{ current: number; }
optional
return
return value
string
n/a
Name
counterRef
Kind
parameter
Type
{ current: number; }
Requirement
optional
Name
return
Kind
return value
Type
string
Requirement
n/a

dataState

function

Shared boolean-to-data-state vocabulary used by headless connectors.

DeclarationView source
dataStatets
declare function dataState<TOpen extends string = "open", TClosed extends string = "closed">(value: boolean, open?: TOpen, closed?: TClosed): TOpen | TClosed;
Name
Kind
Type
Requirement
value
parameter
boolean
required
open
parameter
TOpen
optional
closed
parameter
TClosed
optional
return
return value
TOpen | TClosed
n/a
Name
value
Kind
parameter
Type
boolean
Requirement
required
Name
open
Kind
parameter
Type
TOpen
Requirement
optional
Name
closed
Kind
parameter
Type
TClosed
Requirement
optional
Name
return
Kind
return value
Type
TOpen | TClosed
Requirement
n/a
DeclarationView source
DragControllerStatets
interface DragControllerState {
readonly phase: DragPhase;
readonly dragging: boolean;
readonly origin: {
readonly x: number;
readonly y: number;
} | null;
readonly point: {
readonly x: number;
readonly y: number;
} | null;
}
Name
Kind
Type
Requirement
dragging
property
boolean
required
origin
property
{ readonly x: number; readonly y: number; } | null
required
phase
property
DragPhase
required
point
property
{ readonly x: number; readonly y: number; } | null
required
Name
dragging
Kind
property
Type
boolean
Requirement
required
Name
origin
Kind
property
Type
{ readonly x: number; readonly y: number; } | null
Requirement
required
Name
phase
Kind
property
Type
DragPhase
Requirement
required
Name
point
Kind
property
Type
{ readonly x: number; readonly y: number; } | null
Requirement
required
DeclarationView source
hiddenInputDescriptorts
declare function hiddenInputDescriptor(options: {
name?: string;
value: string | undefined;
disabled?: boolean;
required?: boolean;
}): HiddenInputDescriptor;
Name
Kind
Type
Requirement
options
parameter
{ name?: string; value: string | undefined; disabled?: boolean; required?: boolean; }
required
return
return value
HiddenInputDescriptor
n/a
Name
options
Kind
parameter
Type
{ name?: string; value: string | undefined; disabled?: boolean; required?: boolean; }
Requirement
required
Name
return
Kind
return value
Type
HiddenInputDescriptor
Requirement
n/a

Hidden form input descriptor (framework adapters render it).

DeclarationView source
HiddenInputDescriptorts
interface HiddenInputDescriptor {
readonly name: string | undefined;
readonly value: string;
readonly disabled: boolean;
readonly required: boolean;
/** Functional visually-hidden styling only — no aesthetic values. */
readonly style: {
readonly [property: string]: string;
};
}
Name
Kind
Type
Requirement
Description
disabled
property
boolean
required
name
property
string | undefined
required
required
property
boolean
required
style
property
{ readonly [property: string]: string; }
required
Functional visually-hidden styling only — no aesthetic values.
value
property
string
required
Name
disabled
Kind
property
Type
boolean
Requirement
required
Description
Name
name
Kind
property
Type
string | undefined
Requirement
required
Description
Name
required
Kind
property
Type
boolean
Requirement
required
Description
Name
style
Kind
property
Type
{ readonly [property: string]: string; }
Requirement
required
Description
Functional visually-hidden styling only — no aesthetic values.
Name
value
Kind
property
Type
string
Requirement
required
Description

hiddenInputProps

function
DeclarationView source
hiddenInputPropsts
declare function hiddenInputProps(options: {
descriptor: HiddenInputDescriptor;
scope: PartScope;
dataScope: string;
extra?: PartProps;
}): PartProps;
Name
Kind
Type
Requirement
options
parameter
{ descriptor: HiddenInputDescriptor; scope: PartScope; dataScope: string; extra?: PartProps; }
required
return
return value
PartProps
n/a
Name
options
Kind
parameter
Type
{ descriptor: HiddenInputDescriptor; scope: PartScope; dataScope: string; extra?: PartProps; }
Requirement
required
Name
return
Kind
return value
Type
PartProps
Requirement
n/a

IncrementalState

interface
DeclarationView source
IncrementalStatets
interface IncrementalState {
readonly source: string;
readonly blocks: readonly BlockNode[];
readonly openBlockStart: number;
}
Name
Kind
Type
Requirement
blocks
property
readonly BlockNode[]
required
openBlockStart
property
number
required
source
property
string
required
Name
blocks
Kind
property
Type
readonly BlockNode[]
Requirement
required
Name
openBlockStart
Kind
property
Type
number
Requirement
required
Name
source
Kind
property
Type
string
Requirement
required

mergeProps

value
DeclarationView source
mergePropsts
export declare const mergeProps: MergeProps;
Name
Kind
Type
Requirement
internal
parameter
PartProps
required
consumer
parameter
PartProps
required
options
parameter
{ onProtectedOverride?: (key: string) => void; }
optional
return
return value
PartProps
n/a
Name
internal
Kind
parameter
Type
PartProps
Requirement
required
Name
consumer
Kind
parameter
Type
PartProps
Requirement
required
Name
options
Kind
parameter
Type
{ onProtectedOverride?: (key: string) => void; }
Requirement
optional
Name
return
Kind
return value
Type
PartProps
Requirement
n/a

MergeProps

type

The locked mergeProps rule (platform plan, verbatim): consumer handlers run first; `preventDefault()` suppresses the internal handler; refs are composed; class/style values are merged; machine-owned IDs and ARIA references cannot be silently overwritten. Signature: internal (machine-owned) props first, consumer overrides second. Returns one merged bag. `id`, `aria-*` relationship attributes (`aria-labelledby`, `aria-describedby`, `aria-controls`, `aria-activedescendant`) from the internal bag win over consumer values; a consumer attempt to override them is reported via the optional `onProtectedOverride` hook (development aid) and ignored.

DeclarationView source
MergePropsts
type MergeProps = (internal: PartProps, consumer: PartProps, options?: {
onProtectedOverride?: (key: string) => void;
}) => PartProps;

PartProps

interface

Framework-neutral prop bag. Event handlers are `on`-prefixed functions; `ref` is a composition-ready callback; everything else is a plain attribute/property value.

DeclarationView source
PartPropsts
interface PartProps {
readonly [key: string]: unknown;
}

PartScope

interface

Core platform contracts for `@grassroot/ui-headless-core` — frozen by the orchestrator before implementation (phase 3). Implementations must satisfy these shapes exactly; changing this file is a contract change and stops dependent work. The platform plan's explicit part scope. No global getElementById lookups.

DeclarationView source
PartScopets
interface PartScope {
/** Stable, SSR-safe id for a part (optionally keyed, e.g. items). */
id(part: string, key?: string): string;
/** Ref callback that registers/unregisters the part's element. */
register(part: string, key?: string): (node: Element | null) => void;
/** Scoped lookup — never a document-wide query. */
get(part: string, key?: string): Element | null;
/**
* Subscribe to registration changes. The returned cleanup is idempotent;
* registration callbacks invoke listeners only after the scoped registry
* has actually changed.
*/
subscribe(listener: () => void): () => void;
/** The root the scope is mounted under (document, shadow root or element). */
root(): Document | ShadowRoot | HTMLElement | null;
}
Name
Kind
Type
Requirement
Description
get
method
(part: string, key?: string) => Element | null
required
Scoped lookup — never a document-wide query.
id
method
(part: string, key?: string) => string
required
Stable, SSR-safe id for a part (optionally keyed, e.g. items).
register
method
(part: string, key?: string) => (node: Element | null) => void
required
Ref callback that registers/unregisters the part's element.
root
method
() => Document | ShadowRoot | HTMLElement | null
required
The root the scope is mounted under (document, shadow root or element).
subscribe
method
(listener: () => void) => () => void
required
Subscribe to registration changes. The returned cleanup is idempotent; registration callbacks invoke listeners only after the scoped registry has actually changed.
Name
get
Kind
method
Type
(part: string, key?: string) => Element | null
Requirement
required
Description
Scoped lookup — never a document-wide query.
Name
id
Kind
method
Type
(part: string, key?: string) => string
Requirement
required
Description
Stable, SSR-safe id for a part (optionally keyed, e.g. items).
Name
register
Kind
method
Type
(part: string, key?: string) => (node: Element | null) => void
Requirement
required
Description
Ref callback that registers/unregisters the part's element.
Name
root
Kind
method
Type
() => Document | ShadowRoot | HTMLElement | null
Requirement
required
Description
The root the scope is mounted under (document, shadow root or element).
Name
subscribe
Kind
method
Type
(listener: () => void) => () => void
Requirement
required
Description
Subscribe to registration changes. The returned cleanup is idempotent; registration callbacks invoke listeners only after the scoped registry has actually changed.
DeclarationView source
SelectionObserverStatets
interface SelectionObserverState {
readonly visible: boolean;
readonly selection: SelectionObserverSelection | null;
}
Name
Kind
Type
Requirement
selection
property
SelectionObserverSelection | null
required
visible
property
boolean
required
Name
selection
Kind
property
Type
SelectionObserverSelection | null
Requirement
required
Name
visible
Kind
property
Type
boolean
Requirement
required
DeclarationView source
ThreadViewportStatets
type ThreadViewportState = {
readonly following: boolean;
readonly atBottom: boolean;
readonly suspended: boolean;
};
Name
Kind
Type
Requirement
atBottom
property
boolean
required
following
property
boolean
required
suspended
property
boolean
required
Name
atBottom
Kind
property
Type
boolean
Requirement
required
Name
following
Kind
property
Type
boolean
Requirement
required
Name
suspended
Kind
property
Type
boolean
Requirement
required
DeclarationView source
TriggerPopoverStatets
interface TriggerPopoverState {
readonly open: boolean;
readonly query: string;
readonly category: string | undefined;
readonly items: readonly TriggerPopoverItem[];
readonly activeIndex: number;
}
Name
Kind
Type
Requirement
activeIndex
property
number
required
category
property
string | undefined
required
items
property
readonly TriggerPopoverItem[]
required
open
property
boolean
required
query
property
string
required
Name
activeIndex
Kind
property
Type
number
Requirement
required
Name
category
Kind
property
Type
string | undefined
Requirement
required
Name
items
Kind
property
Type
readonly TriggerPopoverItem[]
Requirement
required
Name
open
Kind
property
Type
boolean
Requirement
required
Name
query
Kind
property
Type
string
Requirement
required
DeclarationView source
visuallyHiddenStylets
export declare const visuallyHiddenStyle: {
readonly [property: string]: string;
};

Command runners

Resolves UI command intents through a mounted part scope. Unresolvable commands (unmounted part, SSR) are silent no-ops — machines never learn about the DOM. Announcements are delegated to the provided announcer.

DeclarationView source
CommandRunnerts
type CommandRunner = (command: UiCommand, scope: PartScope, options?: {
announce?: (key: string, params: {
readonly [key: string]: string | number | null;
}, politeness: "polite" | "assertive") => void;
}) => void;

The one shared promise boundary for every Grid mount.

DeclarationView source
createGridRemoteRunCommandts
declare function createGridRemoteRunCommand<T>(options: GridRemoteRunCommandOptions<T>): RunCommand<GridCommand, GridEvent>;
Name
Kind
Type
Requirement
options
parameter
GridRemoteRunCommandOptions<T>
required
return
return value
RunCommand<GridCommand, GridEvent>
n/a
Name
options
Kind
parameter
Type
GridRemoteRunCommandOptions<T>
Requirement
required
Name
return
Kind
return value
Type
RunCommand<GridCommand, GridEvent>
Requirement
n/a
DeclarationView source
GridRemoteRunCommandOptionsts
type GridRemoteRunCommandOptions<T> = {
readonly dataSource: GridDataSource<T>;
readonly sidecar: GridRemoteRows<T>;
readonly scheduler?: Scheduler;
readonly next?: RunCommand<GridCommand, GridEvent>;
readonly onDiagnostic?: (diagnostic: DiagnosticObject) => void;
};
Name
Kind
Type
Requirement
dataSource
property
GridDataSource<T>
required
next
property
RunCommand<GridCommand, GridEvent>
optional
onDiagnostic
property
(diagnostic: DiagnosticObject) => void
optional
scheduler
property
Scheduler
optional
sidecar
property
GridRemoteRows<T>
required
Name
dataSource
Kind
property
Type
GridDataSource<T>
Requirement
required
Name
next
Kind
property
Type
RunCommand<GridCommand, GridEvent>
Requirement
optional
Name
onDiagnostic
Kind
property
Type
(diagnostic: DiagnosticObject) => void
Requirement
optional
Name
scheduler
Kind
property
Type
Scheduler
Requirement
optional
Name
sidecar
Kind
property
Type
GridRemoteRows<T>
Requirement
required
DeclarationView source
runAssistantModalCommandts
declare function runAssistantModalCommand(command: PopoverCommand, options?: {
readonly onOpenChange?: (detail: {
open: boolean;
reason: PopoverChangeReason;
}) => void;
}): void;
Name
Kind
Type
Requirement
command
parameter
PopoverCommand
required
options
parameter
{ readonly onOpenChange?: (detail: { open: boolean; reason: PopoverChangeReason; }) => void; }
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
PopoverCommand
Requirement
required
Name
options
Kind
parameter
Type
{ readonly onOpenChange?: (detail: { open: boolean; reason: PopoverChangeReason; }) => void; }
Requirement
optional
Name
return
Kind
return value
Type
void
Requirement
n/a

runGridCommand

function
DeclarationView source
runGridCommandts
declare function runGridCommand<T>(command: GridCommand, options: GridConnectOptions<T>, _service: GridService<T>): void;
Name
Kind
Type
Requirement
command
parameter
GridCommand
required
options
parameter
GridConnectOptions<T>
required
_service
parameter
GridService<T>
required
return
return value
void
n/a
Name
command
Kind
parameter
Type
GridCommand
Requirement
required
Name
options
Kind
parameter
Type
GridConnectOptions<T>
Requirement
required
Name
_service
Kind
parameter
Type
GridService<T>
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a

runUiCommand

value
DeclarationView source
runUiCommandts
export declare const runUiCommand: CommandRunner;
Name
Kind
Type
Requirement
command
parameter
UiCommand
required
scope
parameter
PartScope
required
options
parameter
{ announce?: (key: string, params: { readonly [key: string]: string | number | null; }, politeness: "polite" | "assertive") => void; }
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
UiCommand
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
{ announce?: (key: string, params: { readonly [key: string]: string | number | null; }, politeness: "polite" | "assertive") => void; }
Requirement
optional
Name
return
Kind
return value
Type
void
Requirement
n/a

UiCommand

type

UI command intents resolved by the headless command runner (Select set).

DeclarationView source
UiCommandts
type UiCommand = {
readonly type: "FOCUS_PART";
readonly part: string;
} | {
readonly type: "FOCUS_ITEM";
readonly key: string;
} | {
readonly type: "SCROLL_ITEM_INTO_VIEW";
readonly key: string;
} | {
readonly type: "ANNOUNCE";
readonly key: string;
readonly params: {
readonly [key: string]: string | number | null;
};
readonly politeness: "polite" | "assertive";
};

Keyboard and focus

FocusTrapHandle

interface
DeclarationView source
FocusTrapHandlets
interface FocusTrapHandle {
/** Idempotent. Removes the container's keydown listener and the
* document's focusin reclaim listener, and restores focus per the
* `returnFocus` rule. */
release(): void;
}
Name
Kind
Type
Requirement
Description
release
method
() => void
required
Idempotent. Removes the container's keydown listener and the document's focusin reclaim listener, and restores focus per the `returnFocus` rule.
Name
release
Kind
method
Type
() => void
Requirement
required
Description
Idempotent. Removes the container's keydown listener and the document's focusin reclaim listener, and restores focus per the `returnFocus` rule.

FocusTrapOptions

interface
DeclarationView source
FocusTrapOptionsts
interface FocusTrapOptions {
/** Element to focus on trap; default first tabbable, else the container
* itself (given tabindex="-1" if it has none). */
readonly initialFocus?: () => HTMLElement | null;
/** Element to restore on release; default the element focused at trap
* time. Restored only if the candidate still has a callable `focus`
* function (not merely `isConnected`). Returning `null` explicitly opts
* OUT of restoration entirely; only an absent option (or a `undefined`
* return) falls back to the previously-focused element. */
readonly returnFocus?: () => HTMLElement | null;
}
Name
Kind
Type
Requirement
Description
initialFocus
property
() => HTMLElement | null
optional
Element to focus on trap; default first tabbable, else the container itself (given tabindex="-1" if it has none).
returnFocus
property
() => HTMLElement | null
optional
Element to restore on release; default the element focused at trap time. Restored only if the candidate still has a callable `focus` function (not merely `isConnected`). Returning `null` explicitly opts OUT of restoration entirely; only an absent option (or a `undefined` return) falls back to the previously-focused element.
Name
initialFocus
Kind
property
Type
() => HTMLElement | null
Requirement
optional
Description
Element to focus on trap; default first tabbable, else the container itself (given tabindex="-1" if it has none).
Name
returnFocus
Kind
property
Type
() => HTMLElement | null
Requirement
optional
Description
Element to restore on release; default the element focused at trap time. Restored only if the candidate still has a callable `focus` function (not merely `isConnected`). Returning `null` explicitly opts OUT of restoration entirely; only an absent option (or a `undefined` return) falls back to the previously-focused element.
DeclarationView source
gridKeyboardEventts
declare function gridKeyboardEvent(event: GridKeyboardEventLike, position: GridKeyboardPosition, rowCount: number, columnCount: number): GridKeyboardResult | null;
Name
Kind
Type
Requirement
event
parameter
GridKeyboardEventLike
required
position
parameter
GridKeyboardPosition
required
rowCount
parameter
number
required
columnCount
parameter
number
required
return
return value
GridKeyboardResult | null
n/a
Name
event
Kind
parameter
Type
GridKeyboardEventLike
Requirement
required
Name
position
Kind
parameter
Type
GridKeyboardPosition
Requirement
required
Name
rowCount
Kind
parameter
Type
number
Requirement
required
Name
columnCount
Kind
parameter
Type
number
Requirement
required
Name
return
Kind
return value
Type
GridKeyboardResult | null
Requirement
n/a
DeclarationView source
GridKeyboardEventLikets
type GridKeyboardEventLike = {
readonly key?: string;
readonly ctrlKey?: boolean;
readonly metaKey?: boolean;
readonly shiftKey?: boolean;
preventDefault?: () => void;
};
Name
Kind
Type
Requirement
ctrlKey
property
boolean
optional
key
property
string
optional
metaKey
property
boolean
optional
preventDefault
property
() => void
optional
shiftKey
property
boolean
optional
Name
ctrlKey
Kind
property
Type
boolean
Requirement
optional
Name
key
Kind
property
Type
string
Requirement
optional
Name
metaKey
Kind
property
Type
boolean
Requirement
optional
Name
preventDefault
Kind
property
Type
() => void
Requirement
optional
Name
shiftKey
Kind
property
Type
boolean
Requirement
optional
DeclarationView source
GridKeyboardPositionts
type GridKeyboardPosition = {
readonly rowIndex: number;
readonly columnIndex: number;
};
Name
Kind
Type
Requirement
columnIndex
property
number
required
rowIndex
property
number
required
Name
columnIndex
Kind
property
Type
number
Requirement
required
Name
rowIndex
Kind
property
Type
number
Requirement
required
DeclarationView source
GridKeyboardResultts
type GridKeyboardResult = {
readonly direction: GridFocusDirection;
readonly extend?: boolean;
};
Name
Kind
Type
Requirement
direction
property
GridFocusDirection
required
extend
property
boolean
optional
Name
direction
Kind
property
Type
GridFocusDirection
Requirement
required
Name
extend
Kind
property
Type
boolean
Requirement
optional

isFocusEscaped

function
DeclarationView source
isFocusEscapedts
declare function isFocusEscaped(container: MinimalContainerLike, active: unknown): boolean;
Name
Kind
Type
Requirement
container
parameter
MinimalContainerLike
required
active
parameter
unknown
required
return
return value
boolean
n/a
Name
container
Kind
parameter
Type
MinimalContainerLike
Requirement
required
Name
active
Kind
parameter
Type
unknown
Requirement
required
Name
return
Kind
return value
Type
boolean
Requirement
n/a
DeclarationView source
isKeyboardEventLikets
declare function isKeyboardEventLike(value: unknown): value is KeyboardEventLike;
Name
Kind
Type
Requirement
value
parameter
unknown
required
return
return value
value is KeyboardEventLike
n/a
Name
value
Kind
parameter
Type
unknown
Requirement
required
Name
return
Kind
return value
Type
value is KeyboardEventLike
Requirement
n/a

isPartEventKey

function
DeclarationView source
isPartEventKeyts
declare function isPartEventKey(key: string): boolean;
Name
Kind
Type
Requirement
key
parameter
string
required
return
return value
boolean
n/a
Name
key
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
boolean
Requirement
n/a

isTypeaheadKey

function
DeclarationView source
isTypeaheadKeyts
declare function isTypeaheadKey(event: KeyboardEventLike): boolean;
Name
Kind
Type
Requirement
event
parameter
KeyboardEventLike
required
return
return value
boolean
n/a
Name
event
Kind
parameter
Type
KeyboardEventLike
Requirement
required
Name
return
Kind
return value
Type
boolean
Requirement
n/a

KeyboardEventLike

interface

Minimal event surface shared by connector keyboard handlers.

DeclarationView source
KeyboardEventLikets
interface KeyboardEventLike {
readonly key: string;
readonly ctrlKey?: boolean;
readonly metaKey?: boolean;
readonly altKey?: boolean;
readonly shiftKey?: boolean;
readonly isComposing?: boolean;
readonly keyCode?: number;
readonly defaultPrevented?: boolean;
readonly target?: unknown;
readonly currentTarget?: unknown;
preventDefault(): void;
}
Name
Kind
Type
Requirement
altKey
property
boolean
optional
ctrlKey
property
boolean
optional
currentTarget
property
unknown
optional
defaultPrevented
property
boolean
optional
isComposing
property
boolean
optional
key
property
string
required
keyCode
property
number
optional
metaKey
property
boolean
optional
preventDefault
method
() => void
required
shiftKey
property
boolean
optional
target
property
unknown
optional
Name
altKey
Kind
property
Type
boolean
Requirement
optional
Name
ctrlKey
Kind
property
Type
boolean
Requirement
optional
Name
currentTarget
Kind
property
Type
unknown
Requirement
optional
Name
defaultPrevented
Kind
property
Type
boolean
Requirement
optional
Name
isComposing
Kind
property
Type
boolean
Requirement
optional
Name
key
Kind
property
Type
string
Requirement
required
Name
keyCode
Kind
property
Type
number
Requirement
optional
Name
metaKey
Kind
property
Type
boolean
Requirement
optional
Name
preventDefault
Kind
method
Type
() => void
Requirement
required
Name
shiftKey
Kind
property
Type
boolean
Requirement
optional
Name
target
Kind
property
Type
unknown
Requirement
optional
DeclarationView source
KeydownActionts
type KeydownAction = "next" | "previous" | "first" | "last" | "select" | "typeahead";
DeclarationView source
KeydownTablets
type KeydownTable = Readonly<Record<string, KeydownAction>>;
DeclarationView source
menuKeydownTablets
export declare const menuKeydownTable: KeydownTable;
DeclarationView source
PART_EVENT_KEY_REts
export declare const PART_EVENT_KEY_RE: RegExp;

Restores focus only when the candidate still has a callable `focus` function — `isConnected` alone is insufficient (a candidate might be a plain stand-in with no live DOM presence at all).

DeclarationView source
resolveFocusReturnTargetts
declare function resolveFocusReturnTarget(candidate: unknown): MinimalTabbableLike | null;
Name
Kind
Type
Requirement
candidate
parameter
unknown
required
return
return value
MinimalTabbableLike | null
n/a
Name
candidate
Kind
parameter
Type
unknown
Requirement
required
Name
return
Kind
return value
Type
MinimalTabbableLike | null
Requirement
n/a
DeclarationView source
resolveGridKeyboardTargetts
declare function resolveGridKeyboardTarget(result: GridKeyboardResult, position: GridKeyboardPosition, rowCount: number, columnCount: number): GridKeyboardPosition;
Name
Kind
Type
Requirement
result
parameter
GridKeyboardResult
required
position
parameter
GridKeyboardPosition
required
rowCount
parameter
number
required
columnCount
parameter
number
required
return
return value
GridKeyboardPosition
n/a
Name
result
Kind
parameter
Type
GridKeyboardResult
Requirement
required
Name
position
Kind
parameter
Type
GridKeyboardPosition
Requirement
required
Name
rowCount
Kind
parameter
Type
number
Requirement
required
Name
columnCount
Kind
parameter
Type
number
Requirement
required
Name
return
Kind
return value
Type
GridKeyboardPosition
Requirement
n/a
DeclarationView source
resolveInitialFocusTargetts
declare function resolveInitialFocusTarget(container: MinimalContainerLike): MinimalTabbableLike;
Name
Kind
Type
Requirement
container
parameter
MinimalContainerLike
required
return
return value
MinimalTabbableLike
n/a
Name
container
Kind
parameter
Type
MinimalContainerLike
Requirement
required
Name
return
Kind
return value
Type
MinimalTabbableLike
Requirement
n/a
DeclarationView source
resolveKeydownTablets
declare function resolveKeydownTable(event: KeyboardEventLike, table: KeydownTable, allowTypeahead?: boolean): KeydownAction | null;
Name
Kind
Type
Requirement
event
parameter
KeyboardEventLike
required
table
parameter
KeydownTable
required
allowTypeahead
parameter
boolean
optional
return
return value
KeydownAction | null
n/a
Name
event
Kind
parameter
Type
KeyboardEventLike
Requirement
required
Name
table
Kind
parameter
Type
KeydownTable
Requirement
required
Name
allowTypeahead
Kind
parameter
Type
boolean
Requirement
optional
Name
return
Kind
return value
Type
KeydownAction | null
Requirement
n/a

resolveRovingKey

function
DeclarationView source
resolveRovingKeyts
declare function resolveRovingKey(key: string, options: RovingKeyOptions): RovingIntent | null;
Name
Kind
Type
Requirement
key
parameter
string
required
options
parameter
RovingKeyOptions
required
return
return value
RovingIntent | null
n/a
Name
key
Kind
parameter
Type
string
Requirement
required
Name
options
Kind
parameter
Type
RovingKeyOptions
Requirement
required
Name
return
Kind
return value
Type
RovingIntent | null
Requirement
n/a

Returns `preserve` while the pointer travels through the corridor between a submenu trigger and its content. The corridor interpolates the two rectangles' top/bottom edges and includes a small eight-pixel tolerance so browser pointer sampling cannot close a submenu between adjacent samples.

DeclarationView source
resolveSubmenuPointerIntentts
declare function resolveSubmenuPointerIntent(input: SubmenuPointerIntentInput): SubmenuPointerIntent;
Name
Kind
Type
Requirement
input
parameter
SubmenuPointerIntentInput
required
return
return value
SubmenuPointerIntent
n/a
Name
input
Kind
parameter
Type
SubmenuPointerIntentInput
Requirement
required
Name
return
Kind
return value
Type
SubmenuPointerIntent
Requirement
n/a

Roving-focus manager (Tranche 1 capability gate, tabs.spec.md "Keyboard"). The manager is deliberately two existing pieces plus one pure resolver — not a stateful class: - this resolver maps a physical key to a LOGICAL focus intent, honoring orientation and RTL (the machine only ever sees logical direction); - the machine owns the focused position and emits `FOCUS_ITEM`; - the command runner resolves `FOCUS_ITEM` through the part scope. The unbound axis returns null (spec: vertical tablists do not handle Left/Right, horizontal ones do not handle Up/Down).

DeclarationView source
RovingIntentts
type RovingIntent = "next" | "previous" | "first" | "last";

RovingKeyOptions

interface
DeclarationView source
RovingKeyOptionsts
interface RovingKeyOptions {
readonly orientation: "horizontal" | "vertical";
readonly dir?: "ltr" | "rtl";
}
Name
Kind
Type
Requirement
dir
property
"ltr" | "rtl"
optional
orientation
property
"horizontal" | "vertical"
required
Name
dir
Kind
property
Type
"ltr" | "rtl"
Requirement
optional
Name
orientation
Kind
property
Type
"horizontal" | "vertical"
Requirement
required

SubmenuPoint

interface

Framework-neutral pointer-intent resolution for nested menus. This is deliberately a pure geometry seam. Adapters provide pointer samples and own event listeners; machines own delayed open/close commands. ContextMenu introduces it, Menubar and NavigationMenu reuse it.

DeclarationView source
SubmenuPointts
interface SubmenuPoint {
readonly x: number;
readonly y: number;
}
Name
Kind
Type
Requirement
x
property
number
required
y
property
number
required
Name
x
Kind
property
Type
number
Requirement
required
Name
y
Kind
property
Type
number
Requirement
required
DeclarationView source
SubmenuPointerIntentts
type SubmenuPointerIntent = "enter" | "preserve" | "leave";
DeclarationView source
SubmenuPointerIntentInputts
interface SubmenuPointerIntentInput {
readonly previousPoint: SubmenuPoint | null;
readonly currentPoint: SubmenuPoint;
readonly triggerRect: SubmenuRect;
readonly contentRect: SubmenuRect;
}
Name
Kind
Type
Requirement
contentRect
property
SubmenuRect
required
currentPoint
property
SubmenuPoint
required
previousPoint
property
SubmenuPoint | null
required
triggerRect
property
SubmenuRect
required
Name
contentRect
Kind
property
Type
SubmenuRect
Requirement
required
Name
currentPoint
Kind
property
Type
SubmenuPoint
Requirement
required
Name
previousPoint
Kind
property
Type
SubmenuPoint | null
Requirement
required
Name
triggerRect
Kind
property
Type
SubmenuRect
Requirement
required

SubmenuRect

interface
DeclarationView source
SubmenuRectts
interface SubmenuRect {
readonly top: number;
readonly right: number;
readonly bottom: number;
readonly left: number;
}
Name
Kind
Type
Requirement
bottom
property
number
required
left
property
number
required
right
property
number
required
top
property
number
required
Name
bottom
Kind
property
Type
number
Requirement
required
Name
left
Kind
property
Type
number
Requirement
required
Name
right
Kind
property
Type
number
Requirement
required
Name
top
Kind
property
Type
number
Requirement
required

trapFocus

function
DeclarationView source
trapFocusts
declare function trapFocus(container: HTMLElement, options?: FocusTrapOptions): FocusTrapHandle;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
FocusTrapOptions
optional
return
return value
FocusTrapHandle
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
FocusTrapOptions
Requirement
optional
Name
return
Kind
return value
Type
FocusTrapHandle
Requirement
n/a
DeclarationView source
verticalNavigationKeysts
export declare const verticalNavigationKeys: KeydownTable;