Skip to content

Commit aaa44ad

Browse files
983104: Updated the UG Documentation for Rating
1 parent c14c6be commit aaa44ad

File tree

10 files changed

+128
-130
lines changed

10 files changed

+128
-130
lines changed

blazor/rating/accessibility.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ The accessibility compliance for the Blazor Rating component is outlined below.
1515

1616
| Accessibility Criteria | Compatibility |
1717
| -- | -- |
18-
| [WCAG 2.2 Support](../common/accessibility#accessibility-standards) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
19-
| [Section 508 Support](../common/accessibility#accessibility-standards) |<img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
20-
| [Screen Reader Support](../common/accessibility#screen-reader-support) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
21-
| [Right-To-Left Support](../common/accessibility#right-to-left-support) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
22-
| [Color Contrast](../common/accessibility#color-contrast) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
23-
| [Mobile Device Support](../common/accessibility#mobile-device-support) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
24-
| [Keyboard Navigation Support](../common/accessibility#keyboard-navigation-support) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
25-
| [Axe-core Accessibility Validation](../common/accessibility#ensuring-accessibility) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Yes"> |
18+
| [WCAG 2.2 Support](../common/accessibility#accessibility-standards) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Full support"> |
19+
| [Section 508 Support](../common/accessibility#accessibility-standards) |<img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Full support"> |
20+
| [Screen Reader Support](../common/accessibility#screen-reader-support) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Full support"> |
21+
| [Right-To-left Support](../common/accessibility#right-to-left-support) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Full support"> |
22+
| [Color Contrast](../common/accessibility#color-contrast) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Full support"> |
23+
| [Mobile Device Support](../common/accessibility#mobile-device-support) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Full support"> |
24+
| [Keyboard Navigation Support](../common/accessibility#keyboard-navigation-support) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Full support"> |
25+
| [Axe-core Accessibility Validation](../common/accessibility#ensuring-accessibility) | <img src="https://cdn.syncfusion.com/content/images/landing-page/yes.png" alt="Full support"> |
2626

2727
<style>
2828
.post .post-content img {
@@ -31,43 +31,43 @@ The accessibility compliance for the Blazor Rating component is outlined below.
3131
}
3232
</style>
3333

34-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> - All features of the component meet the requirement.</div>
34+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Full support"> - All features of the component meet the requirement.</div>
3535

36-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="Intermediate"> - Some features of the component do not meet the requirement.</div>
36+
<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>
3737

38-
<div><img src="https://cdn.syncfusion.com/content/images/documentation/not-supported.png" alt="No"> - The component does not meet the requirement.</div>
38+
<div><img src="https://cdn.syncfusion.com/content/images/documentation/not-supported.png" alt="Not supported"> - The component does not meet the requirement.</div>
3939

4040
## WAI-ARIA attributes
4141

42-
The Blazor Rating 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 Blazor Rating component:
42+
The Blazor Rating component follows the [WAI-ARIA slider pattern](https://www.w3.org/WAI/ARIA/apg/patterns/slider/) to meet accessibility requirements. The following ARIA attributes are used in the Blazor Rating component:
4343

4444
| Attributes | Purpose |
4545
| ------------ | ----------------------- |
46-
| `role=slider` | It defines an input where the user selects a value from within a specified range. |
47-
| `role=button` | Specifies that the reset is a clickable element that resets the rating to its minimum value. |
48-
| `aria-label` | Provides an accessible name for Rating. |
49-
| `aria-valuemin` | It defines the minimum value of rating. |
50-
| `aria-valuemax` | It defines the maximum value of rating. |
51-
| `aria-valuenow` | It defines the current value of rating. |
52-
| `aria-hidden` | It specifies whether the reset button is interactive or not. |
46+
| `role=slider` | Defines an input where the user selects a value from within a specified range. |
47+
| `role=button` | Indicates that the reset control is clickable and resets the rating to its minimum value. |
48+
| `aria-label` | Provides an accessible name for the Rating component. |
49+
| `aria-valuemin` | Defines the minimum rating value. |
50+
| `aria-valuemax` | Defines the maximum rating value. |
51+
| `aria-valuenow` | Announces the current rating value. |
52+
| `aria-hidden` | Hides the element from assistive technologies when present. |
5353

5454
## Keyboard interaction
5555

56-
The Blazor Rating component followed the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/slider/#keyboardinteraction) guideline, making it easy for people who use assistive technologies (AT) and those who completely rely on keyboard navigation. The following keyboard shortcuts are supported by the Blazor Rating component.
56+
The Blazor Rating component follows the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/slider/#keyboardinteraction) guideline, improving accessibility for people who use assistive technologies and those who rely on keyboard navigation. The following keyboard shortcuts are supported by the Blazor Rating component.
5757

5858
| Windows | Mac | Actions |
5959
|------------|-------------------| ---|
60-
| <kbd>Space</kbd> | <kbd>Space</kbd> | When **Reset Button** is focused, resets to `min` value. |
60+
| <kbd>Space</kbd> | <kbd>Space</kbd> | When the Reset button is focused, resets to the `min` value. |
6161
| <kbd>↑</kbd> | <kbd>↑</kbd> | Increases the value. |
62-
| <kbd>←</kbd> | <kbd>←</kbd> | Decreases the value; in RTL mode, increases the value. |
62+
| <kbd>←</kbd> | <kbd>←</kbd> | Decreases the value; in right-to-left mode, increases the value. |
6363
| <kbd>↓</kbd> | <kbd>↓</kbd> | Decreases the value. |
64-
| <kbd>→</kbd> | <kbd>→</kbd> | Increases the value; in RTL mode, decreases the value. |
64+
| <kbd>→</kbd> | <kbd>→</kbd> | Increases the value; in right-to-left mode, decreases the value. |
6565

6666
## Ensuring accessibility
6767

68-
The Blazor Rating component's accessibility levels are ensured through an [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) with playwright tests.
68+
The Blazor Rating components accessibility is verified using [axe-core](https://www.nuget.org/packages/Deque.AxeCore.Playwright) with Playwright tests.
6969

70-
The accessibility compliance of the Blazor Rating component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/rating) in a new window to evaluate the accessibility of the Blazor Rating component with accessibility tools.
70+
The accessibility compliance of the Blazor Rating component is demonstrated in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/rating) in a new window to evaluate the component with accessibility tools.
7171

7272
## See also
7373

blazor/rating/appearance.md

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

1010
# Appearance in Blazor Rating Component
1111

12-
You can also customize the appearance of rating component.
12+
The appearance of the Blazor Rating component can be customized to match application design requirements.
1313

1414
## Items count
1515

@@ -23,13 +23,13 @@ You can specify the number of rating items using the [ItemsCount](https://help.s
2323
2424
```
2525

26-
In this example, the rating component will display `8` rating items. The `Value` property specifies the number of rating items that should be filled, so in this case `3` of the `8` rating items will be filled.
26+
In this example, the rating component displays 8 rating items. The `Value` property specifies how many items appear filled, so 3 of the 8 items are filled.
2727

2828
![Blazor Rating Component with ItemsCount](images/blazor-rating-items-count.png)
2929

3030
## Disabled
3131

32-
You can disable the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Rating component by using the [Disabled](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_Disabled) property. When the `Disabled` property is set to `true`, the rating component will be disabled and the user will not be able to interact with it and a disabled rating component may have a different visual appearance than an enabled one.
32+
Disable the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Rating component by using the [Disabled](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_Disabled) property. When the `Disabled` property is set to `true`, the rating component will be disabled and the user will not be able to interact with it and a disabled rating component may have a different visual appearance than an enabled one.
3333

3434
```cshtml
3535
@@ -43,7 +43,7 @@ You can disable the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Rati
4343

4444
## Visible
4545

46-
You can use the [Visible](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_Visible) property of the Blazor Rating component to control the visibility of the component. When the `Visible` property is set to `true`, the rating component will be visible on the page. When it is set to `false`, the component will be hidden.
46+
Use the [Visible](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_Visible) property of the Blazor Rating component to control the visibility of the component. When the `Visible` property is set to `true`, the rating component will be visible on the page. When it is set to `false`, the component will be hidden.
4747

4848
```cshtml
4949
@@ -57,7 +57,7 @@ You can use the [Visible](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazo
5757

5858
## Read only
5959

60-
You can use the [ReadOnly](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_ReadOnly) property of the Blazor Rating component to make the component non-interactive and prevent the user from changing the rating value.
60+
Use the [ReadOnly](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_ReadOnly) property of the Blazor Rating component to make the component non-interactive and prevent changes to the rating value via mouse or keyboard.
6161

6262
```cshtml
6363
@@ -71,11 +71,11 @@ You can use the [ReadOnly](https://help.syncfusion.com/cr/blazor/Syncfusion.Blaz
7171

7272
## CssClass
7373

74-
You can customize the appearance of the rating component, such as by changing its colors, fonts, sizes, or other visual aspects by using the [CssClass](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_CssClass) property.
74+
Customize the appearance of the rating component, such as by changing its colors, fonts, sizes, or other visual aspects by using the [CssClass](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_CssClass) property.
7575

7676
### Changing rating symbol border color
7777

78-
You can change the rating icon border color in Blazor Rating component, you can use the `CssClass` property and set the `text-stroke` CSS property of `.e-rating-icon` to your desired border color.
78+
Change the rating icon border color in Blazor Rating component, you can use the `CssClass` property and set the `text-stroke` CSS property of `.e-rating-icon` to your desired border color.
7979

8080
```cshtml
8181
@@ -97,7 +97,7 @@ You can change the rating icon border color in Blazor Rating component, you can
9797

9898
### Changing rated/un-rated symbol fill color
9999

100-
You can customize the fill colors of rated and un-rated icons in the Rating component using the `CssClass` property and the `linear-gradient` color-stops in the `background` CSS property of `.e-rating-icon`. The **first** color-stop defines the rated fill color and the **second** defines the un-rated fill color.
100+
Customize the fill colors of rated and un-rated icons in the Rating component using the `CssClass` property and the `linear-gradient` color-stops in the `background` CSS property of `.e-rating-icon`. The **first** color-stop defines the rated fill color and the **second** defines the un-rated fill color.
101101

102102
```cshtml
103103
@@ -117,13 +117,13 @@ You can customize the fill colors of rated and un-rated icons in the Rating comp
117117
118118
```
119119

120-
This will customize the rated fill color to `#ffe814` and un-rated fill color to `#d8d7d4`. `--rating-value` in the linear-gradient provides the current value of the rating item.
120+
This customizes the rated fill color to `#ffe814` and the unrated fill color to `#d8d7d4`. The `--rating-value` custom property in the gradient reflects the current value of the rating item.
121121

122122
![Blazor Rating Component with custom fill color for icons](images/blazor-rating-fill-color.png)
123123

124124
### Changing the item spacing
125125

126-
You can change the space between the rating items in Blazor Rating component, by using the `CssClass` property and setting the `margin` / `padding` CSS property of `.e-rating-item-container` to your desired size.
126+
To change the space between rating items in the Blazor Rating component, use the `CssClass` property and set the `margin` or `padding` of `.e-rating-item-container` to the desired size.
127127

128128
```cshtml
129129
@@ -144,7 +144,7 @@ You can change the space between the rating items in Blazor Rating component, by
144144

145145
## Changing icon using CssClass
146146

147-
You can change the rating item icon in Blazor Rating component, you can use the `CssClass` property and set the `content` CSS property of `.e-icons.e-star-filled:before` to your desired font icon.
147+
To change the rating item icon in the Blazor Rating component, use the `CssClass` property and set the `content` of `.e-icons.e-star-filled:before` to the desired font icon.
148148

149149
```cshtml
150150

blazor/rating/events.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This section describes the rating events that will be triggered when appropriate
1313

1414
## Created
1515

16-
The rating component triggers the [Created](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_Created) event when the rendering of the rating component is completed.
16+
The rating component triggers the [Created](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_Created) event after the component rendering is completed. Use this event for initialization logic that depends on the rendered UI.
1717

1818
```cshtml
1919
@@ -32,7 +32,7 @@ The rating component triggers the [Created](https://help.syncfusion.com/cr/blazo
3232

3333
## ValueChanged
3434

35-
The rating component triggers the [ValueChanged](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_ValueChanged) event when the value of the rating is changed. The changed value is passed as the event argument.
35+
The rating component triggers the [ValueChanged](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_ValueChanged) event when the rating value changes. The new value is passed as the event argument.
3636

3737
```cshtml
3838
@@ -51,7 +51,7 @@ The rating component triggers the [ValueChanged](https://help.syncfusion.com/cr/
5151

5252
## OnItemHover
5353

54-
The rating component triggers the [OnItemHover](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_OnItemHover) event when the rating item is hovered. The [RatingHoverEventArgs](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.RatingHoverEventArgs.html) passed as an event argument provides the details of the hovered item.
54+
The rating component triggers the [OnItemHover](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.SfRating.html#Syncfusion_Blazor_Inputs_SfRating_OnItemHover) event when a rating item is hovered. The [RatingHoverEventArgs](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Inputs.RatingHoverEventArgs.html) in the event provides details such as the hovered item’s index and value.
5555

5656
```cshtml
5757

0 commit comments

Comments
 (0)