Components Rating

Edit this page

Rating

A component to filter results based on a rating.

Usage

Basic usage:

<ais-rating attribute-name="rating"></ais-rating>

Custom boundaries:

<ais-rating attribute-name="score" :max="10"></ais-rating>

Props

Name Type Default Description
attribute-name String The attribute name to refine on
min Number 1 Apply operator on refinement
max Number 5 The number of values to display

Slots

Name Props Description
default value, min, max, count The refinement options
header Add content to the top of the component, which will be hidden when the component is hidden
footer Add content to the bottom of the component, which will be hidden when the component is hidden
clear Clear the active rating refinement

CSS Classes

ClassName Description
ais-rating Container class
ais-rating__clear The clear button text
ais-rating__item A refinement option
ais-rating__item--active An active refinement option
ais-rating__value A refinement option value
ais-rating__count A refinement option count
ais-rating__star A star
ais-rating__star--empty An empty star