Skip to content

Commit 1255702

Browse files
committed
chore(SpeechToTextButton): apply changes based on review and polish the articles
1 parent a237228 commit 1255702

File tree

4 files changed

+29
-30
lines changed

4 files changed

+29
-30
lines changed

components/speechtotextbutton/appearance.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ position: 2
1010

1111
# SpeechToTextButton Appearance
1212

13-
You can customize the appearance of the `SpeechToTextButton` component by using its built-in parameters and CSS classes. The component supports the same appearance options as the standard Telerik Button.
13+
You can customize the appearance of the SpeechToTextButton component by using its built-in parameters and CSS classes. The component supports the same appearance options as the [Telerik UI for Blazor Button](slug:components/button/overview).
1414

1515
## Size
1616

1717
You can increase or decrease the size of the button by setting the `Size` parameter to a member of the `Telerik.Blazor.ThemeConstants.Button.Size` class.
1818

1919
To review all available values for the `Size` parameter, see the [Button Size API Reference](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.ThemeConstants.Button.Size.html).
2020

21-
**Example of Setting the Button Size**
21+
>caption Example of setting the Button Size
2222
2323
<demo metaUrl="client/speechtotextbutton/size/" height="150"></demo>
2424

@@ -28,7 +28,7 @@ The `FillMode` toggles the background and border of the TelerikSpeechToTextButto
2828

2929
To review all available values for the `FillMode` parameter, see the [Button FillMode API Reference](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.ThemeConstants.Button.FillMode.html).
3030

31-
**Example of Setting the Fill Mode**
31+
>caption Example of setting the FillMode
3232
3333
<demo metaUrl="client/speechtotextbutton/fillmode/" height="150"></demo>
3434

@@ -38,7 +38,7 @@ The color of the button is controlled through the `ThemeColor` parameter. You ca
3838

3939
To review all available values for the `ThemeColor` parameter, see the [Button ThemeColor API Reference](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.ThemeConstants.Button.ThemeColor.html).
4040

41-
**Example of Setting the Theme Color**
41+
>caption Example of setting the ThemeColor
4242
4343
<demo metaUrl="client/speechtotextbutton/themecolor/" height="150"></demo>
4444

@@ -48,23 +48,23 @@ The `Rounded` parameter applies the border-radius CSS rule to the button to achi
4848

4949
To review all available values for the `Rounded` parameter, see the [Button Rounded API Reference](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.ThemeConstants.Button.Rounded.html).
5050

51-
**Example of Setting the Rounded Parameter**
51+
>caption Example of Setting the Rounded parameter
5252
5353
<demo metaUrl="client/speechtotextbutton/rounded/" height="150"></demo>
5454

5555
## Icon
5656

57-
Set the `Icon` parameter to display an icon. You can use a predefined Telerik icon or a custom one.
57+
Set the `Icon` parameter to display an icon. You can use a predefined [Telerik icon](slug:common-features-icons) or a custom one.
5858

59-
**Example of Customizing the Icon**
59+
>caption Example of customizing the default icon
6060
6161
<demo metaUrl="client/speechtotextbutton/icon/" height="150"></demo>
6262

6363
## Custom Styles
6464

6565
Use the `Class` parameter to apply custom CSS classes. You can further style the button by targeting these classes.
6666

67-
**Example of Custom Styling**
67+
>caption Example of custom styling
6868
6969
<demo metaUrl="client/speechtotextbutton/customstyle/" height="150"></demo>
7070

components/speechtotextbutton/events.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ position: 3
1010

1111
# SpeechToTextButton Events
1212

13-
The `SpeechToTextButton` component emits events that notify you about speech recognition results, errors, and state changes. Use these events to update the UI, display messages, or process the recognized speech.
13+
The SpeechToTextButton component emits events that notify you about speech recognition results, errors, and state changes. Use these events to update the UI, display messages, or process the recognized speech.
1414

1515
## OnResult
1616

1717
The `OnResult` event fires when the component recognizes speech and produces a result. Use this event to access the recognized phrases, alternatives, and confidence scores.
1818

1919
To review all available properties of the event arguments for `OnResult`, see the [`SpeechToTextButtonResultEventArgs` API Reference](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.Components.SpeechToTextButtonResultEventArgs.html).
2020

21-
**Example: Displaying Recognized Alternatives and Confidence**
21+
>caption Example: Displaying recognized Alternatives and Confidence
2222
2323
<demo metaUrl="client/speechtotextbutton/onresult/" height="300"></demo>
2424

2525
## OnStart and OnEnd
2626

2727
The `OnStart` event fires when speech recognition starts. The `OnEnd` event fires when speech recognition ends. Use these events to update the UI or track the recognition state.
2828

29-
**Example: Indicating Listening State**
29+
>caption Example: Indicating listening state
3030
3131
<demo metaUrl="client/speechtotextbutton/onstartend/" height="300"></demo>
3232

components/speechtotextbutton/integration.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,16 @@ position: 4
1010

1111
# SpeechToTextButton Integration
1212

13-
Integrate the `SpeechToTextButton` component with forms, input fields, and other UI elements to provide voice input capabilities.
13+
Integrate the SpeechToTextButton component with forms, input fields, and other UI elements to provide voice input capabilities.
1414

1515
## Binding Recognized Text to an Input Field
1616

17-
Use the `OnResult` event to update an input field with the recognized text.
17+
Use the `OnResult` event to update an input field with the recognized text. For example, you can enable users to fill out a feedback form by speaking instead of typing. When the user clicks the SpeechToTextButton, the component captures their speech. It then updates the value of a [TelerikTextArea](slug:textarea-overview) with the recognized text.
1818

19-
**Example of Binding Recognized Text to an TelerikTextArea**
19+
>caption Example of binding the recognized text to an TelerikTextArea
2020
2121
<demo metaUrl="client/speechtotextbutton/integration/" height="250"></demo>
2222

23-
2423
## See Also
2524

2625
- [AI Model Voice Transcription Intergration](https://github.com/telerik/blazor-ui/tree/master/common/microsoft-extensions-ai-integration/SpeechToTextIntegration)

components/speechtotextbutton/overview.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,35 @@ position: 1
1010

1111
# Blazor SpeechToTextButton Overview
1212

13-
The `SpeechToTextButton` component enables speech recognition in Blazor applications. It provides a button that users can select to start and stop speech recognition. The component converts spoken words into text and emits events with the recognized results.
13+
The [Blazor SpeechToTextButton component](https://www.telerik.com/blazor-ui/speech-to-text-button) enables speech recognition in Blazor applications. It provides a button that users can select to start and stop speech recognition. The component converts spoken words into text and emits events with the recognized results.
1414

15-
Use the `SpeechToTextButton` component to add voice input capabilities to forms, search bars, chat interfaces, and other scenarios that require speech-to-text functionality.
15+
Use the SpeechToTextButton component to add voice input capabilities to forms, search bars, chat interfaces, and other scenarios that require speech-to-text functionality.
1616

1717
## Basic Usage
1818

19-
The following example demonstrates how to add the `SpeechToTextButton` to a Blazor page and handle the recognition result.
19+
The following example demonstrates how to add the SpeechToTextButton to a Blazor page and handle the recognition result.
2020

21-
**Example of Using the SpeechToTextButton**
21+
>caption Example of using the SpeechToTextButton
2222
2323
<demo metaUrl="client/speechtotextbutton/overview/" height="200"></demo>
2424

2525
## Appearance
2626

27-
You can customize the appearance of the `SpeechToTextButton` by setting parameters such as `Icon`, and `Class`. For more details and examples, refer to [SpeechToTextButton Appearance](slug:speechtotextbutton-appearance).
27+
You can customize the appearance of the SpeechToTextButton by setting parameters such as `Icon`, and `Class`. For more details and examples, refer to [SpeechToTextButton Appearance](slug:speechtotextbutton-appearance).
2828

2929
## Events
3030

31-
The `SpeechToTextButton` component emits several events that you can handle. For more details, refer to [SpeechToTextButton Events](slug:speechtotextbutton-events).
31+
The SpeechToTextButton component emits several events that you can handle. For more details, refer to [SpeechToTextButton Events](slug:speechtotextbutton-events).
3232

3333
## SpeechToTextButton Parameters
3434

35-
To review all available parameters for the `SpeechToTextButton` component, see the [SpeechToTextButton API Reference](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.Components.TelerikSpeechToTextButton#parameters).
35+
To review all available parameters for the SpeechToTextButton component, see the [SpeechToTextButton API Reference](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.Components.TelerikSpeechToTextButton#parameters).
3636

3737
## SpeechToTextButton Reference and Methods
3838

39-
The `SpeechToTextButton` component exposes several public methods that you can call from your code. For a full list and details, see the [SpeechToTextButton API Reference](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.Components.TelerikSpeechToTextButton#methods).
39+
The SpeechToTextButton component exposes several public methods that you can call from your code. For a full list and details, see the [SpeechToTextButton API Reference](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.Components.TelerikSpeechToTextButton#methods).
4040

41-
**Example of Calling a Method by Reference**
41+
>caption Example of Calling a Method by Reference
4242
4343
<div class="skip-repl"></div>
4444
````RAZOR
@@ -54,7 +54,7 @@ The `SpeechToTextButton` component exposes several public methods that you can c
5454

5555
## Supported Browsers
5656

57-
The `SpeechToTextButton` component relies on the Web Speech API. For a list of supported browsers, refer to the [Web Speech API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API#browser_compatibility).
57+
The SpeechToTextButton component relies on the Web Speech API. For a list of supported browsers, refer to the [Web Speech API documentation](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API#browser_compatibility).
5858

5959
## Next Steps
6060

@@ -63,8 +63,8 @@ The `SpeechToTextButton` component relies on the Web Speech API. For a list of s
6363

6464
## See Also
6565

66-
- [SpeechToTextButton Live Demo](https://demos.telerik.com/blazor-ui/speechtotextbutton/overview)
67-
- [SpeechToTextButton API Reference](/blazor-ui/api/Telerik.Blazor.Components.TelerikSpeechToTextButton)
68-
- [SpeechToTextButton Events](slug:speechtotextbutton-events)
69-
- [SpeechToTextButton Appearance](slug:speechtotextbutton-appearance)
70-
- [SpeechToTextButton Integration](slug:speechtotextbutton-integration)
66+
* [SpeechToTextButton Live Demo](https://demos.telerik.com/blazor-ui/speechtotextbutton/overview)
67+
* [SpeechToTextButton API Reference](/blazor-ui/api/Telerik.Blazor.Components.TelerikSpeechToTextButton)
68+
* [SpeechToTextButton Events](slug:speechtotextbutton-events)
69+
* [SpeechToTextButton Appearance](slug:speechtotextbutton-appearance)
70+
* [SpeechToTextButton Integration](slug:speechtotextbutton-integration)

0 commit comments

Comments
 (0)