New to KendoReactLearn about KendoReact Free.

SpeechToTextButtonProps

Represents the props of the KendoReact SpeechToTextButton component.

NameTypeDefaultDescription

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. Defaults to false.

disabled?

boolean

Specifies if the SpeechToTextButton is disabled (see example). Defaults to false.

endIcon?

React.ReactNode

Sets an SVG icon or custom element after the content of the Button. For the custom component, consider using Phrasing content. Do not use Interactive content.

fillMode?

"null" | "link" | "flat" | "solid" | "outline" | "clear"

'solid'

Configures the fillMode of the Button. See Button Appearance.

icon?

string

Defines the name for an existing icon in a KendoReact theme (see example). The icon is rendered inside the Button by a span.k-icon element.

iconClass?

string

Defines a CSS class—or multiple classes separated by spaces—which are applied to a span element inside the Button (see example). Allows the usage of custom icons.

iconSize?

"null" | "small" | "large" | "medium"

'medium'

Configures the size of the SVG icon displayed inside the Button.

imageAlt?

string

Defines the alternative text of the image rendered inside the Button component.

imageUrl?

string

Defines a URL which is used as an img element inside the Button (see example). The URL can be relative or absolute. If relative, it is evaluated with relation to the URL of the web page.

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. Defaults to false.

lang?

string

The valid BCP 47 language tag to use for speech recognition. Defaults to en-US.

maxAlternatives?

number

Specifies the maximum number of alternative transcriptions to return. Defaults to 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?

"null" | "small" | "large" | "medium" | "full"

'medium'

Configures the roundness of the Button. See Button Appearance.

selected?

boolean

Sets the selected state of the Button. Can be used for controlled mode.

size?

"null" | "small" | "large" | "medium"

'medium'

Configures the size of the Button. See Button Appearance.

startIcon?

React.ReactNode

Sets an SVG icon or custom element before the content of the Button. For the custom component, consider using Phrasing content. Do not use Interactive content.

style?

React.CSSProperties

Sets additional CSS styles to the SpeechToTextButton (see example).

svgIcon?

SVGIcon

Defines the SVG icon rendered inside the Button component.

themeColor?

"null" | "base" | "primary" | "secondary" | "tertiary" | "info" | "success" | "warning" | "error" | "dark" | "light" | "inverse"

'base'

Configures the themeColor of the Button. See Button Appearance.

title?

string

Sets the title HTML attribute of the Button.

togglable?

boolean

Provides visual styling that indicates if the Button is selected (see example). Defaults to false.

unstyled?

ButtonsClassStructure

The unstyled option classes.

Not finding the help you need?
Contact Support