SpeechToTextButton
Represents the Kendo UI for Vue SpeechToTextButton component. Accepts properties of type SpeechToTextButtonProps. Use the SpeechToTextButton to turn the speech of the user into text.
Definition
Package:@progress/kendo-vue-buttons
Properties Interface:SpeechToTextButtonProps
Syntax:
<SpeechToTextButton :lang="'en-US'" @result="onResult" />
Properties
Stops the speech recognition service. The service stops listening to incoming audio and does not return a result.
accessKey?
string
Sets the accesskey attribute of the Button. Users press this key to focus the Button.
ariaLabel?
string
Sets the aria-label attribute of the Button.
ariaPressed?
boolean
Sets the aria-pressed attribute of the Button.
continuous?
boolean
Sets whether speech recognition continues until you stop it. Defaults to false.
false
dir?
string
Sets the direction of the Button.
disabled?
boolean
Sets whether the Button is disabled (see example). Defaults to false.
endIcon?
string
Sets the name of an existing font icon in a Kendo UI for Vue theme. The Button renders it after the text.
endSvgIcon?
SVGIcon
Sets an SVGIcon that the Button renders after the text.
fillMode?
"solid" | "outline" | "flat" | "link"
Sets the fill style of the Button.
The available options are:
- solid
- outline
- flat
- link
undefined
icon?
string
Sets the name of an existing icon in a Kendo UI for Vue theme (see example). The Button renders the icon inside a span.k-icon element.
iconClass?
string
Sets a CSS class—or multiple classes separated by spaces—that the Button applies to a span element inside it (see example). Use it to show custom icons.
iconSize?
IconSize
Sets the size of the SVG icon inside the Button.
id?
string
Sets the id attribute of the Button.
imageAlt?
string
Sets the alternative text of the image inside the Button.
imageUrl?
string
Sets the URL of an img element inside the Button (see example). The URL can be relative or absolute. The browser resolves a relative URL against the URL of the web page.
integrationMode?
"WebSpeech" | "None"
Sets the speech recognition engine or integration that the SpeechToTextButton uses. Use it to run the SpeechToTextButton in different environments or with other implementations.
'WebSpeech'
interimResults?
boolean
Sets whether the SpeechToTextButton returns interim results. Defaults to false.
false
Returns whether the SpeechToTextButton is active.
boolean
true if the speech recognition is active, otherwise false.
lang?
string
Sets a valid BCP 47 language tag for speech recognition. Defaults to en-US.
'en-US'
maxAlternatives?
number
Sets the maximum number of alternative transcripts to return. Defaults to 1.
1
onEnd?
() => void
Fires when speech recognition ends. The event name is end.
onError?
(event: SpeechToTextErrorEvent) => void
Fires when an error occurs during speech recognition. The event name is error.
onResult?
(event: SpeechToTextResultEvent) => void
Fires when a speech recognition result is available. The event name is result.
The event contains the isFinal flag and an array of alternatives.
onStart?
() => void
Fires when speech recognition starts. The event name is start.
role?
string
Sets the role attribute of the Button.
rounded?
"small" | "medium" | "large" | "none" | "full"
Sets the border radius of the Button.
The available options are:
- none
- small
- medium
- large
- circle
- full
undefined
selected?
boolean
Sets the selected state of the Button. Use it for controlled mode.
size?
"xs" | "small" | "medium" | "large"
Sets the size of the Button.
The available options are:
- xs
- small
- medium
- large
undefined
Starts the speech recognition service. The service listens to incoming audio and tries to recognize speech.
Stops the speech recognition service. The service stops listening to incoming audio and tries to return a result from the audio it has so far.
svgIcon?
SVGIcon
Sets an SVGIcon that the Button renders.
tabIndex?
number
Sets the tabindex attribute of the Button.
themeColor?
"base" | "primary" | "secondary" | "tertiary" | "info" | "success" | "warning" | "error" | "inverse"
Sets the theme color 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
Sets whether the Button shows a selected state when the user clicks it (see example). Defaults to false.
false
type?
string
Sets the type attribute of the Button, for example button or submit.