JIYIK CN >

Pagination is one of the common features in modern web applications. It allows users to browse large amounts of data by dividing the data into multiple pages. In Vue, we can use some libraries and components to implement pagination. In this article, we will take a deep dive into how to implement pagination in Vue.

Install and use the Vue pagination component

The Vue pagination component is an easy-to-use plugin that provides functions such as paginator, pagination navigation bar and pagination table. We can install it through the npm package manager:

$ npm install vue-pagination-component --save

Once installed, we can use it in our Vue component:

<template>
  <div>
    <pagination
      :currentPage="currentPage"
      :perPage="perPage"
      :total="total"
      @page-changed="onPageChanged"
    ></pagination>
  </div>
</template>

<script>
import Pagination from 'vue-pagination-component';

export default {
  components: {
    Pagination,
  },
  data() {
    return {
      currentPage: 1,
      perPage: 10,
      total: 100,
    };
  },
  methods: {
    onPageChanged(page) {
      this.currentPage = page;
    },
  },
};
</script>

In the code above, we use a component called pagination. It needs to be passed three properties: currentPage, perPage, and total. It also requires an event handler @page-changedto update the current page number when the paginator's page number changes.

Implementing a custom paginator

If we need more customized functions, we can use a custom paginator to implement the paging function. In Vue, we can use calculated properties and methods to implement a custom paginator.

<template>
  <div>
    <ul>
      <li v-for="page in pages" :key="page">
        <a href="#" @click.prevent="onPageClick(page)">{{ page }}</a>
      </li>
    </ul>
  </div>
</template>

<script>
export default {
  data() {
    return {
      currentPage: 1,
      perPage: 10,
      total: 100,
    };
  },
  computed: {
    pages() {
      let pages = [];
      let from = Math.max(1, this.currentPage - 2);
      let to = Math.min(this.currentPage + 2, this.totalPages);

      if (from > 1) {
        pages.push(1);
        if (from > 2) {
          pages.push('...');
        }
      }

      for (let i = from; i <= to; i++) {
        pages.push(i);
      }

      if (to < this.totalPages) {
        if (to < this.totalPages - 1) {
          pages.push('...');
        }
        pages.push(this.totalPages);
      }

      return pages;
    },
    totalPages() {
      return Math.ceil(this.total / this.perPage);
    },
  },
  methods: {
    onPageClick(page) {
      this.currentPage = page;
    },
  },
};
</script>

In the code above, we use a computed property called pages to calculate the page numbers in the paginator. We also use a computed property called totalPages to calculate the total number of pages. Finally, we use a onPageClickmethod called to handle the page number event in the paginator.

Implementing server-side paging

If your data is obtained from the server, you can use server-side paging to implement the paging function. In Vue, we can use the Axios library to obtain server data and use calculated properties and methods to implement server-side paging.

<template>
  <div>
    <ul>
      <li v-for="page in pages" :key="page">
        <a href="#" @click.prevent="onPageClick(page)">{{ page }}</a>
      </li>
    </ul>
    <table>
      <thead>
        <tr>
          <th>ID</th>
          <th>Name</th>
          <th>Email</th>
        </tr>
      </thead>
      <tbody>
        <tr v-for="user in users" :key="user.id">
          <td>{{ user.id }}</td>
          <td>{{ user.name }}</td>
          <td>{{ user.email }}</td>
        </tr>
      </tbody>
    </table>
  </div>
</template>

<script>
import axios from 'axios';

export default {
  data() {
    return {
      currentPage: 1,
      perPage: 10,
      total: 0,
      users: [],
    };
  },
  computed: {
    pages() {
      let pages = [];
      let from = Math.max(1, this.currentPage - 2);
      let to = Math.min(this.currentPage + 2, this.totalPages);

      if (from > 1) {
        pages.push(1);
        if (from > 2) {
          pages.push('...');
        }
      }

      for (let i = from; i <= to; i++) {
        pages.push(i);
      }

      if (to < this.totalPages) {
        if (to < this.totalPages - 1) {
          pages.push('...');
        }
        pages.push(this.totalPages);
      }

      return pages;
    },
    totalPages() {
      return Math.ceil(this.total / this.perPage);
    },
  },
  methods: {
    onPageClick(page) {
      this.currentPage = page;
      this.getUsers();
    },
    getUsers() {
      axios
        .get(`/api/users?page=${this.currentPage}&per_page=${this.perPage}`)
        .then((response) => {
          this.total = response.data.total;
          this.users = response.data.users;
        })
        .catch((error) => {
          console.log(error);
        });
    },
  },
  mounted() {
    this.getUsers();
  },
};
</script>

In the code above, we use a getUsersmethod called to fetch server data. We also use a lifecycle hook called mounted to fetch server data when the component is mounted. Finally, we use a onPageClickmethod called to handle the page number event in the paginator and re-fetch the server data.

Summarize

In this article, we took a deep dive into how to implement paging in Vue. We introduced methods to implement paging using Vue paging components, custom paginators, and server-side paging. I hope this article can help you better understand the implementation of paging.