ESM
import "@arcgis/ai-components/components/arcgis-assistant-chat-entry";
Inheritance
ArcgisAssistantChatEntryHTMLElement

Provides the input bar and submit or cancel behavior. Use it to collect prompts and emit submit events. Offers keyboard submit/history behavior, entry action slots, and optional voice-input integration.

Properties

PropertyAttributeType
awaiting-response
disabled
entry-placeholder
input-value
keyboard-shortcuts-disabled
status
"error" | "ready" | "working" | undefined
voice-input-enabled

awaitingResponse

Property
Type
boolean
Attribute
awaiting-response
Default value
false

disabled

Property
Type
boolean
Attribute
disabled
Default value
false

entryPlaceholder

Property
Type
string | undefined
Attribute
entry-placeholder

inputValue

Property
Type
string
Attribute
input-value
Default value
""

keyboardShortcutsDisabled

Property
Type
boolean
Attribute
keyboard-shortcuts-disabled
Default value
false

messages

Property
Type
Collection<ChatMessage>

status

Property
Type
"error" | "ready" | "working" | undefined
Attribute
status

voiceInputEnabled

Property
Type
boolean
Attribute
voice-input-enabled
Default value
false

Methods

MethodSignature
inherited
componentOnReady(): Promise<this>
submitMessage(): Promise<void>

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 arcgisAssistantChatEntry = document.createElement("arcgis-assistant-chat-entry");
document.body.append(arcgisAssistantChatEntry);
await arcgisAssistantChatEntry.componentOnReady();
console.log("arcgis-assistant-chat-entry is ready to go!");

submitMessage

Method
Signature
submitMessage (): Promise<void>
Returns
Promise<void>

Events

arcgisCancel

Event
arcgisCancel: CustomEvent<void>
bubbles composed cancelable

arcgisSubmit

Event
arcgisSubmit: CustomEvent<string>
bubbles composed cancelable

Slots

NameDescription

Slot for adding actions to the start of the entry area.

Slot for adding actions to the end of the entry area.

entry-actions-start

Slot

Slot for adding actions to the start of the entry area.

entry-actions-end

Slot

Slot for adding actions to the end of the entry area.