{"id":24375974,"url":"https://github.com/betaweb/paginatedjs","last_synced_at":"2025-04-10T19:30:25.928Z","repository":{"id":33782993,"uuid":"161684301","full_name":"betaWeb/paginatedjs","owner":"betaWeb","description":"A simple JS class to paginate arrays","archived":false,"fork":false,"pushed_at":"2022-12-08T07:57:04.000Z","size":1272,"stargazers_count":3,"open_issues_count":14,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-02T15:01:57.879Z","etag":null,"topics":["array","arrays","browser","javascript","javascript-library","node","node-js","node-module","nodejs","paginable","paginated","pagination","simple"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/betaWeb.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-13T19:17:32.000Z","updated_at":"2023-06-08T12:34:20.000Z","dependencies_parsed_at":"2023-01-15T02:29:39.136Z","dependency_job_id":null,"html_url":"https://github.com/betaWeb/paginatedjs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betaWeb%2Fpaginatedjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betaWeb%2Fpaginatedjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betaWeb%2Fpaginatedjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betaWeb%2Fpaginatedjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/betaWeb","download_url":"https://codeload.github.com/betaWeb/paginatedjs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248281395,"owners_count":21077423,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["array","arrays","browser","javascript","javascript-library","node","node-js","node-module","nodejs","paginable","paginated","pagination","simple"],"created_at":"2025-01-19T05:58:56.802Z","updated_at":"2025-04-10T19:30:25.909Z","avatar_url":"https://github.com/betaWeb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PaginatedJS\n\n[![Build Status](https://travis-ci.org/betaWeb/paginatedjs.svg?branch=master)](https://travis-ci.org/betaWeb/paginatedjs)\n\nA simple JS class to paginate arrays.\n\n\u003cbr\u003e\u003cbr\u003e\n\n## Getting started\n\n### Installation\n\n#### Browser\nYou just have to download the minify js file `paginate-js.min.js`, and import it into your HTML :\n```html\n\u003cscript src=\"/path/to/paginate-js.min.js\"\u003e\u003c/script\u003e\n``` \n\n#### NodeJS\nInstall from NPM or Yarn\n```BASH\n$ npm i -S paginatedjs\n\n# OR\n\n$ yarn add paginatedjs\n```\n\nAnd import it into your NodeJS project\n```javascript\nconst Pagination = require(\"paginatedjs\").Pagination\n\n// OR\n\nimport { Pagination } from 'paginatedjs'\n```\n\nAnd... that's it ! :)\n\n### Usage\n\n```javascript\nlet list = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]\nlet perPage = 3\n\nlet page = []\nconst pagination = new Pagination(list, perPage)\n\n// gives you [1,2,3]\npagination.firstPage()\npage = pagination.getPaginated(true)\n\n// gives you [13]\npagination.lastPage()\npage = pagination.getPaginated(true)\n\n// gives you [10,11,12]\npagination.prevPage()\npage = pagination.getPaginated(true)\n\n// gives you [13]\npagination.nextPage() // next page does not exists\npage = pagination.getPaginated(true)\n\n// gives you [4,5,6]\npagination.goToPage(2)\npage = pagination.getPaginated(true)\n\n// gives you [13]\npagination.goToPage(20) // page 20 does not exists\npage = pagination.getPaginated(true)\n\n// gives you [7,8,9]\npagination.firstPage().nextPage().nextPage()\npage = pagination.getPaginated(true)\n\n// gives you [1,2,3]\npagination.reset()\npage = pagination.getPaginated(true)\n\n// gives you [[1,2,3], [4,5,6], [7,8,9], [10,11,12], [13]]\nlet chunked_list = pagination.chunkList()\n\n// gives you {1: [1,2,3], 2: [4,5,6], 3: [7,8,9], 4: [10,11,12], 5: [13]}\nlet chunked_list = pagination.chunkList(true)\n```\n\u003cbr\u003e\u003cbr\u003e\n\n---\n\n## API\n\n### Pagination class\n\n#### Properties\nNomenclature : `{Return type} Class.property`\n\n\u003cbr\u003e\n\nGet the current page number\n```javascript\n{Number} Pagination.pageNumber\n```\n\n\u003cbr\u003e\n\nGet the number of pages\n```javascript\n{Number} Pagination.nbPages\n```\n\n\u003cbr\u003e\n\nGet the list\n```javascript\n{Array} Pagination.list\n```\n\n\u003cbr\u003e\n\nGet the number of entries per page\n```javascript\n{Number} Pagination.perPage\n```\n\u003cbr\u003e\u003cbr\u003e\n\n#### Methods\nNomenclature : `{Return type} Class.method(\u003c(optional) arg | type\u003e, [\u003c(optional) arg | type\u003e])`\n\n\u003cbr\u003e\n\nGet list length\n```javascript\n{Number} Pagination.count()\n```\n\n\u003cbr\u003e\n\nGet last page chunk length\n```javascript\n{Number} Pagination.countLastPage()\n```\n\n\u003cbr\u003e\n\nReturns true if pagination not ended, false otherwise\n```javascript\n{Boolean} Pagination.hasMore()\n```\n\n\u003cbr\u003e\n\nSet pagination to the previous page\n```javascript\n{Pagination} Pagination.prevPage()\n```\n\n\u003cbr\u003e\n\nSet pagination to the next page\n```javascript\n{Pagination} Pagination.nextPage()\n```\n\n\u003cbr\u003e\n\nSet pagination to the first page\n```javascript\n{Pagination} Pagination.firstPage()\n```\n\n\u003cbr\u003e\n\nSet pagination to the last page\n```javascript\n{Pagination} Pagination.lastPage()\n```\n\n\u003cbr\u003e\n\nReturns chunked list compared to pagination position\nReturns Chunk class instance if to_array argument is false, array otherwise\n```javascript\n{Chunk|Array} Pagination.getPaginated(\u003c(optional) to_array | Boolean\u003e)\n```\n\n\u003cbr\u003e\n\nSet pagination to the page number passed as argument\n```javascript\n{Pagination} Pagination.goToPage(\u003cpage_number | Number\u003e)\n```\n\n\u003cbr\u003e\n\nReset pagination\n```javascript\n{Pagination} Pagination.reset()\n```\n\n\u003cbr\u003e\n\nReturns a chunked array or page indexed object of the list\n```javascript\n{Array|Object} Pagination.chunkList(\n    \u003c(optional) indexed_by_page | Boolean\u003e, \n    \u003c(optional) to_array | Boolean\u003e\n)\n```\n\n\u003cbr\u003e\u003cbr\u003e\n\n### Chunk class\n\n#### Methods\nNomenclature : `{Return type} Class.method(\u003carg | type\u003e, [\u003carg | type\u003e])`\n\n\u003cbr\u003e\n\nGet count length\n```javascript\n{Number} Chunk.count()\n```\n\n\u003cbr\u003e\n\n```javascript\n{Boolean} Chunk.empty()\n```\n\n\u003cbr\u003e\n\n```javascript\n{Boolean} Chunk.notEmpty()\n```\n\n\u003cbr\u003e\n\nGet the first element\n```javascript\n{Mixed} Chunk.first()\n```\n\n\u003cbr\u003e\n\nGet the last element\n```javascript\n{Mixed} Chunk.last()\n```\n\n\u003cbr\u003e\n\nGet nth element (begins to 1)\n```javascript\n{Mixed} Chunk.nth(\u003cn | Number\u003e)\n```\n\n\u003cbr\u003e\n\nReturns true if list contains value passed as argument, false otherwise\n```javascript\n{Boolean} Chunk.contains(\u003cvalue | mixed\u003e)\n```\n\n\u003cbr\u003e\n\nGet chunked list only with keys passed as arguments\n/!\\ Works only with array of objects\n```javascript\n{Chunk} Chunk.only(\u003cargs | Array\u003e)\n```\n\n\u003cbr\u003e\n\nReturns chunked list as an array\n```javascript\n{Array} Chunk.toArray()\n```\n\n\u003cbr\u003e\n\nPaginate the chunked list\n```javascript\n{Pagination} Chunk.paginate(\u003cperPage | Number\u003e)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbetaweb%2Fpaginatedjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbetaweb%2Fpaginatedjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbetaweb%2Fpaginatedjs/lists"}