Rating rating link

Full documentation: https://webawesome.com/docs/components/rating

<wa-rating> Stable Since 2.0

Ratings display a numeric score as a row of selectable symbols, typically stars. Use them to capture quick feedback or show an average rating for a product or piece of content.

<wa-rating label="Rating"></wa-rating>

This component works with standard <form> elements. Please refer to the section on form controls to learn more about form submission and client-side validation.

Examples examples link

Labels labels link

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 maximum value link

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 precision link

Use the precision attribute to let users select fractional ratings.

<wa-rating label="Rating" precision="0.5" value="2.5"></wa-rating>

Sizing sizing link

Use the size attribute to adjust the size of the rating.

<wa-rating label="Rating" size="xs"></wa-rating><br />
<wa-rating label="Rating" size="s"></wa-rating><br />
<wa-rating label="Rating" size="m"></wa-rating><br />
<wa-rating label="Rating" size="l"></wa-rating><br />
<wa-rating label="Rating" size="xl"></wa-rating>

For more granular sizing, you can use the font-size property.

<wa-rating label="Rating" style="font-size: 2rem;"></wa-rating>

Readonly readonly link

Use the readonly attribute to display a rating that users can’t change.

<wa-rating label="Rating" readonly value="3"></wa-rating>

Disabled disabled link

Use the disabled attribute to disable the rating.

<wa-rating label="Rating" disabled value="3"></wa-rating>

Detecting Hover detecting hover link

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 custom icons link

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 value based icons link

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>

Required required link

Use the required attribute to make the rating mandatory. The form will not submit if the user hasn’t selected a value.

<form class="rating-required">
  <wa-rating label="Rating" required></wa-rating>
  <br /><br />
  <wa-button appearance="filled" type="submit">Submit</wa-button>
</form>

<script type="module">
  const form = document.querySelector('.rating-required');

  await Promise.all([
    customElements.whenDefined('wa-button'),
    customElements.whenDefined('wa-rating'),
  ]).then(() => {
    form.addEventListener('submit', event => {
      event.preventDefault();
      alert('All fields are valid!');
    });
  });
</script>

Custom Validity custom validity link

Use the setCustomValidity() method to set a custom validation message. This will prevent the form from submitting and make the browser display the error message you provide. To clear the error, call this function with an empty string.

<form class="rating-custom-validity">
  <wa-rating label="Rating"></wa-rating>
  <br /><br />
  <wa-button appearance="filled" type="submit">Submit</wa-button>
</form>

<script type="module">
  const form = document.querySelector('.rating-custom-validity');
  const rating = form.querySelector('wa-rating');
  const errorMessage = 'Please rate at least 3 stars!';

  customElements.whenDefined('wa-rating').then(async () => {
    await rating.updateComplete;
    rating.setCustomValidity(errorMessage);
  });

  rating.addEventListener('change', () => {
    rating.setCustomValidity(rating.value >= 3 ? '' : errorMessage);
  });

  await Promise.all([
    customElements.whenDefined('wa-button'),
    customElements.whenDefined('wa-rating'),
  ]).then(() => {
    form.addEventListener('submit', event => {
      event.preventDefault();
      alert('All fields are valid!');
    });
  });
</script>

Form Submission form submission link

Ratings can be used in forms just like native form controls. The rating’s name and value will be included in the form data when submitted.

<form class="rating-form-submission" action="about:blank" method="get" target="_blank">
  <label style="display: block; margin-bottom: 0.5rem;">How would you rate your experience?</label>
  <wa-rating name="rating" label="Rating" required></wa-rating>
  <br /><br />
  <wa-button type="submit">Submit</wa-button>
  <wa-button appearance="filled" type="reset" variant="neutral">Reset</wa-button>
</form>

Importing importing link

If you’re using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick a component manually, use one of the following snippets.

**CDN**

Import this component directly from the CDN:

import 'https://ka-f.webawesome.com/webawesome@3.7.0/components/rating/rating.js';

**npm**

After installing Web Awesome via npm, import this component:

import '@awesome.me/webawesome/dist/components/rating/rating.js';

**Self-Hosted**

If you’re self-hosting Web Awesome, import this component from your server:

import './webawesome/dist/components/rating/rating.js';

**React**

To import this component for React 18 or below, use the following code:

import WaRating from '@awesome.me/webawesome/dist/react/rating/index.js';

Attributes & Properties attributes properties link

Learn more about attributes and properties.

` By default, form controls are associated with the nearest containing element. This attribute allows you to place the form control outside of a form and associate it with the form that has this id. The form must be in the same document or shadow root for this to work. Type HTMLFormElement \| null | | | | `getSymbol` getSymbol | `` 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 elements. Type (value: number, isSelected: boolean) => string | | | | `label` label | `string` A label that describes the rating to assistive devices. Type Default ‘’ | | | | `max` max | `number` The highest rating to show. Type Default 5 | | | | `name` name | `string \| null` The name of the rating, submitted as a name/value pair with form data. Type Default null | | | | `precision` precision | `0.5` The precision at which the rating will increase and decrease. For example, to allow half-star ratings, set this attribute to . Type number Default 1 | | | | `readonly` readonly | `boolean` Makes the rating readonly. Type Default false | | | | `required` required | `boolean` Makes the rating a required field. Type Default false | | | | `size` size | `‘xs’ \| ‘s’ \| ‘m’ \| ‘l’ \| ‘xl’ \| ‘small’ \| ‘medium’ \| ‘large’` The component’s size. Type Default ‘m’ | | | | `validationTarget` | `undefined \| HTMLElement` Override this to change where constraint validation popups are anchored. Type | | | | `validators` | `observedAttributes` Validators are static because they have , essentially attributes to “watch” for changes. Whenever these attributes change, we want to be notified and update the validator. Type Validator[] Default [] | | | | `value` value | `number` The current rating. Type Default 0 | | |

Methods methods link

Learn more about methods.

Events events link

Learn more about events.

CSS custom properties css custom properties link

Learn more about CSS custom properties.

CSS parts css parts link

Learn more about CSS parts.

Dependencies dependencies link

This component automatically imports the following elements. Sub-dependencies, if any exist, will also be included in this list.

• <wa-icon>

Need a hand? Report a bug Ask for help