Components Pagination

Edit this page

Pagination

A component to navigate between results pages.

🕹 try out live

Usage

Basic usage:

<ais-pagination></ais-pagination>

Customize the number of pages to display around the active one:

<ais-pagination :padding="5"></ais-pagination>

Scroll to the top of the page after a page was changed:

<template>
    <!-- ... -->
    <ais-pagination v-on:page-change="onPageChange"></ais-pagination>
    <!-- ... -->
</template>
<script>
  export default {
    methods: {
      onPageChange(page) {
        window.scrollTo(0,0);
      }
    }
  }
</script>

Props

Name Type Default Description
padding Number 3 Number of pages to display around the active page

Slots

Name Props Default Description
first << First page text
previous < Previous page text
default active, value {{ value }} Page text
next > Next page text
last >> Last page text

CSS Classes

ClassName Description
ais-pagination Container class
ais-pagination__item Page link item
ais-pagination__item--first First link item
ais-pagination__item--previous Previous link item
ais-pagination__item--next Next link item
ais-pagination__item--last Last link item
ais-pagination__link Link anchor

Events

Event name Variables Description
page-change page Triggered right after a page was changed due to an action taken on the pagination component.