Readme and license

Author: alexlanz

license.md

@@ -0,0 +1,7 @@
+Copyright About Bits GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

readme.md

@@ -1,3 +1,92 @@
 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 [info@aboutbits.it](mailto:info@aboutbits.it).
+
+### 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.

src/__test__/pagination.test.ts

@@ -18,11 +18,11 @@ it('should return only a few pages', () => {
   expect(pagination?.pages).toHaveLength(3)
 
   expect(pagination?.pages[0].number).toBe(1)
-  expect(pagination?.pages[0].isCurrentPage).toBeFalsy()
+  expect(pagination?.pages[0].isCurrent).toBeFalsy()
   expect(pagination?.pages[1].number).toBe(2)
-  expect(pagination?.pages[1].isCurrentPage).toBeTruthy()
+  expect(pagination?.pages[1].isCurrent).toBeTruthy()
   expect(pagination?.pages[2].number).toBe(3)
-  expect(pagination?.pages[2].isCurrentPage).toBeFalsy()
+  expect(pagination?.pages[2].isCurrent).toBeFalsy()
 })
 it('should return the maximum number of pages', () => {
   const page = 5
@@ -35,15 +35,15 @@ it('should return the maximum number of pages', () => {
   expect(pagination?.pages).toHaveLength(5)
 
   expect(pagination?.pages[0].number).toBe(3)
-  expect(pagination?.pages[0].isCurrentPage).toBeFalsy()
+  expect(pagination?.pages[0].isCurrent).toBeFalsy()
   expect(pagination?.pages[1].number).toBe(4)
-  expect(pagination?.pages[1].isCurrentPage).toBeFalsy()
+  expect(pagination?.pages[1].isCurrent).toBeFalsy()
   expect(pagination?.pages[2].number).toBe(5)
-  expect(pagination?.pages[2].isCurrentPage).toBeTruthy()
+  expect(pagination?.pages[2].isCurrent).toBeTruthy()
   expect(pagination?.pages[3].number).toBe(6)
-  expect(pagination?.pages[3].isCurrentPage).toBeFalsy()
+  expect(pagination?.pages[3].isCurrent).toBeFalsy()
   expect(pagination?.pages[4].number).toBe(7)
-  expect(pagination?.pages[4].isCurrentPage).toBeFalsy()
+  expect(pagination?.pages[4].isCurrent).toBeFalsy()
 })
 it('should disable the previous link', () => {
   const page = 1
@@ -59,8 +59,8 @@ it('should disable the previous link', () => {
   expect(pagination?.next.number).toBe(2)
   expect(pagination?.next.isDisabled).toBeFalsy()
 
-  expect(pagination?.pages[0].isCurrentPage).toBeTruthy()
-  expect(pagination?.pages[1].isCurrentPage).toBeFalsy()
+  expect(pagination?.pages[0].isCurrent).toBeTruthy()
+  expect(pagination?.pages[1].isCurrent).toBeFalsy()
 })
 it('should disable the next link', () => {
   const page = 2
@@ -76,6 +76,6 @@ it('should disable the next link', () => {
   expect(pagination?.next.number).toBe(2)
   expect(pagination?.next.isDisabled).toBeTruthy()
 
-  expect(pagination?.pages[0].isCurrentPage).toBeFalsy()
-  expect(pagination?.pages[1].isCurrentPage).toBeTruthy()
+  expect(pagination?.pages[0].isCurrent).toBeFalsy()
+  expect(pagination?.pages[1].isCurrent).toBeTruthy()
 })

src/index.ts

@@ -56,7 +56,7 @@ const calculatePagination = (
   }
   pages: {
     number: number
-    isCurrentPage: boolean
+    isCurrent: boolean
   }[]
 } | null => {
   if (total <= size) {
@@ -80,7 +80,7 @@ const calculatePagination = (
       (visiblePage) => {
         return {
           number: visiblePage,
-          isCurrentPage: visiblePage === page,
+          isCurrent: visiblePage === page,
         }
       }
     ),