react-pagination-hook

Welcome to react-pagination-hook 👋

A React hook that helps you render a paginator (with TypeScript support)

🏠 See a demo

Prerequisites

• react >=16.8.0

Install

npm install react-pagination-hook --save

API

The hook returns the following object:

{
  activePage: number;
  isFirst: boolean;
  isLast: boolean;
  hasPrevious: boolean;
  hasNext: boolean;
  visiblePieces: PaginatorPiece[];
  goToPage: (pageNumber: number) => void;
}

And a PaginatorPiece is either of the following objects:

{ type: 'previous', pageNumber: number, isDisabled: boolean }
// or
{ type: 'next', pageNumber: number, isDisabled: boolean }
// or
{ type: 'page-number', pageNumber: number }
// or
{ type: 'ellipsis' }

Usage

You can use this hook to develop your own pagination component. Check out the demo

Author

👤 Eliseu dos Santos <[e-mail]>

• Twitter: @eliseumds
• Github: @eliseumds

🤝 Contributing

Contributions, issues and feature requests are welcome !
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 Eliseu dos Santos <[e-mail]>.
This project is MIT licensed.

---

This project was bootstraped with typescript-library-starter

This README was generated with ❤️ by readme-md-generator