Skip to content

Commit fa0aa7e

Browse files
Merge pull request #6901 from syncfusion-content/BLAZ-983104-Rangeslider
Updated UG Documentation for RangeSlider
2 parents 6efa3a8 + 46bda43 commit fa0aa7e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+390
-390
lines changed

blazor/range-slider/accessibility.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ The accessibility compliance for the Blazor Range Slider component is outlined b
1717

1818
| Accessibility Criteria | Compatibility |
1919
| -- | -- |
20-
| [WCAG 2.2](https://www.w3.org/TR/WCAG22/) Support | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
21-
| [Section 508](https://www.section508.gov/) Support | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
20+
| [WCAG 2.2](https://www.w3.org/TR/WCAG22/) Support | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Full support"> |
21+
| [Section 508](https://www.section508.gov/) Support | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Full support"> |
2222
| Screen Reader Support | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
2323
| Right-To-Left Support | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
2424
| Color Contrast | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
@@ -33,45 +33,45 @@ The accessibility compliance for the Blazor Range Slider component is outlined b
3333
}
3434
</style>
3535

36-
<div><img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> - All features of the component meet the requirement.</div>
36+
<div><img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Full support"> - All features of the component meet the requirement.</div>
3737

38-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="Partial"> - Some features of the component do not meet the requirement.</div>
38+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="Partial support"> - Some features of the component do not meet the requirement.</div>
3939

40-
<div><img src="https://cdn.syncfusion.com/content/images/landing-page/no.png" alt="No"> - The component does not meet the requirement.</div>
40+
<div><img src="https://cdn.syncfusion.com/content/images/landing-page/no.png" alt="Not supported"> - The component does not meet the requirement.</div>
4141

4242
## WAI-ARIA attributes
4343

44-
The Blazor Range Slider component followed the [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/slider/) patterns to meet the accessibility. The following ARIA attributes are used in the Range Slider component:
44+
The Blazor Range Slider component follows the [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/slider/) pattern to meet accessibility requirements. The following ARIA attributes are used in the Range Slider component:
4545

4646
| **Attributes** | **Purpose** |
4747
| --- | --- |
48-
| `aria-valuenow` | It indicates the current value of the slider. |
49-
| `aria-valuetext`| It returns the current text of the slider. |
50-
| `aria-valuemin` | It indicates the minimum value of the slider. |
51-
| `aria-valuemax` | It indicates the maximum value of the slider. |
52-
| `aria-orientation` | It indicates the Slider Orientation. |
53-
| `aria-label` | Slider left and right button label text (increment and decrement). |
54-
| `aria-labelledby` | It indicates the name of the Slider. |
48+
| `aria-valuenow` | Indicates the current value of the slider. |
49+
| `aria-valuetext`| Provides a human-readable text alternative for the current value. |
50+
| `aria-valuemin` | Indicates the minimum value of the slider. |
51+
| `aria-valuemax` | Indicates the maximum value of the slider. |
52+
| `aria-orientation` | Indicates the slider orientation. |
53+
| `aria-label` | Defines an accessible name for controls (for example, increment or decrement). |
54+
| `aria-labelledby` | References the element that provides the accessible name for the slider. |
5555

5656
## Keyboard interaction
5757

58-
The Keyboard interaction of the Blazor Range Slider component is designed based on the [WAI-ARIA Practices](https://www.w3.org/TR/wai-aria-practices/#slider) described for Slider. Users can use the following shortcut keys to interact with the Slider.
58+
Keyboard interaction of the Blazor Range Slider component is based on the [WAI-ARIA Practices](https://www.w3.org/TR/wai-aria-practices/#slider) described for sliders. Use the following shortcut keys to interact with the slider.
5959

6060
| Windows | Mac | Actions |
6161
| --- | --- | --- |
62-
| <kbd>↑</kbd> or <kbd>→</kbd> | <kbd>↑</kbd> or <kbd>→</kbd> | Increase the Slider value.|
63-
| <kbd>↓</kbd> , <kbd>←</kbd> | <kbd>↓</kbd> or <kbd>←</kbd> | Decrease the Slider value. |
64-
| <kbd>Home</kbd> | <kbd>Home</kbd> | Moves to the start value (for Range Slider when the second thumb is focused and the Home key is pressed, it moves to the first thumb value). |
65-
| <kbd>End</kbd> | <kbd>End</kbd> | Moves to the end value (for Range Slider when the first thumb is focused and the End key is pressed, it moves to the second thumb value). |
66-
| <kbd>Page Up</kbd> | <kbd>Page Up</kbd> | Increases the Slider by `LargeStep` value. |
67-
| <kbd>Page Down</kbd> | <kbd>Page Down</kbd> | Decreases the Slider by `LargeStep` value. |
62+
| <kbd>↑</kbd> or <kbd>→</kbd> | <kbd>↑</kbd> or <kbd>→</kbd> | Increase the slider value. |
63+
| <kbd>↓</kbd> or <kbd>←</kbd> | <kbd>↓</kbd> or <kbd>←</kbd> | Decrease the slider value. |
64+
| <kbd>Home</kbd> | <kbd>Home</kbd> | Move to the start value (for range sliders, when the second thumb is focused and Home is pressed, it moves to the first thumb’s value). |
65+
| <kbd>End</kbd> | <kbd>End</kbd> | Move to the end value (for range sliders, when the first thumb is focused and End is pressed, it moves to the second thumb’s value). |
66+
| <kbd>Page Up</kbd> | <kbd>Page Up</kbd> | Increase by the `LargeStep` value. |
67+
| <kbd>Page Down</kbd> | <kbd>Page Down</kbd> | Decrease by the `LargeStep` value. |
6868

6969
## Ensuring accessibility
7070

71-
The Blazor Range Slider component's accessibility levels are ensured through an [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) software tool during automated testing.
71+
The Blazor Range Slider components accessibility is validated using the [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) tool during automated testing.
7272

73-
The accessibility compliance of the Range Slider component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/slider) in a new window to evaluate the accessibility of the Range Slider component with accessibility tools.
73+
The accessibility compliance of the Range Slider component is demonstrated in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/slider) in a new window to evaluate the Range Slider component with accessibility tools.
7474

7575
## See also
7676

77-
* [Accessibility in Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components](https://blazor.syncfusion.com/documentation/common/accessibility)
77+
* [Accessibility in Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components](https://blazor.syncfusion.com/documentation/common/accessibility)

blazor/range-slider/format.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,10 @@ documentation: ug
99

1010
# Formatting in Blazor Range Slider Component
1111

12-
The [`Format`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SliderTicks.html#Syncfusion_Blazor_Inputs_SliderTicks_Format) feature used to customize the units of Slider values to desired format. The formatted values will also be applied to the ARIA attributes of the slider. There are two ways of achieving formatting in slider.
12+
The [`Format`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SliderTicks.html#Syncfusion_Blazor_Inputs_SliderTicks_Format) feature is used to customize the units and appearance of slider values. Formatted values are also applied to the ARIA attributes of the slider to ensure accessible output. There are two ways to apply formatting in the slider.
1313

14-
* Use the `Format` API of slider which utilizes our **Internationalization** to format values.
15-
16-
* Customize using the events namely [`TicksRendering`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SliderEvents-1.html#Syncfusion_Blazor_Inputs_SliderEvents_1_TicksRendering) and [`OnTooltipChange`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SliderEvents-1.html#Syncfusion_Blazor_Inputs_SliderEvents_1_OnTooltipChange).
14+
* Use the `Format` API of the slider, which leverages the built-in internationalization and .NET standard format strings.
15+
* Customize formatting using the [`TicksRendering`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SliderEvents-1.html#Syncfusion_Blazor_Inputs_SliderEvents_1_TicksRendering) and [`OnTooltipChange`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SliderEvents-1.html#Syncfusion_Blazor_Inputs_SliderEvents_1_OnTooltipChange) events.
1716

1817
```cshtml
1918
@using Syncfusion.Blazor.Inputs
@@ -28,11 +27,11 @@ The [`Format`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.Sl
2827
}
2928
```
3029

31-
![Formating in Blazor RangeSlider](images/blazor-rangeslider-format.gif)
30+
![Formatting values in the Blazor Range Slider](images/blazor-rangeslider-format.gif)
3231

3332
## Using format API
3433

35-
Slider provides different predefined formatting styles like Numeric (N), Percentage (P), Currency (C) and # specifiers.
34+
Slider provides predefined formatting styles such as Numeric (`N`), Percentage (`P`), Currency (`C`), and custom numeric format strings (for example, `#`). These formats are culture-aware and use the application’s current culture for symbols and separators.
3635

3736
```cshtml
3837
@using Syncfusion.Blazor.Inputs
@@ -48,11 +47,11 @@ Slider provides different predefined formatting styles like Numeric (N), Percent
4847
4948
```
5049

51-
![Blazor Range Slider Format API](images/blazor-rangeslider-format-api.gif)
50+
![Blazor Range Slider format API](images/blazor-rangeslider-format-api.gif)
5251

5352
## Using Events
5453

55-
For custom formatting use event handlers like [`TicksRendering`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SliderEvents-1.html#Syncfusion_Blazor_Inputs_SliderEvents_1_TicksRendering) and [`OnTooltipChange`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SliderEvents-1.html#Syncfusion_Blazor_Inputs_SliderEvents_1_OnTooltipChange). Below is an example where slider values are formatted into weekdays and corresponding tooltip values are formatted as days of the week.
54+
For custom scenarios, use event handlers like [`TicksRendering`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SliderEvents-1.html#Syncfusion_Blazor_Inputs_SliderEvents_1_TicksRendering) and [`OnTooltipChange`](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SliderEvents-1.html#Syncfusion_Blazor_Inputs_SliderEvents_1_OnTooltipChange). The following example formats tick labels as weekday names and tooltips as day numbers.
5655

5756
```cshtml
5857
@using Syncfusion.Blazor.Inputs
@@ -82,4 +81,4 @@ For custom formatting use event handlers like [`TicksRendering`](https://help.sy
8281
8382
```
8483

85-
![Blazor Range Slider Events](images/blazor-rangeslider-format-using-events.png)
84+
![Blazor Range Slider events](images/blazor-rangeslider-format-using-events.png)

0 commit comments

Comments
 (0)