Rating
<wa-rating>
Ratings give users a way to quickly view and provide feedback.
<wa-rating label="Rating"></wa-rating>
Examples
Jump to heading
Labels
Jump to heading
Ratings are commonly identified contextually, so labels aren't displayed. However, you should always provide one for assistive devices using the label attribute.
<wa-rating label="Rate this component"></wa-rating>
Maximum Value
Jump to heading
Ratings are 0-5 by default. To change the maximum possible value, use the max attribute.
<wa-rating label="Rating" max="3"></wa-rating>
Precision
Jump to heading
Use the precision attribute to let users select fractional ratings.
<wa-rating label="Rating" precision="0.5" value="2.5"></wa-rating>
Sizing
Jump to heading
Use the size attribute to adjust the size of the rating.
<wa-rating label="Rating" size="small"></wa-rating><br /> <wa-rating label="Rating" size="medium"></wa-rating><br /> <wa-rating label="Rating" size="large"></wa-rating>
For more granular sizing, you can use the font-size property.
<wa-rating label="Rating" style="font-size: 2rem;"></wa-rating>
Readonly
Jump to heading
Use the readonly attribute to display a rating that users can't change.
<wa-rating label="Rating" readonly value="3"></wa-rating>
Disabled
Jump to heading
Use the disabled attribute to disable the rating.
<wa-rating label="Rating" disabled value="3"></wa-rating>
Detecting Hover
Jump to heading
Use the wa-hover event to detect when the user hovers over (or touch and drag) the rating. This lets you hook into values as the user interacts with the rating, but before they select a value.
The event has a payload with phase and value properties. The phase property tells when hovering starts, moves to a new value, and ends. The value property tells what the rating's value would be if the user were to commit to the hovered value.
<div class="detect-hover"> <wa-rating label="Rating"></wa-rating> <span></span> </div> <script> const rating = document.querySelector('.detect-hover > wa-rating'); const span = rating.nextElementSibling; const terms = ['No rating', 'Terrible', 'Bad', 'OK', 'Good', 'Excellent']; rating.addEventListener('wa-hover', event => { span.textContent = terms[event.detail.value]; // Clear feedback when hovering stops if (event.detail.phase === 'end') { span.textContent = ''; } }); </script> <style> .detect-hover span { position: relative; top: -4px; left: 8px; border-radius: var(--wa-border-radius-m); background: var(--wa-color-neutral-fill-loud); color: var(--wa-color-neutral-on-loud); text-align: center; padding: 4px 6px; } .detect-hover span:empty { display: none; } </style>
Custom Icons
Jump to heading
You can provide custom icons by passing a function to the getSymbol property.
<wa-rating label="Rating" class="rating-hearts" style="--symbol-color-active: #ff4136;"></wa-rating> <script type="module"> const rating = document.querySelector('.rating-hearts'); await customElements.whenDefined('wa-rating'); await rating.updateComplete; rating.getSymbol = () => '<wa-icon name="heart" variant="solid"></wa-icon>'; </script>
Value-based Icons
Jump to heading
You can also use the getSymbol property to render different icons based on value and/or whether the icon is currently selected.
<wa-rating label="Rating" class="rating-emojis"></wa-rating> <script type="module"> const rating = document.querySelector('.rating-emojis'); await customElements.whenDefined('wa-rating'); await rating.updateComplete; rating.getSymbol = (value, isSelected) => { const icons = ['face-angry', 'face-frown', 'face-meh', 'face-smile', 'face-laugh']; return `<wa-icon name="${icons[value - 1]}"></wa-icon>`; }; </script>
Attributes & Properties
Jump to heading
Learn more about attributes and properties.
| Name | Description | Reflects | |
|---|---|---|---|
labellabel |
A label that describes the rating to assistive devices.
Type
stringDefault
'' |
||
valuevalue |
The current rating.
Type
numberDefault
0 |
||
maxmax |
The highest rating to show.
Type
numberDefault
5 |
||
precisionprecision |
The precision at which the rating will increase and decrease. For example, to allow half-star ratings, set this
attribute to
0.5.Type
numberDefault
1 |
||
readonlyreadonly |
Makes the rating readonly.
Type
booleanDefault
false |
|
|
disableddisabled |
Disables the rating.
Type
booleanDefault
false |
|
|
getSymbolgetSymbol |
A function that customizes the symbol to be rendered. The first and only argument is the rating's current value.
The function should return a string containing trusted HTML of the symbol to render at the specified value. Works
well with
<wa-icon> elements.Type
(value: number, isSelected: boolean) => string |
||
sizesize |
The component's size.
Type
'small' | 'medium' | 'large'Default
'medium' |
|
Methods
Jump to heading
Learn more about methods.
| Name | Description | Arguments |
|---|---|---|
focus() |
Sets focus on the rating. |
options: FocusOptions
|
blur() |
Removes focus from the rating. |
Events
Jump to heading
Learn more about events.
| Name | Description |
|---|---|
change |
Emitted when the rating's value changes. |
wa-hover |
Emitted when the user hovers over a value. The phase property indicates when hovering starts, moves to a new value, or ends. The value property tells what the rating's value would be if the user were to commit to the hovered value. |
CSS custom properties
Jump to heading
Learn more about CSS custom properties.
| Name | Description |
|---|---|
--symbol-color |
The inactive color for symbols.
|
--symbol-color-active |
The active color for symbols.
|
--symbol-spacing |
The spacing to use around symbols.
|
CSS parts
Jump to heading
Learn more about CSS parts.
| Name | Description | CSS selector |
|---|---|---|
base |
The component's base wrapper. |
::part(base)
|
Dependencies
Jump to heading
This component automatically imports the following elements. Sub-dependencies, if any exist, will also be included in this list.
Importing
Jump to heading
Autoloading components via projects is the recommended way to import components. If you prefer to do it manually, use one of the following code snippets.
Let your project code do the work! Sign up for free to use a project with your very own CDN — it's the fastest and easiest way to use Web Awesome.
To manually import this component from NPM, use the following code.
import '@awesome.me/webawesome/dist/components/rating/rating.js';
To manually import this component from React, use the following code.
import WaRating from '@awesome.me/webawesome/dist/react/rating';