@aboutbits/pagination - npm Package Compare versions

Comparing version 0.1.5 to 0.1.7

dist/index.d.ts

@@ -12,5 +12,5 @@ declare const calculatePagination: (page: number, size: number, total: number, maxPages?: number) => {
         number: number;
-        isCurrentPage: boolean;
+        isCurrent: boolean;
     }[];
 } | null;
 export { calculatePagination };

dist/index.js

@@ -53,3 +53,3 @@ var calculateVisiblePages = function (page, total, maxPages) {
                 number: visiblePage,
-                isCurrentPage: visiblePage === page,
+                isCurrent: visiblePage === page,
             };
@@ -56,0 +56,0 @@ }),

package.json

 {
   "name": "@aboutbits/pagination",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Pagination",
@@ -5,0 +5,0 @@ "keywords": [],

readme.md

 Pagination
 ==========
 
+This project includes a pagination calculation, where you can simply pass some basic information to the calcualtion function, and in return you receive an object with all relevant pagination information.
+
+## Table of content
+
+- [Usage](#usage)
+- [Build & Publish](#build--publish)
+- [Information](#information)
+
+## Usage
+
+First, you have to install the package:
+
+```bash
+npm install @aboutbits/pagination
+```
+
+Second, you can call the calculate function by passing the following information:
+
+- `page`: The current page
+- `size`: The amount of items shown per page
+- `total`: The amount of total items in the list/collection
+- `maxPages`: The maximum amount of pages that should be shown (default: 5)
+
+In return, you receive an object with all relevant information:
+
+```js
+import { calculatePagination } from '@aboutbits/pagination'
+
+let pagination = calculatePagination(1, 5, 100)
+
+console.log(pagination)
+```
+
+This would return the following object:
+
+```json
+{
+  "previous": {
+    "number": 1,
+    "isDisabled": true
+  },
+  "next": {
+    "number": 2,
+    "isDisabled": false
+  },
+  "pages": [
+    {
+      "number": 1,
+      "isCurrent": true
+    },
+    {
+      "number": 2,
+      "isCurrent": false
+    },
+    {
+      "number": 3,
+      "isCurrent": false
+    },
+    {
+      "number": 4,
+      "isCurrent": false
+    },
+    {
+      "number": 5,
+      "isCurrent": false
+    }
+  ]
+}
+```
+
+## Build & Publish
+
+## Information
+
+About Bits is a company based in South Tyrol, Italy. You can find more information about us on [our website](https://aboutbits.it).
+
+### Support
+
+For support, please contact [[e-mail]](mailto:[e-mail]).
+
+### Credits
+
+- [Alex Lanz](https://github.com/alexlanz)
+- [Martin Malfertheiner](https://github.com/mmalfertheiner)
+- [All Contributors](../../contributors)
+
+### License
+
+The MIT License (MIT). Please see the [license file](license.md) for more information.

No alert changes

Improved metrics

Total package byte prevSize

6465

83.77%

Number of package files

5

25%

Number of lines in readme file

93

2225%

No dependency changes