ESM
import "@arcgis/ai-components/components/arcgis-assistant-message-read-aloud";
Inheritance
ArcgisAssistantMessageReadAloudHTMLElement

Adds text-to-speech playback controls. Use it to read assistant responses aloud. Offers read-aloud start/stop behavior with supported-state handling.

Properties

PropertyAttributeType
read-aloud-enabled

message

Property
Type
AssistantMessage | undefined

readAloudEnabled

Property
Type
boolean
Attribute
read-aloud-enabled
Default value
false

Methods

MethodSignature
inherited
componentOnReady(): Promise<this>

componentOnReady

inherited Method
Signature
componentOnReady (): Promise<this>
Inherited from: this

Creates a promise that resolves once the component is fully loaded.

Returns
Promise<this>
Example
const arcgisAssistantMessageReadAloud = document.createElement("arcgis-assistant-message-read-aloud");
document.body.append(arcgisAssistantMessageReadAloud);
await arcgisAssistantMessageReadAloud.componentOnReady();
console.log("arcgis-assistant-message-read-aloud is ready to go!");