3.8.0+

Pagination is supported using slots available with Vue Select 3.8 and above.

Pagination can be a super helpful tool when working with large sets of data. If you have 1,000 options, the component is going to render 1,000 DOM nodes. That's a lot of nodes to insert/remove, and chances are your user is only interested in a few of them anyways.

To implement pagination with Vue Select, you can take advantage of the list-footer slot. It appears below all other options in the drop down list.

To make pagination work properly with filtering, you'll have to handle it yourself in the parent. You can use the filterable boolean to turn off Vue Select's filtering, and then hook into the search event to use the current search query in the parent component.

Loading...

<template>
  <v-select :options="paginated" :filterable="false" @search="onSearch">
    <li slot="list-footer" class="pagination">
      <button :disabled="!hasPrevPage" @click="offset -= limit">Prev</button>
      <button :disabled="!hasNextPage" @click="offset += limit">Next</button>
    </li>
  </v-select>
</template>

<script>
import countries from '../data/countries'
export default {
  data: () => ({
    countries,
    search: '',
    offset: 0,
    limit: 10,
  }),
  computed: {
    filtered() {
      return this.countries.filter((country) =>
        country.toLocaleLowerCase().includes(this.search.toLocaleLowerCase())
      )
    },
    paginated() {
      return this.filtered.slice(this.offset, this.limit + this.offset)
    },
    hasNextPage() {
      const nextOffset = this.offset + this.limit
      return Boolean(
        this.filtered.slice(nextOffset, this.limit + nextOffset).length
      )
    },
    hasPrevPage() {
      const prevOffset = this.offset - this.limit
      return Boolean(
        this.filtered.slice(prevOffset, this.limit + prevOffset).length
      )
    },
  },
  methods: {
    onSearch(query) {
      this.search = query
      this.offset = 0
    },
  },
}
</script>

<style scoped>
.pagination {
  display: flex;
  margin: 0.25rem 0.25rem 0;
}
.pagination button {
  flex-grow: 1;
}
.pagination button:hover {
  cursor: pointer;
}
</style>