pagination in salesforce lwc

How To Build Pagination Functionality With lightning-dataTable In Salesforce LWC

In Salesforce we often work with LWC where we need to fetch large amounts of data from salesforce server. And render it on the screen using base lightning-datatable or custom HTML table.

So today in this tutorial, you will learn how to create a custom JavaScript pagination logic with lightning data table component to paginating large data.

We will build a paginated view of the standard contact records in salesforce. Also user can change page size (#number of records on per page) with predefined options. like 5,10,15 and so on.

Output of Salesforce LWC Datable-Table Pagination Example

Following is the result of creating pagination for lightning data table in salesforce using lwc applications.

Lightning Web Component /Apex Controller – Source Code

Apex Controller – ContactDataController.cls

public with sharing class ContactDataController { 

    // apex method to fetch contact records from salesforce database 
    public static list<Contact> fetchContacts(){        
            list<Contact> lstContact = new list<Contact>();
            for(Contact con : [SELECT id,name,email,phone,title FROM Contact LIMIT 5000]){
            return lstContact;        

Html File- dataTableWithPagination.html

    <template if:true={records}>
        <div style="height:400px">
            <lightning-datatable key-field="Id" data={recordsToDisplay} hide-checkbox-column="true" columns={columns}></lightning-datatable>

        <div class="slds-grid slds-grid_vertical-align-center slds-grid_align-spread" style="padding-top: 0.5em;">
            <!--RECORDS PER PAGE-->
            <div class="slds-col">
                <div class="slds-list_inline slds-p-bottom_xx-small">
                    <label class="slds-text-color_weak slds-p-horizontal_x-small" for="recordsPerPage">Page Size:</label>
                    <div class="slds-select_container">
                        <select class="slds-select" id="recordsPerPage" onchange={handleRecordsPerPage}>
                            <template for:each={pageSizeOptions} for:item="option">
                                <option key={option} value={option}>{option}</option>

            <!--PAGE NAVIGATION-->
            <div class="slds-align_absolute-center" style="height:5rem">
                <lightning-button disabled={bDisableFirst} icon-name="utility:jump_to_left" label="First" class="slds-p-horizontal_x-small" alternative-text="first page" onclick={firstPage}></lightning-button>

                <lightning-button disabled={bDisableFirst} icon-name="utility:chevronleft" label="Previous" alternative-text="Previous" onclick={previousPage}></lightning-button>
                <span class="slds-badge">Showing {pageNumber} &nbsp;of&nbsp; {totalPages} &nbsp;&nbsp;Page(s)</span>
                <lightning-button disabled={bDisableLast} icon-name="utility:chevronright" label="Next" alternative-text="Next" onclick={nextPage} class="slds-p-horizontal_x-small" icon-position="right"></lightning-button>

                <lightning-button disabled={bDisableLast} icon-name="utility:jump_to_right" label="Last" alternative-text="last page" onclick={lastPage} icon-position="right"></lightning-button>

            <!--TOTAL RECORDS-->
            <div class="slds-clearfix">
                <div class="slds-float_right">
                    <span class="slds-badge"> Total Records: {totalRecords}</span>

JavaScript File – dataTableWithPagination.js

API : 52
Source :
import {LightningElement} from 'lwc';
//Import apex method 
import fetchContacts from '@salesforce/apex/.fetchContacts';

export default class DatatableWithPagination extends LightningElement {
    // JS Properties 
    pageSizeOptions = [5, 10, 25, 50, 75, 100]; //Page size options
    records = []; //All records available in the data table
    columns = []; //columns information available in the data table
    totalRecords = 0; //Total no.of records
    pageSize; //No.of records to be displayed per page
    totalPages; //Total no.of pages
    pageNumber = 1; //Page number    
    recordsToDisplay = []; //Records to be displayed on the page

    get bDisableFirst() {
        return this.pageNumber == 1;

    get bDisableLast() {
        return this.pageNumber == this.totalPages;

    // connectedCallback method called when the element is inserted into a document
    connectedCallback() {
        // set datatable columns info
        this.columns = [{
                label: 'Name',
                fieldName: 'Name'
                label: 'Email',
                fieldName: 'Email'
                label: 'Phone',
                fieldName: 'Phone'
                label: 'Title',
                fieldName: 'Title'

        // fetch contact records from apex method 
            .then((result) => {
                if (result != null) {
                    console.log('RESULT--> ' + JSON.stringify(result));
                    this.records = result;
                    this.totalRecords = result.length; // update total records count                 
                    this.pageSize = this.pageSizeOptions[0]; //set pageSize with default value as first option
                    this.paginationHelper(); // call helper menthod to update pagination logic 
            .catch((error) => {
                console.log('error while fetch contacts--> ' + JSON.stringify(error));

    handleRecordsPerPage(event) {
        this.pageSize =;

    previousPage() {
        this.pageNumber = this.pageNumber - 1;

    nextPage() {
        this.pageNumber = this.pageNumber + 1;

    firstPage() {
        this.pageNumber = 1;

    lastPage() {
        this.pageNumber = this.totalPages;

    // JS function to handel pagination logic 
    paginationHelper() {
        this.recordsToDisplay = [];
        // calculate total pages
        this.totalPages = Math.ceil(this.totalRecords / this.pageSize);
        // set page number 
        if (this.pageNumber <= 1) {
            this.pageNumber = 1;
        } else if (this.pageNumber >= this.totalPages) {
            this.pageNumber = this.totalPages;

        // set records to display on current page 
        for (let i = (this.pageNumber - 1) * this.pageSize; i < this.pageNumber * this.pageSize; i++) {
            if (i === this.totalRecords) {

Meta xml file – dataTableWithPagination.js-meta.xml

<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="">

The “pageNumber” is set with a value 1, it means whenever the LWC loads it will display the first page as a current-page. Number of items per page is specified using “pageSize” js property and it is assigned with a first index item [5] of ‘pageSizeOptions’ list.
The “totalRecords” JS property denotes the number of total records returned for apex controller. The “recordsToDisplay” array property we are using to filter and store current page records when pagination change. “pageSizeOptions” property has few pre-defined option for page size drop-down. you can change page size default values as per your needs.

In JS file we have a common paginationHelper() function which will calculate paginated records for context page based on total pages and current page number.

Do follow us on social media if you have any queries and for latest updates 🙂

Resources :

Other Popular Blogs :

{!Happy Coding}

One thought on “How To Build Pagination Functionality With lightning-dataTable In Salesforce LWC

Leave a Reply