DEVELOPER REFERENCE · v4.0.0

AiPromptInput API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

AiPromptInput13 props3 callbacks0 methods

Props13

AiPromptInput props
Name	Type	Description
`translations`Optional	`AiUiTranslations`Inspect type	Overrides the default UI strings. Supply only the entries you want to translate and retain any placeholders.
`value`Required	`string`	Value to display or edit. The declared type identifies the supported representation; change callbacks describe how edited values are emitted.
`busy`Optional	`boolean \| undefined`	Indicates that an operation is in progress; interactive controls block activation while busy.
`disabled`Optional	`boolean \| undefined`	Disables user interaction with the control.
`label`Optional	`string \| undefined`	Label content or accessible name for the component, as rendered by this control.
`placeholder`Optional	`string \| undefined`	Content shown when there is no entered or selected value.
`submitLabel`Optional	`string \| undefined`	Accessible text for sending the prompt.
`stopLabel`Optional	`string \| undefined`	Accessible text for stopping the current operation.
`promptHistory`Optional	`readonly string[] \| undefined`Inspect type	Opt-in local prompt recall. Arrow keys retain normal multiline behavior away from text edges.
`hint`Optional	`string \| undefined`	Empty-draft keyboard guidance. An empty string lets toolbar context replace it.
`actions`Optional	`ComponentChildren`Inspect type	Host-supported actions or context, displayed in the composer toolbar.
`footer`Optional	`ComponentChildren`Inspect type	Applied context or supplemental content above the bottom toolbar.
`textareaProps`Optional	`Pick<Omit<h.JSX.TextareaHTMLAttributes<HTMLTextAreaElement>, "className"> & { className?: string; onValueChange?: (value: string) => void; }, "className" \| "rows" \| "style"> \| undefined`Inspect type	Native textarea presentation and sizing; input behavior stays controlled here.

Events and callbacks3

AiPromptInput events and callbacks
Name	Type	Description
`onValueChange`Required	`(value: string) => void`Inspect type	Receives the updated input value. Store it in application state and pass it back through value.
`onSubmit`Required	`(value: string) => void`Inspect type	Submits the current prompt value to the application-provided handler.
`onStop`Optional	`(() => void) \| undefined`Inspect type	Requests cancellation of the in-progress AI operation.

Methods0

No component-specific imperative methods. Use props and callbacks to control this component.