PromptBoxSpeechToTextButtonProps
Represents the props of the PromptBoxSpeechToTextButton component.
Definition
Package:@progress/kendo-react-conversational-ui
Properties
ariaLabel?
string
The accessible label of the component.
className?
string
Sets additional classes to the SpeechToTextButton (see example).
continuous?
boolean
Specifies whether the speech recognition should continue until explicitly stopped.
false
disabled?
boolean
Specifies if the SpeechToTextButton is disabled (see example).
false
fillMode?
"link" | "solid" | "outline" | "flat" | "clear"
Configures the fillMode of the Button. See Button Appearance.
undefined (theme-controlled)
icon?
string
Defines the name for an existing icon in a KendoReact theme (see example). The icon renders inside the Button by a span.k-icon element.
iconClass?
string
Defines a CSS class — or multiple classes separated by spaces — which apply to a span element inside the Button (see example). Allows you to use custom icons.
iconSize?
"small" | "medium" | "large"
Configures the size of the SVG icon that displays inside the Button.
undefined (theme-controlled)
integrationMode?
"none" | "webSpeech"
Specifies which speech recognition engine or integration the component should use. This allows the component to operate in different environments or use alternative implementations.
interimResults?
boolean
Specifies whether to return interim results.
false
lang?
string
The valid BCP 47 language tag to use for speech recognition.
'en-US'
maxAlternatives?
number
Specifies the maximum number of alternative transcriptions to return.
1
onEnd?
() => void
Callback function that is called when speech recognition ends.
onError?
(event: SpeechToTextErrorEvent) => void
Callback function that is called when an error occurs during speech recognition.
onResult?
(event: SpeechToTextResultEvent) => void
Callback function that is called when a speech recognition result is available.
The event contains the isFinal flag and an array of alternatives.
onStart?
() => void
Callback function that is called when speech recognition starts.
rounded?
"none" | "full" | "small" | "medium" | "large"
Configures the roundness of the Button. See Button Appearance.
The available options are:
smallmediumlargefullnone
undefined (theme-controlled)
size?
"xs" | "small" | "medium" | "large"
Configures the size of the Button. See Button Appearance.
undefined (theme-controlled)
style?
CSSProperties
Sets additional CSS styles to the SpeechToTextButton (see example).
svgIcon?
SVGIcon
Defines the SVG icon that renders inside the Button component.
themeColor?
"base" | "primary" | "secondary" | "tertiary" | "info" | "success" | "warning" | "error" | "inverse"
Configures the themeColor of the Button. See Button Appearance.
undefined (theme-controlled)
title?
string
Sets the title HTML attribute of the Button.
unstyled?
ButtonsClassStructure
The unstyled option classes.
webMcp?
boolean | WebMcpProps
Enables Web MCP tool registration for this Button.