New to KendoReact? Start a free 30-day trial

GridAIPromptProps

Interface

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

activeView?

string

Name of the currently active view.

Example:

activeView="prompt"

enableSpeechToText?

boolean | SpeechToTextButtonProps

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

Example:

jsx

<GridToolbarAIAssistant enableSpeechToText={true} />

generateButton?

CustomComponent<ButtonProps>

Custom component to render the generate button.

Example:

generateButton={CustomGenerateButton}

loading?

boolean

Indicates whether the prompt is currently loading.

Example:

loading={true}

onActiveViewChange?

(viewName: string) => void

Callback fired when the active view changes.

Parameters:viewNamestring

The name of the new active view.

Example:

onActiveViewChange={(view) => setActiveView(view)}

onCancel?

() => void

Callback fired when the user cancels the current operation.

Example:

onCancel={() => cancelPrompt()}

onClose?

() => void

Callback fired when the user closes the current operation.

Example:

onClose={() => closePrompt()}

onCopy?

() => void

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

Example:

onCopy={() => copyToClipboard()}

onOutputRating?

() => void

Callback fired when the user rates the output.

Example:

onOutputRating={() => handleRating()}

onPromptRequest?

(prompt: string) => void

Callback fired when the user submits a prompt request.

Parameters:promptstring

The prompt text submitted by the user.

Example:

onPromptRequest={(prompt) => sendPrompt(prompt)}

outputCard?

AIPromptCardInterface

Configuration for the output card displaying AI results.

Example:

outputCard={{ title: "AI Result", content: "..." }}

outputs?

AIPromptOutputInterface[]

List of AI-generated outputs to display.

Example:

outputs={[{ text: "AI output 1" }, { text: "AI output 2" }]}

promptInput?

CustomComponent<TextAreaProps>

Custom component to render the prompt input field.

Example:

promptInput={CustomTextArea}

promptPlaceHolder?

string

Placeholder text for the prompt input field.

Example:

promptPlaceHolder="Type your question here..."

promptValue?

string

Current value of the prompt input field.

Example:

promptValue="Describe the selected rows"

streaming?

boolean

Indicates whether the prompt is currently streaming or processing.

Example:

streaming={true}

suggestionsList?

string[]

List of prompt suggestions to display to the user.

Example:

suggestionsList={["Summarize", "Explain", "Generate chart"]}

toolbarItems?

AIPromptToolbarItemInterface[]

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

Example:

toolbarItems={[promptViewDefaults, outputViewDefaults]}