Skip to main content
Signature
<ais-refinement-list
  attribute="string"
  // Optional parameters
  operator="string"
  :limit="number"
  :show-more="boolean"
  :show-more-limit="number"
  :searchable="boolean"
  :searchable-placeholder="string"
  :sort-by="string[] | function"
  :transform-items="function"
  :class-names="object"
/>

​
Import

  • Component
  • Plugin
To ensure optimal bundle sizes, see Optimize build size.
Vue
import { AisRefinementList } from "vue-instantsearch";
// Use "vue-instantsearch/vue3/es" for Vue 3

export default {
  components: {
    AisRefinementList,
  },
  // ...
};
View demo

​
About this widget

The ais-refinement-list widget is one of the most common widgets in a search UI. With this widget, users can filter the dataset based on facets. The widget only displays the most relevant facet values for the current search context. The sort option only affects the facets that are returned by the engine, not which facets are returned. This widget includes a “search for facet values” feature, enabling users to search through the values of a specific facet attribute. This makes it easy to find uncommon facet values.

​
Requirements

The attribute provided to the widget must be in attributes for faceting, either on the dashboard or using the attributesForFaceting parameter with the API. If you are using the searchable prop, you also need to make the attribute searchable using the dashboard or using the searchable modifier of attributesForFaceting with the API.

​
Disappearing facet values

With many facet values, the available options can change depending on the user’s query. The refinement widget displays the most common facet values for a given query. A user’s chosen value can vanish if they alter the query. This occurs because only the most common facet values are displayed when there are many options. A previously selected value might not appear if it’s uncommon for the new query. To also show less common values, adjust the maximum number of values with the configure widget. It doesn’t change how many items are shown: the limits you set with limit and show-more-limit still apply.

​
Examples

Vue
<ais-refinement-list attribute="brand" />

​
Props

​
attribute
string
required
The name of the attribute in the records.To avoid unexpected behavior, you can’t use the same attribute prop in a different type of widget.
Vue
<ais-refinement-list attribute="brand" />
​
operator
string ('or'|'and')
default:"or"
How to apply refinements.
  • 'or': Returns results matching any of the selected values.
  • 'and': Returns results matching all selected values.
Use filters or facet filters for more complex result refinement.
Vue
<ais-refinement-list
  [...]
  operator="and"
/>
​
limit
number
default:10
How many facet values to retrieve. When you enable the show-more feature, this is the number of facet values to display before clicking the “Show more” button.
Vue
<ais-refinement-list
  [...]
  :limit="5"
/>
​
show-more
boolean
default:false
Whether to display a button that expands the number of items.
Vue
<ais-refinement-list
  [...]
  show-more
/>
​
show-more-limit
number
default:20
The maximum number of displayed items (only used when show-more is set to true).
Vue
<ais-refinement-list
  [...]
  :show-more-limit="15"
/>
​
searchable
boolean
default:false
Adds a search input to let users search for more facet values. To make this feature work, you need to make the attribute searchable using the dashboard) or using the searchable modifier of attributesForFaceting with the API.
In some situations, refined facet values might not be present in the data returned by Algolia.
Vue
<ais-refinement-list
  [...]
  searchable
/>
​
searchable-placeholder
string
default:"Search here…"
The value of the search input placeholder.
Vue
<ais-refinement-list
  [...]
  searchable-placeholder="Search our products"
/>
​
sort-by
string[] | function
How to sort refinements. Must be one or more of the following strings:
  • "count" (same as "count:desc")
  • "count:asc"
  • "count:desc"
  • "name" (same as "name:asc")
  • "name:asc"
  • "name:desc"
  • "isRefined" (same as "isRefined:asc")
  • "isRefined:asc"
  • "isRefined:desc"
It’s also possible to give a function, which receives items two by two, like JavaScript’s Array.sort.If facetOrdering is set for this facet in renderingContent, and no value for sortBy is passed to this widget, facetOrdering is used, and the default order as a fallback.In some situations, refined facet values might not be present in the data returned by Algolia.
To prevent creating infinite loops, avoid passing arrays, objects, or functions directly in the template. These values aren’t referentially equal on each render, which causes the widget to re-register every time. Instead, define them in your component’s data option and reference them in the template.
Vue
<ais-refinement-list
  [...]
  :sort-by="['isRefined', 'name:asc']"
/>
​
transform-items
function
default:"items => items"
A function that receives the list of items before they are displayed. It should return a new array with the same structure. Use this to transform, filter, or reorder the items.The function also has access to the full results data, including all standard response parameters and parameters from the helper, such as disjunctiveFacetsRefinements.
Vue
<template>
  <!-- ... -->
  <ais-refinement-list
    [...]
    :transform-items="transformItems"
  />
</template>

<script>
  export default {
    methods: {
      transformItems(items) {
        return items.map(item => ({
          ...item,
          label: item.label.toUpperCase(),
        }));
      },

      /* or, combined with results */
      transformItems(items, { results }) {
        return results.page === 0
          ? items.slice(0, 5)
          : items;
      },
    },
  };
</script>
​
class-names
object
default:"{}"
The CSS classes you can override:
  • .ais-RefinementList. The root element of the widget.
  • .ais-RefinementList--noRefinement. The root element of the widget with no refinement.
  • .ais-RefinementList-list. The list of all items.
  • .ais-RefinementList-item. The list item.
  • .ais-RefinementList-item--selected. The selected list item.
  • .ais-RefinementList-label. The label of each item.
  • .ais-RefinementList-labelText. The text of the label of each item.
  • .ais-RefinementList-checkbox. The checkbox element.
  • .ais-RefinementList-count. The count of values for each item.
  • .ais-RefinementList-searchBox. The search box when the widget is searchable.
  • .ais-RefinementList-noResults. The element rendered when the search doesn’t have results.
  • .ais-RefinementList-showMore. The button used to display more categories (enabled).
  • .ais-RefinementList-showMore--disabled. The button used to display more categories (turned off).
Vue
<ais-refinement-list
  [...]
  :class-names="{
    'ais-RefinementList': 'MyCustomRefinementList',
    'ais-RefinementList-item': 'MyCustomRefinementListItem',
    // ...
  }"
/>

​
Customize the UI

​
default
The slot to override the complete DOM output of the widget.When you implement this slot, none of the other slots will change the output, as the default slot surrounds them.Scope
  • items: object[]. The values applicable to this widget.
  • isShowingMore: boolean. Is show-more enabled?
  • isFromSearch: boolean. true if there are search results.
  • canRefine: boolean. Can the refinement be applied?
  • canToggleShowMore: boolean. Is show-more possible?
  • toggleShowMore: () => void. Toggles the number of displayed values between limit and show-more-limit.
  • searchForItems: (value: string) => void. A function to search into the facet values.
  • refine: (value: string) => void. A function to select a refinement.
  • createURL: (value: string) => string. A function to return a link for this refinement.
  • sendEvent: (eventType: 'click', facetValue: string) => void. The function to send click events.
    • The view event is automatically sent when the facets are rendered.
    • The click event is automatically sent when refine is called.
    • You can learn more about the insights middleware.
Where each item is an object containing:
  • value: string. The value of the item.
  • label: string. The human-readable value of the item.
  • count: number. The number of matched results after a refinement is applied.
  • isRefined: boolean. Indicates if the refinement is applied.
Vue
<ais-refinement-list attribute="brand" searchable show-more>
  <template
    v-slot="{
      items,
      isShowingMore,
      isFromSearch,
      canToggleShowMore,
      refine,
      createURL,
      toggleShowMore,
      searchForItems,
      sendEvent,
    }"
  >
    <input @input="searchForItems($event.currentTarget.value)">
    <ul>
      <li v-if="isFromSearch && !items.length">No results.</li>
      <li v-for="item in items" :key="item.value">
        <a
          :href="createURL(item)"
          :style="{ fontWeight: item.isRefined ?  'bold' : '' }"
          @click.prevent="refine(item.value)"
        >
          <ais-highlight attribute="item" :hit="item"/>
          ({{ item.count.toLocaleString() }})
        </a>
      </li>
    </ul>
    <button
      @click="toggleShowMore"
      :disabled="!canToggleShowMore"
    >
      {{ !isShowingMore ? 'Show more' : 'Show less'}}
    </button>
  </template>
</ais-refinement-list>
​
item
The slot to override the DOM output of an item.Scope
  • item: object. An item object.
  • refine: (Item.value) => void. A function to select a refinement.
  • createURL: (Item) => string. A function to return a link for this refinement.
Where an item is an object containing:
  • value: string. The value of the item.
  • label: string. The human-readable value of the item.
  • count: number. The number of results matched after a refinement is applied.
  • isRefined: boolean. Indicates if the refinement is applied.
Vue
<ais-refinement-list attribute="brand">
  <template v-slot:item="{ item, refine, createURL }">
    <a
      :href="createURL(item.value)"
      :style="{ fontWeight: item.isRefined ? 'bold' : '' }"
      @click.prevent="refine(item.value)"
    >
      <ais-highlight attribute="item" :hit="item"/>
      ({{ item.count.toLocaleString() }})
    </a>
  </template>
</ais-refinement-list>
​
showMoreLabel
The slot to override the DOM output of the “Show more” button.Scope
  • isShowingMore: boolean. Is the list of items expanded?
Vue
<ais-refinement-list attribute="brand" show-more>
  <template v-slot:showMoreLabel="{ isShowingMore }">
    {{ !isShowingMore ? 'More' : 'Less' }}
  </template>
</ais-refinement-list>
​
noResults
The slot to override the DOM output of the no results placeholder.Scope
  • query: string. The current value of the query.
Vue
<ais-refinement-list attribute="brand" searchable>
  <template v-slot:noResults="{ query }">
    No results for
    <q>{{ query }}</q>
  </template>
</ais-refinement-list>

​
HTML output

HTML
<div class="ais-RefinementList">
  <div class="ais-RefinementList-searchBox">
    <!-- SearchBox widget here -->
  </div>
  <ul class="ais-RefinementList-list">
    <li class="ais-RefinementList-item ais-RefinementList-item--selected">
      <label class="ais-RefinementList-label">
        <input
          class="ais-RefinementList-checkbox"
          type="checkbox"
          value="Insignia™"
          checked
        />
        <span class="ais-RefinementList-labelText">Insignia™</span>
        <span class="ais-RefinementList-count">746</span>
      </label>
    </li>
    <li class="ais-RefinementList-item">
      <label class="ais-RefinementList-label">
        <input
          class="ais-RefinementList-checkbox"
          type="checkbox"
          value="Samsung"
        />
        <span class="ais-RefinementList-labelText">Samsung</span>
        <span class="ais-RefinementList-count">633</span>
      </label>
    </li>
  </ul>
  <button class="ais-RefinementList-showMore">Show more</button>
</div>
⌘I