Skip to content

Commit a237228

Browse files
Tsvetomir-HrTsvetomir-Hr
committed
chore(SpeechToTextButton): remove tables and add links to api reference instead
1 parent 49a7b01 commit a237228

File tree

3 files changed

+14
-91
lines changed

3 files changed

+14
-91
lines changed

‎components/speechtotextbutton/appearance.md‎

Lines changed: 8 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -14,74 +14,39 @@ You can customize the appearance of the `SpeechToTextButton` component by using
1414

1515
## Size
1616

17-
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:
17+
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

19-
**Available values for the Size parameter**
20-
21-
| Class member | Manual declaration |
22-
|--------------|-------------------|
23-
| Small | `"sm"` |
24-
| Medium (default) | `"md"` |
25-
| Large | `"lg"` |
19+
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).
2620

2721
**Example of Setting the Button Size**
2822

2923
<demo metaUrl="client/speechtotextbutton/size/" height="150"></demo>
3024

3125
## Fill Mode
3226

33-
The `FillMode` toggles the background and border of the TelerikSpeechToTextButton. You can set the parameter to a member of the `Telerik.Blazor.ThemeConstants.Button.FillMode` class:
34-
35-
**Available values for the FillMode parameter**
27+
The `FillMode` toggles the background and border of the TelerikSpeechToTextButton. You can set the parameter to a member of the `Telerik.Blazor.ThemeConstants.Button.FillMode` class.
3628

37-
| Class member | Manual declaration |
38-
|--------------|-------------------|
39-
| Solid (default) | `"solid"` |
40-
| Outline | `"outline"` |
41-
| Flat | `"flat"` |
42-
| Link | `"link"` |
43-
| Clear | `"clear"` |
29+
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).
4430

4531
**Example of Setting the Fill Mode**
4632

4733
<demo metaUrl="client/speechtotextbutton/fillmode/" height="150"></demo>
4834

4935
## Theme Color
5036

51-
The color of the button is controlled through the `ThemeColor` parameter. You can set it to a member of the `Telerik.Blazor.ThemeConstants.Button.ThemeColor` class:
37+
The color of the button is controlled through the `ThemeColor` parameter. You can set it to a member of the `Telerik.Blazor.ThemeConstants.Button.ThemeColor` class.
5238

53-
**Available values for the ThemeColor parameter**
54-
55-
| Class member | Manual declaration |
56-
|--------------|-------------------|
57-
| Base (default) | `"base"` |
58-
| Primary | `"primary"` |
59-
| Secondary | `"secondary"`|
60-
| Tertiary | `"tertiary"` |
61-
| Info | `"info"` |
62-
| Success | `"success"` |
63-
| Warning | `"warning"` |
64-
| Error | `"error"` |
65-
| Dark | `"dark"` |
66-
| Light | `"light"` |
67-
| Inverse | `"inverse"` |
39+
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).
6840

6941
**Example of Setting the Theme Color**
7042

7143
<demo metaUrl="client/speechtotextbutton/themecolor/" height="150"></demo>
7244

7345
## Rounded
7446

75-
The `Rounded` parameter applies the border-radius CSS rule to the button to achieve curving of the edges. You can set it to a member of the `Telerik.Blazor.ThemeConstants.Button.Rounded` class:
76-
77-
**Available values for the Rounded parameter**
47+
The `Rounded` parameter applies the border-radius CSS rule to the button to achieve curving of the edges. You can set it to a member of the `Telerik.Blazor.ThemeConstants.Button.Rounded` class.
7848

79-
| Class member | Manual declaration |
80-
|--------------|-------------------|
81-
| Small | `"sm"` |
82-
| Medium (default) | `"md"` |
83-
| Large | `"lg"` |
84-
| Full | `"full"` |
49+
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).
8550

8651
**Example of Setting the Rounded Parameter**
8752

‎components/speechtotextbutton/events.md‎

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,7 @@ The `SpeechToTextButton` component emits events that notify you about speech rec
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

19-
**Event arguments**
20-
21-
The following table lists the properties of the `SpeechToTextButtonResultEventArgs` class:
22-
23-
@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)
24-
25-
| Property | Type | Description |
26-
|------------------|----------------------------------------------|---------------------------------------------|
27-
| `Alternatives` | `IEnumerable<SpeechRecognitionAlternative>` | The recognized alternatives. |
28-
| `IsFinal` | `bool` | Indicates whether the speech recognition result is final (true) or interim (false).|
29-
30-
Each `SpeechRecognitionAlternative` contains:
31-
32-
| Property | Type | Description |
33-
|------------|----------|-----------------------------|
34-
| `Transcript` | `string` | The recognized text. |
35-
| `Confidence` | `double` | The confidence score level of recognition engine. A floating point value (0.0-1.0). |
19+
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).
3620

3721
**Example: Displaying Recognized Alternatives and Confidence**
3822

‎components/speechtotextbutton/overview.md‎

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -32,37 +32,11 @@ The `SpeechToTextButton` component emits several events that you can handle. For
3232

3333
## SpeechToTextButton Parameters
3434

35-
Configure the `SpeechToTextButton` by setting its parameters:
36-
37-
@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)
38-
39-
| Parameter | Type and Default&nbsp;Value | Description |
40-
|---------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------|
41-
| `Id` | `string` | Sets the `id` attribute of the button. |
42-
| `Icon` | `object` | Specifies the icon rendered in the button. |
43-
| `Title` | `string` | Sets the `title` attribute of the button. |
44-
| `Enabled` | `bool`<br />(`true`) | Specifies whether the button is enabled. |
45-
| `TabIndex` | `int`<br />(`0`) | Sets the `tabindex` attribute of the button. |
46-
| `Lang` | `string`<br />(`browser or system language`) | BCP 47 language tag (for example, `en-US`). |
47-
| `Continuous` | `bool`<br />(`false`) | Specify whether to return continuous results. |
48-
| `InterimResults` | `bool`<br />(`false`) | Specify whether to return interim results. |
49-
| `MaxAlternatives` | `int`<br />(`1`) | The maximum number of recognition alternatives. |
50-
| `IntegrationMode` | `SpeechToTextButtonIntegrationMode`<br />(`WebSpeech`) | Specify the speech recognition engine or integration mode. |
51-
| `AriaLabel` | `string` | Sets the `aria-label` attribute of the button. |
52-
| `AriaLabelledBy` | `string` | Sets the `aria-labelledby` attribute of the button. |
53-
| `AriaDescribedBy` | `string` | Sets the `aria-describedby` attribute of the button. |
54-
| `AriaControls` | `string` | Sets the `aria-controls` attribute of the button. |
55-
56-
## SpeechToTextButtton Reference and Methods
57-
58-
The `SpeechToTextButton` component exposes several public methods that you can call from your code:
59-
60-
| Method | Description |
61-
|----------------|----------------------------------------------------------------------------------------------|
62-
| `StartAsync` | Start the speech-to-text recognition process. |
63-
| `StopAsync` | Stop the speech recognition process. |
64-
| `AbortAsync` | Abort the speech recognition process without returning a result. |
65-
| `Refresh` | Force the component to re-render. |
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).
36+
37+
## SpeechToTextButton Reference and Methods
38+
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).
6640

6741
**Example of Calling a Method by Reference**
6842

0 commit comments

Comments
 (0)