New to Kendo UI for VueStart a free 30-day trial

SpeechToTextButtonProps

NameTypeDefaultDescription

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?

string

solid

Configures the fillMode of the Button.

The available options are:

  • solid
  • outline
  • flat
  • link
  • null—Does not set a fillMode className.

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 true.

lang?

string

The language 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.

primary?

boolean

Adds visual weight to the Button and makes it primary (see example). Deprecated. Use themeColor prop instead.

role?

string

Sets the role attribute of the Button.

rounded?

string

medium

Configures the roundness of the Button.

The available options are:

  • small
  • medium
  • large
  • circle
  • full
  • null—Does not set a rounded className.

selected?

boolean

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

size?

string

medium

Configures the size of the Button.

The available options are:

  • small
  • medium
  • large
  • null—Does not set a size className.

svgIcon?

SVGIcon

Defines an SVGIcon to be rendered within the button.

tabIndex?

number

Sets the tabIndex property of the Button.

themeColor?

string

base

Configures the themeColor of the Button.

The available options are:

  • base
  • primary
  • secondary
  • tertiary
  • info
  • success
  • warning
  • dark
  • light
  • inverse
  • null—Does not set a themeColor className.

title?

string

Sets the aria-label 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

isActive

Method that checks if the speech recognition is currently active.

Returns

boolean

true if the speech recognition is active, otherwise false.

start

Method that helps you start the speech recognition process manually.

stop

Method that helps you stop the speech recognition process manually.

In this article
Methods
Not finding the help you need?
Contact Support