Pagination In Vue3 Application Using '@ocrv/vue-tailwind-pagination' Plugin

In this article, we will understand the pagination in the Vue3 application using the '@ocrv/vue-tailwind-pagination' plugin.

Key Features Of Plugin:

• current - The 'current' property to set the current page number.
• total - The 'total' property that represents the number of records for the table content. So based on this 'total' property value, the total number of page numbers display depends.
• per-page - The 'per-page' property to set the count for the records to display for each page.
• page-changed - The 'page-changed' event that raises on selecting the page. It outputs  '$event' which is nothing but the selected page number.

Create A Vue3 Sample Application:

To implement our pagination sample let's begin by creating a Vue3 sample application.

Command To Create Vue3 Application:
Vue Create Your_Sample_App_name

Install Tailwind Pagination NPM Package:

Tailwind Pagination NPM Package Command:
npm install --save @ocrv/vue-tailwind-pagination

Configure And Implement Pagination Component:

Let's visualize the pagination component by integrating it. So here I'm going to use the existing 'HelloWorld.vue' component to render the pagination component, so clear up the existing code and add the following.

src/components/HelloWorld.vue:(Html Part)

<template>
  <div class="hello">
    <VueTailwindPagination
      :current="currentPage"
      :total="total"
      :per-page="perPage"
      @page-changed="onPageClick($event)"
    />
  </div>
</template>

• (Line 3) Rendering the 'VueTailwindPagination' vue component.
• Pagination component configured with key features like 'current', 'total', 'per-page' input properties. Also registered a 'page-changed' event which fires on clicking the page. The '$event' outputs by the 'page-changed' event are clicked page numbers.

<script>
import "@ocrv/vue-tailwind-pagination/dist/style.css";
import VueTailwindPagination from "@ocrv/vue-tailwind-pagination";
export default {
  components: {
    VueTailwindPagination,
  },
  data() {
    return {
      currentPage: 1,
      perPage: 2,
      total: 100,
    };
  },
  methods:{
    onPageClick(event){
      this.currentPage = event;
    }
  }
};
</script>

• (Line: 2) Importing our pagination component CSS file which contains tailwind CSS styles.
• (Line: 3) Importing the 'VueTailwindPagination' vue component from the '@ocr/vue-tailwind-paginatin' library.
• (Line: 6) Register 'VueTailwindPagination' component.
• (Line: 10) The 'currentPage' variable represents the selected page number. The 'currentPage' value will be assigned to 'current' property of the pagination vue component.
• (Line: 11) The 'perPage' variable represents the records to display for a page in a table. So using this 'perPage' value and the total number of records our pagination components calculates the number of page numbers to be generated. The value of 'perPage' will be assigned to 'per-page' property of the pagination vue component
• (Line: 12) The 'total' variable represents the total records for the table content.
• (Line: 16-18) The 'onPageClick' is callback method for the event 'page-changed'. This method invoked on selecting a page and then assigning the selected page value to the variable 'currentPage'.

Third-Party Rest API:

We will upgrade our sample to work with real-time API which filters data based on page numbers. Here I'm using free rest API for our sample like "https://reqres.in/api/users?page=1". The JSON response from the API looks as below.

Here from the image response contains properties like:

• 'page' - current selected page.
• 'per-page' - number of records count per page.
• 'total' - total record count.

Install Axios Plugin:

In vue to invoke API's best plugin to use is 'Axios'.

Axios Command:
npm install axios

Invoke API And Render The Response To A Table:

Now we will update our sample to consume API and test our pagination to invoke the API per page click.

I will use the bootstrap table to display the response content and the content will be changed on page click. So first let's add the bootstrap CSS file in the index.html.

public/index.html:

<link 
href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-beta2/dist/css/bootstrap.min.css" 
rel="stylesheet" 
integrity="sha384-BmbxuPwQa2lc/FVzBcNJ7UAyJxM6wuqIj61tLrc4wSX0szH/Ev+nYRRuWlolflfl" crossorigin="anonymous">

Let's update our sample now in 'Helloworld.vue' file.

src/components/Helloworld.vue:(Html Part)

<template>
  <div class="hello">
    <VueTailwindPagination
      :current="currentPage"
      :total="total"
      :per-page="perPage"
      @page-changed="onPageClick($event)"
    />
  </div>
  <table class="table table-dark table-striped">
    <thead>
      <tr>
        <th scope="col">Id</th>
        <th scope="col">Email</th>
        <th scope="col">First Name</th>
        <th scope="col">Last Name</th>
      </tr>
    </thead>
    <tbody>
      <tr v-for="d in data" v-bind:key="d.id">
        <td>{{ d.id }}</td>
        <td>{{ d.email }}</td>
        <td>{{ d.first_name }}</td>
        <td>{{ d.last_name }}</td>
      </tr>
    </tbody>
  </table>
</template>

• (Line: 20-25) Binding the table data by looping each row.

src/components/Helloworld.vue:

<script>
import "@ocrv/vue-tailwind-pagination/dist/style.css";
import VueTailwindPagination from "@ocrv/vue-tailwind-pagination";
import axios from "axios";
export default {
  components: {
    VueTailwindPagination,
  },
  data() {
    return {
      currentPage: 0,
      perPage: 0,
      total: 0,
      data: [],
    };
  },
  methods: {
    onPageClick(event) {
      this.currentPage = event;
      this.getData(this.currentPage);
    },
    async getData(pageNumber) {
      var response = await axios.get(
        `https://reqres.in/api/users?page=${pageNumber}`
      );
      var responseData = response.data;
      this.currentPage = responseData.page;
      this.perPage = responseData.per_page;
      this.total = responseData.total;
      this.data = response.data.data;
    },
  },
  mounted(){
    this.currentPage = 1;
    this.getData(this.currentPage);
  }
};
</script>

• (Line: 22-32) The 'getData' method invokes our API, while invoking the API we are passing page number as the query parameter. On receiving the response we are populating table data and also the populating the input properties of the pagination vue component.
• (Line: 18-21) Inside 'onPageClick' method we update our logic to invoke the API with respect to the page number clicked.
• (Line: 33-36) Inside 'mounted' method we are fetching API data for the page number '1' for the initial data display.

So that's about the usage of the pagination component in our vue3 application.

Video Session:

 

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information to integrate pagination vue component in the Vue3 application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

YouTube

Facebook

Twitter

Pinterest