JSPM

pagination-calculator2

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q14388F
  • License MIT

Utility for calculating pages for pagination

Package Exports

  • pagination-calculator2
  • pagination-calculator2/package.json

Readme

pagination-calculator

Build Status npm version license

Installation

npm install pagination-calculator

Note: the package includes typings for Typescript

Usage

import { paginationCalculator } from "pagination-calculator";

const options = {
    // see below
};

const result = paginationCalculator(options);

Options

interface PageCalculatorOptions {
    total: number;                // total number of items
    current?: number;             // current page - default 1
    pageSize?: number;            // number of items per page - default 10
    pageLimit?: number;           // number of pages in array - default no limit
}

Result

interface PageInformation {
    total: number;                // total number of items
    current: number;              // current page
    pageCount: number;            // total number of pages
    pages: (number | "...")[];    // array of page numbers
    next: number | false;         // next page or false if end
    previous: number | false;     // previous page or false if first
    showingStart: number;         // index of first item showing on current page
    showingEnd: number;           // index of last item showing on current page
}