react-paginate vs react-js-pagination
React Pagination Libraries
react-paginatereact-js-pagination
React Pagination Libraries

React pagination libraries are tools that help developers implement pagination in React applications. Pagination is the process of dividing a large set of data into smaller, manageable chunks or pages, making it easier for users to navigate through the data. These libraries provide pre-built components and functionalities to handle pagination, such as displaying page numbers, next/previous buttons, and handling user interactions to fetch or display data for the selected page. They often come with customizable styles, accessibility features, and support for various pagination strategies, such as infinite scrolling or traditional page-based navigation. By using a pagination library, developers can save time and effort in building pagination from scratch and ensure a more consistent and user-friendly experience in their applications.

Npm Package Weekly Downloads Trend
3 Years
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
react-paginate543,9382,773115 kB6810 months agoMIT
react-js-pagination41,493350-506 years agoCC0-1.0
Feature Comparison: react-paginate vs react-js-pagination

Customization

  • react-paginate:

    react-paginate provides extensive customization capabilities, allowing developers to fully control the pagination UI. It supports custom class names, styles, and even the ability to render custom components for each pagination item, making it much more versatile for design-oriented projects.

  • react-js-pagination:

    react-js-pagination offers basic customization options, such as changing the number of items per page, the total number of items, and the styles of the pagination buttons. However, it is relatively limited compared to react-paginate in terms of layout and design flexibility.

Accessibility

  • react-paginate:

    react-paginate also emphasizes accessibility, but it requires developers to implement some aspects manually, such as adding ARIA attributes and ensuring keyboard navigation. While it is flexible, it may require more effort to make it fully accessible compared to react-js-pagination.

  • react-js-pagination:

    react-js-pagination is designed with accessibility in mind, providing ARIA attributes and keyboard navigation support out of the box. It ensures that the pagination controls are usable by people with disabilities, which is a crucial aspect of modern web development.

Performance

  • react-paginate:

    react-paginate is also performant, but its flexibility and customization features can lead to more complex implementations. For very large datasets, developers need to ensure that they implement pagination efficiently to avoid performance bottlenecks.

  • react-js-pagination:

    react-js-pagination is lightweight and performs well for small to medium-sized datasets. Its simple implementation means that it does not introduce significant overhead, making it a good choice for applications where performance is a concern.

Ease of Integration

  • react-paginate:

    react-paginate requires a bit more setup due to its customizable nature, but it is still relatively easy to integrate. Developers need to handle the pagination logic (e.g., calculating the current page, total pages) and pass it to the component, which may require more initial effort.

  • react-js-pagination:

    react-js-pagination is very easy to integrate into existing React projects. Its API is straightforward, and it requires minimal setup to get started. This makes it a great choice for developers who need a quick and simple solution for pagination.

Code Example

  • react-paginate:

    Custom Pagination with react-paginate

    import React from 'react';
    import ReactPaginate from 'react-paginate';
    
    const MyComponent = () => {
      const handlePageClick = (data) => {
        console.log(data.selected);
      };
    
      return (
        <div>
          <ReactPaginate
            previousLabel={'previous'}
            nextLabel={'next'}
            breakLabel={'...' }
            pageCount={10}
            marginPagesDisplayed={2}
            pageRangeDisplayed={5}
            onPageChange={handlePageClick}
            containerClassName={'pagination'}
            pageClassName={'page-item'}
            pageLinkClassName={'page-link'}
            previousClassName={'previous'}
            nextClassName={'next'}
            breakClassName={'break'}
            activeClassName={'active'}
          />
        </div>
      );
    };
    
    export default MyComponent;
    
  • react-js-pagination:

    Simple Pagination with react-js-pagination

    import React, { useState } from 'react';
    import Pagination from 'react-js-pagination';
    
    const MyComponent = () => {
      const [activePage, setActivePage] = useState(1);
      const handlePageChange = (pageNumber) => {
        setActivePage(pageNumber);
      };
    
      return (
        <div>
          <Pagination
            activePage={activePage}
            itemsCountPerPage={10}
            totalItemsCount={450}
            pageRangeDisplayed={5}
            onChange={handlePageChange}
          />
        </div>
      );
    };
    
    export default MyComponent;
    
How to Choose: react-paginate vs react-js-pagination
  • react-paginate:

    Choose react-paginate if you need a more flexible and customizable pagination solution that supports various layouts and styles. It is suitable for projects that require more control over the pagination UI and behavior, and it works well with larger datasets.

  • react-js-pagination:

    Choose react-js-pagination if you need a simple, lightweight pagination component that is easy to integrate and customize. It is ideal for projects that require basic pagination functionality without a lot of overhead.

README for react-paginate

react-paginate

NPM Build Status

A ReactJS component to render a pagination.

By installing this component and writing only a little bit of CSS you can obtain this: Note: You should write your own css to obtain this UI. This package do not provide any css.

Pagination demo 2

or

Pagination demo 1

Installation

Install react-paginate with npm:

npm install react-paginate --save

Usage

import React, { useEffect, useState } from 'react';
import ReactDOM from 'react-dom';
import ReactPaginate from 'react-paginate';

// Example items, to simulate fetching from another resources.
const items = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14];

function Items({ currentItems }) {
  return (
    <>
      {currentItems &&
        currentItems.map((item) => (
          <div>
            <h3>Item #{item}</h3>
          </div>
        ))}
    </>
  );
}

function PaginatedItems({ itemsPerPage }) {
  // Here we use item offsets; we could also use page offsets
  // following the API or data you're working with.
  const [itemOffset, setItemOffset] = useState(0);

  // Simulate fetching items from another resources.
  // (This could be items from props; or items loaded in a local state
  // from an API endpoint with useEffect and useState)
  const endOffset = itemOffset + itemsPerPage;
  console.log(`Loading items from ${itemOffset} to ${endOffset}`);
  const currentItems = items.slice(itemOffset, endOffset);
  const pageCount = Math.ceil(items.length / itemsPerPage);

  // Invoke when user click to request another page.
  const handlePageClick = (event) => {
    const newOffset = (event.selected * itemsPerPage) % items.length;
    console.log(
      `User requested page number ${event.selected}, which is offset ${newOffset}`
    );
    setItemOffset(newOffset);
  };

  return (
    <>
      <Items currentItems={currentItems} />
      <ReactPaginate
        breakLabel="..."
        nextLabel="next >"
        onPageChange={handlePageClick}
        pageRangeDisplayed={5}
        pageCount={pageCount}
        previousLabel="< previous"
        renderOnZeroPageCount={null}
      />
    </>
  );
}

// Add a <div id="container"> to your HTML to see the component rendered.
ReactDOM.render(
  <PaginatedItems itemsPerPage={4} />,
  document.getElementById('container')
);

Test it on CodePen.

You can also read the code of demo/js/demo.js to quickly understand how to make react-paginate work with a list of objects.

Finally there is this CodePen demo, with features fetching sample code (using GitHub API) and two synchronized pagination widgets.

Props

NameTypeDescription
pageCountNumberRequired. The total number of pages.
pageRangeDisplayedNumberThe range of pages displayed.
marginPagesDisplayedNumberThe number of pages to display for margins.
previousLabelNodeLabel for the previous button.
nextLabelNodeLabel for the next button.
breakLabelNodeLabel for ellipsis.
breakAriaLabelsShapeAria labels of ellipsis elements (Default are { forward: 'Jump forward', backward: 'Jump backward' }).
breakClassNameStringThe classname on tag li of the ellipsis element.
breakLinkClassNameStringThe classname on tag a of the ellipsis element.
onPageChangeFunctionThe method to call when a page is changed. Exposes the current page object as an argument.
onClickFunctionA callback for any click on the component. Exposes information on the part clicked (for eg. isNext for next control), the next expected page nextSelectedPage & others. Can return false to prevent any page change or a number to override the page to jump to.
onPageActiveFunctionThe method to call when an active page is clicked. Exposes the active page object as an argument.
initialPageNumberThe initial page selected, in uncontrolled mode. Do not use with forcePage at the same time.
forcePageNumberTo override selected page with parent prop. Use this if you want to control the page from your app state.
disableInitialCallbackbooleanDisable onPageChange callback with initial page. Default: false
containerClassNameStringThe classname of the pagination container.
classNameStringSame as containerClassName. For use with styled-components & other CSS-in-JS.
pageClassNameStringThe classname on tag li of each page element.
pageLinkClassNameStringThe classname on tag a of each page element.
pageLabelBuilderFunctionFunction to set the text on page links. Defaults to (page) => page
activeClassNameStringThe classname for the active page. It is concatenated to base class pageClassName.
activeLinkClassNameStringThe classname on the active tag a. It is concatenated to base class pageLinkClassName.
previousClassNameStringThe classname on tag li of the previous button.
nextClassNameStringThe classname on tag li of the next button.
previousLinkClassNameStringThe classname on tag a of the previous button.
nextLinkClassNameStringThe classname on tag a of the next button.
disabledClassNameStringThe classname for disabled previous and next buttons.
disabledLinkClassNameStringThe classname on tag a for disabled previous and next buttons.
hrefBuilderFunctionThe method is called to generate the href attribute value on tag a of each page element.
hrefAllControlsBoolBy default the hrefBuilder add href only to active controls. Set this prop to true so href are generated on all controls (see).
extraAriaContextStringDEPRECATED: Extra context to add to the aria-label HTML attribute.
ariaLabelBuilderFunctionThe method is called to generate the aria-label attribute value on each page link
eventListenerStringThe event to listen onto before changing the selected page. Default is: onClick.
renderOnZeroPageCountFunctionA render function called when pageCount is zero. Let the Previous / Next buttons be displayed by default (undefined). Display nothing when null is provided.
prevRelStringThe rel property on the a tag for the prev page control. Default value prev. Set to null to disable.
nextRelStringThe rel propery on the a tag for the next page control. Default value next. Set to null to disable.
prevPageRelStringThe rel property on the a tag just before the selected page. Default value prev. Set to null to disable.
selectedPageRelStringThe rel propery on the a tag for the selected page. Default value canonical. Set to null to disable.
nextPageRelStringThe rel property on the a tag just after the selected page. Default value next. Set to null to disable.

Demo

To run the demo locally, clone the repository and move into it:

git clone git@github.com:AdeleD/react-paginate.git
cd react-paginate

Install dependencies:

npm install

Prepare the demo:

npm run demo

Run the server:

npm run serve

Open your browser and go to http://localhost:3000/

Pagination demo

Contribute

See CONTRIBUTE.md