Rating

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

Examples

Labels

Ratings are commonly identified contextually, so labels aren’t displayed. However, you should always provide one for assistive devices using the label attribute.

<sl-rating label="Rate this component"></sl-rating>

Maximum Value

Ratings are 0–5 by default. To change the maximum possible value, use the max attribute.

<sl-rating label="Rating" max="3"></sl-rating>

Precision

Use the precision attribute to let users select fractional ratings.

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

Symbol Sizes

Set the --symbol-size custom property to adjust the size.

<sl-rating label="Rating" style="--symbol-size: 2rem;"></sl-rating>

Readonly

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

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

Disabled

Use the disable attribute to disable the rating.

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

Detecting Hover

Use the sl-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">
  <sl-rating label="Rating"></sl-rating>
  <span></span>
</div>

<script>
  const rating = document.querySelector('.detect-hover > sl-rating');
  const span = rating.nextElementSibling;
  const terms = ['No rating', 'Terrible', 'Bad', 'OK', 'Good', 'Excellent'];

  rating.addEventListener('sl-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(--sl-border-radius-small);
    background: var(--sl-color-neutral-900);
    color: var(--sl-color-neutral-0);
    text-align: center;
    padding: 4px 6px;
  }

  .detect-hover span:empty {
    display: none;
  }
</style>

Custom Icons

You can provide custom icons by passing a function to the getSymbol property.

<sl-rating label="Rating" class="rating-hearts" style="--symbol-color-active: #ff4136;"></sl-rating>

<script>
  const rating = document.querySelector('.rating-hearts');
  rating.getSymbol = () => '<sl-icon name="heart"></sl-icon>';
</script>

Value-based Icons

You can also use the getSymbol property to render different icons based on value.

<sl-rating label="Rating" class="rating-emojis"></sl-rating>

<script>
  const rating = document.querySelector('.rating-emojis');

  rating.getSymbol = value => {
    const icons = ['face-angry', 'face-frown', 'face-meh', 'face-smile', 'face-laugh'];
    return `<sl-icon name="${icons[value - 1]}"></sl-icon>`;
  };
</script>

Chip Symbol

Set symbol="chip" to render a numbered CSAT/Likert-style scale instead of stars. Chips are a single-select, whole-number scale — unlike stars, they don’t support fractional precision.

<sl-rating label="How useful was this?" symbol="chip" value="3"></sl-rating>

Chip Sizes

Use the size attribute to change the size of the chips. This attribute only affects symbol="chip" — star mode continues to use the --symbol-size custom property.

<sl-rating label="Rating" symbol="chip" size="small" value="2"></sl-rating>
<br /><br />
<sl-rating label="Rating" symbol="chip" size="medium" value="3"></sl-rating>
<br /><br />
<sl-rating label="Rating" symbol="chip" size="large" value="4"></sl-rating>

Chip with Tooltip

Add show-tooltip to reveal a tooltip to the right of the chips with a sentiment label for the current value. The label follows the value automatically as you hover or select a chip.

<sl-rating label="How useful was this?" symbol="chip" show-tooltip></sl-rating>

For a different scale, set tooltipLabels to an array of terms, one per whole-number value from 0 to max. It’s also used as each chip’s accessible name, so assistive technology always announces the sentiment even when the tooltip isn’t shown.

<sl-rating label="Agreement" symbol="chip" show-tooltip max="4" class="rating-agreement"></sl-rating>

<script>
  const rating = document.querySelector('.rating-agreement');
  const terms = ['No answer', 'Disagree', 'Neutral', 'Agree', 'Strongly agree'];

  rating.tooltipLabels = terms;
</script>

If a label can’t be expressed as a simple array — say it depends on other state — override getTooltipLabel instead; it defaults to reading from tooltipLabels.

Chip Disabled

Chips respect the same disabled attribute as stars, dimming to 50% opacity and removing every chip from the tab order.

<sl-rating label="Rating" symbol="chip" disabled value="3"></sl-rating>