| Name | Description | Default | Type |
|---|---|---|---|
value* | The value of the Rating. Could be a decimal or integer. | | number |
aria-label | Aria label for screen readers. | | string |
className | Additional CSS classes. | | string |
maxRating | The maximum rating allowed. Must be an integer greater than 1. | 5 | number |
metaInfo | Text that is displayed in parentheses inline with the Rating stars. | | string |
readOnly | Sets the rating to read only. | false | boolean |
tabIndex | The tabIndex to control focus. | 0 | number |
Rating
core package4.0.1
Note: All components shown on this site are supported by the Constellation design system. To learn how to configure Theme Cosmos, visit Pega Community.
The Rating component is a star-based rating system designed to quickly inform a user about the overall feedback or quality of a product or idea. This is a non-interactive component and is intended to display ratings, rather than accept user input.
Usage
The Rating component represents a numerical value within a range of maxRating as solid-filled star Icons. The stars can be partially filled to support decimal values. Additional information may be displayed within paranthesis inline with the stars by passing a metaInfo string.
Seeing as this component is very visual in its representation of a rating, we suggest the use of a fully descriptive aria-label for accessibility purposes.
Examples
(52 reviews)