New to KendoReactStart a free 30-day trial

Definition

Package:@progress/kendo-react-conversational-ui

Properties

anchor?

null | HTMLElement

The element that serves as an anchor for the popup.

animate?

boolean | PopupAnimation

Controls the animation of the popup.

Default:

true

appendTo?

HTMLElement

The container element where the popup will be rendered. If not specified, the popup will be rendered in the document body.

Collection of commands rendered in the context menu. If not set, default AI text editing commands are used.

enableSpeechToText?

boolean | SpeechToTextButtonProps

Shows speech-to-text button in the input. When true, shows the button with default settings. When you pass an object, forwards its props to the SpeechToTextButton component.

Default:

false

generateButton?

CustomComponent​<ButtonProps>

Custom component used to render the generate button.

height?

string | number

The height of the component.

onClose?

(event: { target: any }) => void

Fires when the popup is closed.

Parameters:event{ target: any }

Fires when a command from the context menu executes. Provides the selected command and current prompt value.

Parameters:commandCommandItemInterface

Fires when the user clicks the Copy button.

Fires when the user clicks the Discard button.

onOpen?

(event: { target: any }) => void

Fires when the popup is opened.

Parameters:event{ target: any }

Fires when an action command executes. Built-in copy and discard actions are handled internally. All other actions call this handler.

onPromptCancel?

() => void

Fires when the cancel action occurs.

onPromptRequest?

(prompt: string, outputItem: InlineAIPromptOutputInterface) => void

Fires when the user submits a prompt.

Parameters:promptstringoutputItem?InlineAIPromptOutputInterface

Collection of output actions rendered in the card actions. If not set, default actions (copy, discard) are used. You can override built-ins.

outputCard?

AIPromptCardInterface

Template that lets you define custom Card fields for header, body, and actions. Overrides defaults.

Collection of outputs to display as cards.

popupOptions?

PopupProps

Object which passes props directly to the Popup component.

promptInput?

CustomComponent​<TextAreaProps>

Custom component used to render the prompt input.

Placeholder text for the prompt input.

Initial value of the prompt input.

show?

boolean

Controls the visibility of the popup.

Default:

false

streaming?

boolean

Indicates if the content is streaming.

style?

CSSProperties

Inline styles for the root element.

jsx
<InlineAIPrompt style={{ backgroundColor: 'lightblue' }} />

width?

string | number

The width of the component.