docs(SpeechToTextButton): add SpeechToTextButton docs #3076
Conversation
Tsvetomir-Hr
force-pushed
the
docs-speech-btn
branch
from
38fd340 to
49a7b01
Compare
| - [SpeechToTextButton Live Demo](https://demos.telerik.com/blazor-ui/speechtotextbutton/overview) | ||
| - [SpeechToTextButton API Reference](/blazor-ui/api/Telerik.Blazor.Components.TelerikSpeechToTextButton) | ||
| - [SpeechToTextButton Events](slug:speechtotextbutton-events) | ||
| - [SpeechToTextButton Appearance](slug:speechtotextbutton-appearance) |
There was a problem hiding this comment.
Use a consistent syntax throughout the article - start all list items below with an asterisk.
|
|
||
| The following example demonstrates how to add the `SpeechToTextButton` to a Blazor page and handle the recognition result. | ||
|
|
||
| **Example of Using the SpeechToTextButton** |
There was a problem hiding this comment.
Don't use bold as a heading or to style a caption. Use the corresponding heading or caption style.
| **Example of Using the SpeechToTextButton** | |
| >caption Example of using the SpeechToTextButton |
|
|
||
| The `SpeechToTextButton` component emits several events that you can handle. For more details, refer to [SpeechToTextButton Events](slug:speechtotextbutton-events). | ||
|
|
||
| ## SpeechToTextButton Parameters |
There was a problem hiding this comment.
Looking at some other Overview articles reveals that they usually have a table with parameters in this section. Consider adding one here.
|
|
||
| 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). | ||
|
|
||
| **Example of Calling a Method by Reference** |
There was a problem hiding this comment.
Use the corresponding caption or heading style, not bold.
|
|
||
| # Blazor SpeechToTextButton Overview | ||
|
|
||
| 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. |
There was a problem hiding this comment.
- Don't use the
inline codestyle for component names. - This comment applies to all occurrences of
SpeechToTextButtonin this PR.
| 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. | |
| 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. |
|
|
||
| ## Icon | ||
|
|
||
| Set the `Icon` parameter to display an icon. You can use a predefined Telerik icon or a custom one. |
There was a problem hiding this comment.
Consider making "Telerik icon" a link leading to the corresponding article.
There was a problem hiding this comment.
Make all Example titles captions.
There was a problem hiding this comment.
Make all Example titles captions.
|
|
||
| # SpeechToTextButton Integration | ||
|
|
||
| Integrate the `SpeechToTextButton` component with forms, input fields, and other UI elements to provide voice input capabilities. |
There was a problem hiding this comment.
Consider describing a sample scenario as a second paragraph after the first sentence. This allows you to add some context and increase the article's length.
|
|
||
| Use the `OnResult` event to update an input field with the recognized text. | ||
|
|
||
| **Example of Binding Recognized Text to an TelerikTextArea** |
Related to: https://github.com/telerik/blazor/issues/11675
Important
The documentation has live examples. To run the examples, checkout to
add-sttb-examplesbranch in theblazorrepository.