Skip to main content
Signature
<ais-hits-per-page
  :items="object[]"
  // Optional parameters
  :transform-items="function"
  :class-names="object"
/>

​
Import

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

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

​
About this widget

The ais-hits-per-page widget displays a select element to let users change the number of displayed hits. If you only want to configure the number of hits per page without displaying a widget, you can use the ais-configure widget with the hitsPerPage search parameter.

​
Examples

Vue
<ais-hits-per-page
  :items="[
    { label: '8 hits per page', value: 8, default: true },
    { label: '16 hits per page', value: 16 },
  ]"
/>

​
Props

​
items
object[]
required
The list of available options, with each item:
  • label: string. The label to display in the option.
  • value: number. The number of hits to display per page.
  • default: boolean. Whether it’s the default hits per page on first search.
Vue
<ais-hits-per-page
  :items="[
    { label: '8 hits per page', value: 8, default: true },
    { label: '16 hits per page', value: 16 },
  ]"
/>
​
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.
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
<template>
  <!-- ... -->
  <ais-hits-per-page
    [...]
    :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 items.map((item) => ({
        ...item,
        label:
          item.isRefined && results
            ? `${item.label} (${results.nbPages} pages in total)`
            : item.label,
      }));
    },
  },
};
</script>
​
class-names
object
default:"{}"
The CSS classes you can override:
  • ais-HitsPerPage. The root of the widget.
  • ais-HitsPerPage-select. The select element.
  • ais-HitsPerPage-option. The option element of the select.
Vue
<ais-hits-per-page
  [...]
  :class-names="{
    'ais-HitsPerPage': 'MyCustomHitsPerPage',
    'ais-HitsPerPage-select': 'MyCustomHitsPerPageSelect',
    // ...
  }"
/>

​
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 list of items the widget can display.
  • canRefine: boolean. Whether a refinement can be applied.
  • refine: (value: number) => void. The function to call with the next value of hits per page.
Where each item is an object containing:
  • label: string. The label to display in the option.
  • value: number. The number of hits to display per page.
  • isRefined: boolean. Indicates if the item is the current refined value.
Vue
<ais-hits-per-page
  :items="[
    { label: '8 hits per page', value: 8, default: true },
    { label: '16 hits per page', value: 16 },
  ]"
>
  <template v-slot="{ items, refine }">
    <ul>
      <li v-for="item in items" :key="item.value">
        <button
          :style="{ fontWeight: item.isRefined ? 'bold' : '' }"
          @click="refine(item.value)"
        >
          {{ item.label }}
        </button>
      </li>
    </ul>
  </template>
</ais-hits-per-page>

​
HTML output

HTML
<div class="ais-HitsPerPage">
  <select class="ais-HitsPerPage-select">
    <option class="ais-HitsPerPage-option" value="8">8 per page</option>
    <option class="ais-HitsPerPage-option" value="16">16 per page</option>
  </select>
</div>
⌘I