SpeechToTextButtonProps
Represents the props of the Kendo UI for Vue Button component. Extends the native button props.
Definition
Package:@progress/kendo-vue-buttons
Properties
accessKey?
string
Sets the accessKey property of the Button.
ariaLabel?
string
Sets the aria-label of the Button.
ariaPressed?
boolean
Sets the aria-pressed attribute of the Button.
continuous?
boolean
Specifies whether the speech recognition should continue until explicitly stopped. Defaults to true.
dir?
string
Sets the direction of the Button.
disabled?
boolean
Specifies if the Button is disabled (see example). Defaults to false.
fillMode?
"solid" | "outline" | "flat" | "link"
Configures the fillMode of the Button.
The available options are:
- solid
- outline
- flat
- link
undefined
icon?
string
Defines the name for an existing icon in a Kendo UI for Vue 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?
string
defines the size of the SVG icon displayed inside the Button.
id?
string
Sets the id property of 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?
"WebSpeech" | "None"
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.
role?
string
Sets the role attribute of the Button.
rounded?
"small" | "medium" | "large" | "none" | "full"
Configures the roundness of the Button.
The available options are:
- none
- small
- medium
- large
- circle
- full
undefined
selected?
boolean
Sets the selected state of the Button. Can be used for controlled mode.
size?
"xs" | "small" | "medium" | "large"
Configures the size of the Button.
The available options are:
- xs
- small
- medium
- large
undefined
svgIcon?
SVGIcon
Defines an SVGIcon to be rendered within the button.
tabIndex?
number
Sets the tabIndex property of the Button.
themeColor?
"base" | "primary" | "secondary" | "tertiary" | "info" | "success" | "warning" | "error" | "inverse"
Configures the themeColor of the Button.
The available options are:
- base
- primary
- secondary
- tertiary
- info
- success
- warning
- error
- inverse
undefined
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.
type?
string
Sets the type property of the Button.
Methods
The abort event callback that stops the speech recognition service from listening to incoming audio, and doesn't attempt to return a result.
The isActive event callback that returns a boolean value if the SpeechToTextButton is in an active state.
boolean
true if the speech recognition is active, otherwise false.
The start event callback that starts the speech recognition service listening to incoming audio with intent to recognize grammars.
The stop event callback that stops the speech recognition service from listening to incoming audio, and attempts to return a result using the audio captured so far.