New to KendoReactStart a free 30-day trial

Props for the GridAIPrompt component, which provides AI-powered prompt and output functionality in a grid toolbar.

Definition

Package:@progress/kendo-react-grid

Syntax:

tsx
<GridAIPrompt
  promptValue="Summarize this data"
  outputs={[{ text: "Summary...", ... }]}
  streaming={true}
  onPromptRequest={handlePrompt}
  suggestionsList={["Summarize", "Explain", "Generate chart"]}
/>

Properties

Name of the currently active view.

enableSpeechToText?

boolean | SpeechToTextButtonProps

Enables the speech-to-text functionality for the input of the GridToolbarAIAssistant.

generateButton?

CustomComponent​<ButtonProps>

Custom component to render the generate button.

loading?

boolean

Indicates whether the prompt is currently loading.

onActiveViewChange?

(viewName: string) => void

Callback fired when the active view changes.

Parameters:viewNamestring

The name of the new active view.

onCancel?

() => void

Callback fired when the user cancels the current operation.

onClose?

() => void

Callback fired when the user closes the current operation.

onCopy?

() => void

Callback fired when the user clicks the Copy button in the output card.

onOutputRating?

() => void

Callback fired when the user rates the output.

onPromptRequest?

(prompt: string) => void

Callback fired when the user submits a prompt request.

Parameters:promptstring

The prompt text submitted by the user.

outputCard?

AIPromptCardInterface

Configuration for the output card displaying AI results.

outputs?

AIPromptOutputInterface[]

List of AI-generated outputs to display.

promptInput?

CustomComponent​<TextAreaProps>

Custom component to render the prompt input field.

Placeholder text for the prompt input field.

Current value of the prompt input field.

streaming?

boolean

Indicates whether the prompt is currently streaming or processing.

List of prompt suggestions to display to the user.

toolbarItems?

AIPromptToolbarItemInterface[]

Array of toolbar items to display, can include prompt or output view defaults.