Ratings provide insight regarding others' opinions and experiences, and can allow the user to submit a rating of their own.
The rating can display any float number with the
precision prop to define the minimum increment value change allowed.
You can display a label on hover to help the user pick the correct rating value.
The demo uses the
Here are some examples of customizing the component. You can learn more about this in the overrides documentation page.
The rating is implemented with a radio group, set
highlightSelectedOnly to restore the natural behavior.
The accessibility of this component relies on:
- A radio group with its fields visually hidden.
It contains six radio buttons, one for each star, and another for 0 stars that is checked by default. Be sure to provide a value for the
nameprop that is unique to the parent form.
- Labels for the radio buttons containing actual text ("1 Star", "2 Stars", …).
Be sure to provide a suitable function to the
getLabelTextprop when the page is in a language other than English. You can use the included locales, or provide your own.
- A visually distinct appearance for the rating icons. By default, the rating component uses both a difference of color and shape (filled and empty icons) to indicate the value. In the event that you are using color as the only means to indicate the value, the information should also be also displayed as text, as in this demo. This is important to match success Criterion 1.4.1 of WCAG2.1.
The read only rating has a role of "img", and an aria-label that describes the displayed rating.
Because the rating component uses radio buttons, keyboard interaction follows the native browser behavior. Tab will focus the current rating, and cursor keys control the selected rating.
The read only rating is not focusable.
See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.