Socket
Socket
Sign inDemoInstall

react-paginate

Package Overview
Dependencies
6
Maintainers
1
Versions
106
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    react-paginate

A ReactJS component that creates a pagination.


Version published
Weekly downloads
468K
increased by2.58%
Maintainers
1
Install size
447 kB
Created
Weekly downloads
 

Package description

What is react-paginate?

react-paginate is a React component that helps in creating pagination for your data. It provides a flexible and customizable way to paginate through large sets of data, making it easier to navigate and manage.

What are react-paginate's main functionalities?

Basic Pagination

This code demonstrates a basic usage of react-paginate. It sets up a pagination component with labels for previous and next buttons, a break label, and specifies the number of pages to display. The handlePageClick function logs the selected page number.

import ReactPaginate from 'react-paginate';

function PaginationComponent() {
  const handlePageClick = (data) => {
    console.log(data.selected);
  };

  return (
    <ReactPaginate
      previousLabel={'previous'}
      nextLabel={'next'}
      breakLabel={'...'}
      breakClassName={'break-me'}
      pageCount={10}
      marginPagesDisplayed={2}
      pageRangeDisplayed={5}
      onPageChange={handlePageClick}
      containerClassName={'pagination'}
      subContainerClassName={'pages pagination'}
      activeClassName={'active'}
    />
  );
}

Custom Styling

This example shows how to apply custom styling to the pagination component by importing a CSS file and setting custom class names for the container, sub-container, and active page.

import ReactPaginate from 'react-paginate';
import './pagination.css';

function CustomStyledPagination() {
  const handlePageClick = (data) => {
    console.log(data.selected);
  };

  return (
    <ReactPaginate
      previousLabel={'previous'}
      nextLabel={'next'}
      breakLabel={'...'}
      breakClassName={'break-me'}
      pageCount={10}
      marginPagesDisplayed={2}
      pageRangeDisplayed={5}
      onPageChange={handlePageClick}
      containerClassName={'custom-pagination'}
      subContainerClassName={'pages custom-pagination'}
      activeClassName={'active'}
    />
  );
}

Controlled Pagination

This example demonstrates a controlled pagination component where the current page state is managed using React's useState hook. The forcePage prop is used to control the current page programmatically.

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

function ControlledPagination() {
  const [currentPage, setCurrentPage] = useState(0);

  const handlePageClick = (data) => {
    setCurrentPage(data.selected);
  };

  return (
    <div>
      <ReactPaginate
        previousLabel={'previous'}
        nextLabel={'next'}
        breakLabel={'...'}
        breakClassName={'break-me'}
        pageCount={10}
        marginPagesDisplayed={2}
        pageRangeDisplayed={5}
        onPageChange={handlePageClick}
        containerClassName={'pagination'}
        subContainerClassName={'pages pagination'}
        activeClassName={'active'}
        forcePage={currentPage}
      />
      <p>Current Page: {currentPage + 1}</p>
    </div>
  );
}

Other packages similar to react-paginate

Changelog

Source

= 6.4.0

  • Two properties have been added to extend accessibility support (see https://github.com/AdeleD/react-paginate/pull/164).
    • nextAriaLabel: defines the aria-label html property for the 'Next page' button (default: 'Next page').
    • previousAriaLabel: defines the aria-label html property for the 'Previous page' button (default: 'Previous page').
  • Upgrade devDependencies packages (see: https://github.com/AdeleD/react-paginate/pull/314).

Readme

Source

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:

Pagination demo 2

or

Pagination demo 1

Installation

Install react-paginate with npm:

$ npm install react-paginate --save

For CommonJS users:

import ReactPaginate from 'react-paginate';

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

Demo

Clone the repository and move into:

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

Install dependencies:

$ make install

Prepare the demo:

$ make demo

Run the server:

$ make serve

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

Pagination demo

Props

NameTypeDescription
pageCountNumberRequired. The total number of pages.
pageRangeDisplayedNumberRequired. The range of pages displayed.
marginPagesDisplayedNumberRequired. The number of pages to display for margins.
previousLabelNodeLabel for the previous button.
nextLabelNodeLabel for the next button.
breakLabelNodeLabel for ellipsis.
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 clicked. Exposes the current page object as an argument.
initialPageNumberThe initial page selected.
forcePageNumberTo override selected page with parent prop.
disableInitialCallbackbooleanDisable onPageChange callback with initial page. Default: false
containerClassNameStringThe classname of the pagination container.
pageClassNameStringThe classname on tag li of each page element.
pageLinkClassNameStringThe classname on tag a of each page element.
activeClassNameStringThe classname for the active page.
activeLinkClassNameStringThe classname on the active tag a.
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.
hrefBuilderFunctionThe method is called to generate the href attribute value on tag a of each page element.
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

Contribute

  1. Submit an issue
  2. Fork the repository
  3. Create a dedicated branch (never ever work in master)
  4. The first time, run command: webpack into the directory
  5. Run npm start
  6. Fix bugs or implement features
  7. Always write tests

Run tests:

$ make test

Keywords

FAQs

Last updated on 06 Sep 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc