1.0.5 • Published 5 years ago

jt-react-pagination v1.0.5

Weekly downloads
1
License
ISC
Repository
github
Last release
5 years ago

Super Simple React Pagination

Painfully simply pagination with React Simple react pagination that anyone can reuse on multiple projects :)

build dev dependcies npm version

View Demo

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Literally nothing is required. This component has no dependencies. Its bare bones for a reason. Behold:

<Pagination>
  {items}
</Pagination>

Installing

Install this component locally in your react project

npm i jt-react-pagination --save

Import in your app

import Pagination from 'jt-react-pagination';

Use in your render

<Pagination
  prevText='<'
  nextText='>'
  pageNeighbours={2}>
  {Array.from(Array(754).keys()).map((item, idx) => (
    <p key={idx}>{ item }</p>
  ))}
</Pagination>

Props

Prop NameDescProp TypeDefault
classNameCustom class to apply for stylingstring''
itemPerPageHow many items should be displayed per pagenumber10
pageNeighboursHow many siblings should the selected (center) page have? [1 < 4 5 6 7 8 > 103] // 2 Neighbours [1 < 5 6 7 > 103] // 1 Neighbours [1 < 3 4 5 6 7 8 9 > 103] // 3 Neighboursnumber1
prevTextThe prev button textstring, node'Prev'
nextTextThe next button textstring, node'Next'
paginationBeforeRenders the pagination above the children as well for long pagesboolfalse
childrenRequired The children element to render in pages[function, node[]]
onPageUpdateEvent when the page changes, arg = page #function

Running the tests

Coming soon

Contributing

All issues, pull requests, suggestions and comments are welcome.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose code was used, I believe someone from stack overflow for the pagination algo. Thanks sir.