pag
pagix
npm i pagix
pag

pagix

A generic pagination algorithm

by Bruno Bertolini

1.1.0 (see all)License:MITTypeScript:Built-In
npm i pagix
Readme

Pagix

A generic, framework agnostic, pagination calculator

Highlights

  • 🔌 Framework agnostic
  • 🏆 Dependency free
  • 🔥 Higly flexible

Demo

Install

yarn add pagix

Basic Usage

import { pagix } from 'pagix'

const paginate = pagix({ records: 100 })

The pagix function returns an object with some calculated props:

  • total: total number of pages
  • current: current page number, constrained between 1 and total
  • start: an array of page numbers, the first fixed page numbers
  • middle: an array of page numbers, calculated from current page
  • end: an array of page numbers, the last fixed page numbers
  • prev: the previous page number between start and middle, false if there is no truncated pages between start and middle
  • next: the next page number between middle and end, false if there is no truncated pages between middle and end
  • from: initial record in current page
  • to: last record in current page

pagination explain

API

pagix({ records [, limit, current, delta, fixed ] }): Main method to calculate pagination

PropRequiredDefaultDescription
recordstrue-total of records to paginate
limitfalse10total of records to show per page
currenttrue1current page
deltatrue1total of pages to show in each side of current page
fixedtrue1total of pages to show before prev button and after next button

🤝 Contributing

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

Show your support

Give a ⭐️ if this project helped you!

Downloads/wk

41

GitHub Stars

42

LAST COMMIT

1yr ago

MAINTAINERS

1

CONTRIBUTORS

3

OPEN ISSUES

0

OPEN PRs

5
VersionTagPublished
1.1.0
latest
1yr ago
No alternatives found
No tutorials found
Add a tutorial