Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Internationalization
page_title: SpeechToTextButton Internationalization
description: "Internationalization of the Telerik WebForms SpeechToTextButton component."
slug: speechtotextbutton/accessibility/internationalization
tags: internationalization
position: 1
---

# Internationalization

The SpeechToTextButton supports Internationalization by its `Messages` collection. The collection consists of text messages, used as aria-labels by the control. Users can use this option to customize or localize the messages.

Example

````ASP.NET
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton1">
<Messages NotInitialized="Not Initializaed yet" Start="Started" Stop="Stopped" Unsupported="This is not supported" />
</telerik:RadSpeechToTextButton>
````

The available Messages can be found in the [Server Properties article]({%slug speechtotextbutton/server-side-programming/properties#messages%}).
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: Overview
page_title: SpeechToTextButton Accessibility
description: Get started with the WebForms SpeechToTextButton and learn about its accessibility support for WAI-ARIA, Section 508, and WCAG 2.2.
slug: speechtotextbutton/accessibility/overview
position: 0
---

# SpeechToTextButton Accessibility

The SpeechToTextButton is accessible by screen readers and provides WAI-ARIA, Section 508, WCAG 2.2, and keyboard support.

Out of the box, the WebForms SpeechToTextButton provides extensive accessibility support and enables users with disabilities to acquire complete control over its features.

The SpeechToTextButton is compliant with the [Web Content Accessibility Guidelines (WCAG) 2.2 AAA](https://www.w3.org/TR/WCAG22/) standards and [Section 508](https://www.section508.gov/) requirements, follows the [Web Accessibility Initiative - Accessible Rich Internet Applications (WAI-ARIA)](https://www.w3.org/WAI/ARIA/apg/) best practices for implementing the [keyboard navigation](#keyboard-navigation) for its `component` role, provides options for managing its focus and is tested against the most popular screen readers.

## WAI-ARIA

This section lists the selectors, attributes, and behavior patterns supported by the component and its composite elements, if any.

| Selector | Attribute | Usage |
| ----------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------- |
| `.k-button.k-speech-to-text-button` | `role=button` or `nodeName=button` | If the used element is not `<button>`, explicitly set its `role` to `button`. |
| | `aria-pressed=true/false` | Announced the toggle behaviour of the button. |

## Resources

[WAI-ARIA Authoring Practices: Button Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/button/)

## Section 508

The SpeechToTextButton is fully compliant with the [Section 508 requirements](http://www.section508.gov/).

## Testing

The SpeechToTextButton has been extensively tested automatically with [axe-core](https://github.com/dequelabs/axe-core) and manually with the most popular screen readers.

> To report any accessibility issues, contact the team through the [Telerik Support System](https://www.telerik.com/account/support-center).

### Screen Readers

The SpeechToTextButton has been tested with the following screen readers and browsers combinations:

| Environment | Tool |
| -------------- | ---- |
| Firefox | NVDA |
| Chrome | JAWS |
| Microsoft Edge | JAWS |

### Automated Testing

The SpeechToTextButton has been tested with [axe-core](https://github.com/dequelabs/axe-core).

### Test Example

A live test example of the SpeechToTextButton component could be found here: https://demos.telerik.com/aspnet-ajax/speechtotextbutton/accessibility-and-internationalization/rtl/defaultcs.aspx
153 changes: 153 additions & 0 deletions controls/speechtotextbutton/appearance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
---
title: Appearance
page_title: SpeechToTextButton Appearance
description: "Learn how to set the options to change the appearance such as, sizes, border radiuses, fill modes and theme colors."
slug: speechtotextbutton/appearance
tags: appearance,speechtotextbutton
published: True
position: 2
---

# Appearance

In this article, you will find information about the styling options and rendering of the WebForms SpeechToTextButton.

For a live example, visit the [Appearance Demo of the SpeechToTextButton](https://demos.telerik.com/aspnet-ajax/speechtotextbutton/appearance/defaultcs.aspx).

## Options

The WebForms SpeechToTextButton supports the following styling options:

- [`Icon`](#icon) - Configures the icon displayed when the button is in inactive state.
- [`StopIcon`](#stopicon) - Configures the icon displayed when the button is speech recognition state.
- [`FillMode`](#fillmode) - Configures how the color is applied to the component.
- [`Rounded`](#rounded) - Configures the border radius of the component.
- [`Size`](#size) - Configures the overall size of the component.
- [`ThemeColor`](#theme-color) - Configures what color will be applied to the component.

## Icon

The `Icon` option determines which icon is displayed when the button is not in the active state. The default is the `microphone-outline` icon.

!["SpeechToTextButton Icon"](images/sttb-getting-started.png "SpeechToTextButton Icon")

Example

````ASP.NET
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton1" Icon="headset" />
````

## StopIcon

The `StopIcon` option determines which icon is displayed when the button is in the active state (speech recognition in progress). The default is the `stop-sm` icon.

!["SpeechToTextButton Stop Icon"](images/sttb-stop-icon.png "SpeechToTextButton Stop Icon")

Example

````ASP.NET
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton1" StopIcon="pause-sm" />
````

## FillMode

The `FillMode` option controls how the color is applied to the button.

!["SpeechToTextButton Fill Mode"](images/sttb-fill-mode.png "SpeechToTextButton Fill Mode")

Available values:

- `Solid` - Solid background color (default)
- `Outline` - Outlined border with transparent background
- `Flat` - No border or background color
- `None`

````ASP.NET
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton1" FillMode="Solid" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton2" FillMode="Outline" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton3" FillMode="Flat" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton4" FillMode="None" />
````

## Rounded

The `Rounded` option controls the border radius of the button.

!["SpeechToTextButton Rounded"](images/sttb-rounded.png "SpeechToTextButton Rounded")

Available values:

- `Small` - Small border radius
- `Medium` - Medium border radius (default)
- `Large` - Large border radius
- `Full` - Fully rounded corners (pill shape)
- `None`

````ASP.NET
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton1" Rounded="Small" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton2" Rounded="Medium" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton3" Rounded="Large" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton4" Rounded="Full" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton5" Rounded="None" />
````

## Size

The `Size` option controls how big or small the rendered button looks.


!["SpeechToTextButton Size"](images/sttb-size.png "SpeechToTextButton Size")

Available values:

- `Small` - Small size
- `Medium` - Medium size (default)
- `Large` - Large size
- `None`

````ASP.NET
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton1" Size="Small" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton2" Size="Medium" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton3" Size="Large" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton5" Size="None" />
````

## Theme Color

The `ThemeColor` option controls the color applied to the button.

!["SpeechToTextButton Theme Color"](images/sttb-theme-color.png "SpeechToTextButton Theme Color")

Available values:

- `Primary` - Primary accent color
- `Secondary` - Secondary accent color
- `Tertiary` - Tertiary accent color
- `Info` - Informational color
- `Success` - Positive action color
- `Warning` - Attention‑drawing color
- `Error` - Negative action color
- `Base` - Default color based on the current theme

````ASP.NET
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton1" ThemeColor="Primary" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton2" ThemeColor="Secondary" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton3" ThemeColor="Tertiary" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton4" ThemeColor="Info" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton5" ThemeColor="Success" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton6" ThemeColor="Warning" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton7" ThemeColor="Error" />
<telerik:RadSpeechToTextButton runat="server" ID="RadSpeechToTextButton8" ThemeColor="Base" />
````

## Button States

* **Inactive State** - Default state before speech recognition begins
* **Active State** - Indicates that speech recognition is currently in progress
* **Error State** - Displays when speech recognition encounters an error or is not supported by the browser

## Next Steps

- [Accessibility]({%slug speechtotextbutton/accessibility/overview%})
- [Client-side Programming]({%slug speechtotextbutton/client-side-programming/overview%})
- [Server-side Programming]({%slug speechtotextbutton/server-side-programming/overview%})
71 changes: 71 additions & 0 deletions controls/speechtotextbutton/client-side-programming/enums.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: Enums
page_title: SpeechToTextButton Client-side Enums
description: Client-side Enums of the Telerik WebForms SpeechToTextButton component
slug: speechtotextbutton/client-side-programming/enums
tags: speechtotextbutton,javascript,enums
published: True
position: 3
---

# Enums

Telerik WebForms SpeechToTextButton specific Client-side Enums.

## FillMode

The enum type: `Telerik.Web.UI.RadSpeechToTextButtonFillMode`

| Enum member | Value |
| ------------------------------------------------------ | ----- |
| `Telerik.Web.UI.RadSpeechToTextButtonFillMode.None` | `0` |
| `Telerik.Web.UI.RadSpeechToTextButtonFillMode.Solid` | `1` |
| `Telerik.Web.UI.RadSpeechToTextButtonFillMode.Outline` | `2` |
| `Telerik.Web.UI.RadSpeechToTextButtonFillMode.Flat` | `3` |

## IntegrationMode

The enum type: `Telerik.Web.UI.RadSpeechToTextButtonIntegrationMode`

| Enum member | Value |
| --------------------------------------------------------------- | ----- |
| `Telerik.Web.UI.RadSpeechToTextButtonIntegrationMode.WebSpeech` | `0` |
| `Telerik.Web.UI.RadSpeechToTextButtonIntegrationMode.None` | `1` |

## Rounded

The enum type: `Telerik.Web.UI.RadSpeechToTextButtonRounded`

| Enum member | Value |
| ---------------------------------------------------- | ----- |
| `Telerik.Web.UI.RadSpeechToTextButtonRounded.None` | `0` |
| `Telerik.Web.UI.RadSpeechToTextButtonRounded.Small` | `1` |
| `Telerik.Web.UI.RadSpeechToTextButtonRounded.Medium` | `2` |
| `Telerik.Web.UI.RadSpeechToTextButtonRounded.Large` | `3` |
| `Telerik.Web.UI.RadSpeechToTextButtonRounded.Full` | `4` |

## Size

The enum type: `Telerik.Web.UI.RadSpeechToTextButtonSize`

| Enum member | Value |
| ------------------------------------------------- | ----- |
| `Telerik.Web.UI.RadSpeechToTextButtonSize.None` | `0` |
| `Telerik.Web.UI.RadSpeechToTextButtonSize.Small` | `1` |
| `Telerik.Web.UI.RadSpeechToTextButtonSize.Medium` | `2` |
| `Telerik.Web.UI.RadSpeechToTextButtonSize.Large` | `3` |

## ThemeColor

The enum type: `Telerik.Web.UI.RadSpeechToTextButtonThemeColor`

| Enum member | Value |
| ---------------------------------------------------------- | ----- |
| `Telerik.Web.UI.RadSpeechToTextButtonThemeColor.Primary` | `0` |
| `Telerik.Web.UI.RadSpeechToTextButtonThemeColor.Secondary` | `1` |
| `Telerik.Web.UI.RadSpeechToTextButtonThemeColor.Tertiary` | `2` |
| `Telerik.Web.UI.RadSpeechToTextButtonThemeColor.Info` | `3` |
| `Telerik.Web.UI.RadSpeechToTextButtonThemeColor.Success` | `4` |
| `Telerik.Web.UI.RadSpeechToTextButtonThemeColor.Warning` | `5` |
| `Telerik.Web.UI.RadSpeechToTextButtonThemeColor.Error` | `6` |
| `Telerik.Web.UI.RadSpeechToTextButtonThemeColor.Base` | `7` |
Loading