{"id":17656518,"url":"https://github.com/imdrasil/pager","last_synced_at":"2025-05-07T11:44:19.996Z","repository":{"id":58656582,"uuid":"162196971","full_name":"imdrasil/pager","owner":"imdrasil","description":"Easy to use paginator for modern crystal web framework","archived":false,"fork":false,"pushed_at":"2022-09-25T20:56:00.000Z","size":20,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-21T08:14:05.313Z","etag":null,"topics":["crystal","pagination","paginator"],"latest_commit_sha":null,"homepage":null,"language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imdrasil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-17T22:21:55.000Z","updated_at":"2024-11-29T02:09:33.000Z","dependencies_parsed_at":"2023-01-18T22:15:45.713Z","dependency_job_id":null,"html_url":"https://github.com/imdrasil/pager","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdrasil%2Fpager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdrasil%2Fpager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdrasil%2Fpager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imdrasil%2Fpager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imdrasil","download_url":"https://codeload.github.com/imdrasil/pager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252873917,"owners_count":21817708,"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":["crystal","pagination","paginator"],"created_at":"2024-10-23T14:33:20.342Z","updated_at":"2025-05-07T11:44:19.974Z","avatar_url":"https://github.com/imdrasil.png","language":"Crystal","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pager\n\nEasy to use paginator for modern crystal web framework.\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n```yaml\ndependencies:\n  pager:\n    github: imdrasil/pager\n```\n\n2. Run `shards install`\n\nAlso if you use default bootstrap presenter ensure that you've added appropriate css to your project from the CDN or directly in the code.\n\n## Usage\n\nPager provides two basic container: for `Array` and `Jennifer::QueryBuilder::ModelQuery`. Also it includes basic bootstrap presenter, which is the default presenter.\n\n```crystal\nrequire \"pager\"\nrequire \"pager/collections/array\" # for arrays\nrequire \"pager/collections/jennifer\" # for Jennifer collections\n```\n\nCollection objects responds to `#each` method which yield objects in the collection so you can easily iterate over them.\n\n### Array\n\n`Pager::ArrayCollection` extends `Array` with new `#paginate` method, which accepts current page and count of elements on each one.\n\n```crystal\n(1..21).to_a.paginate(1, 4) # [5, 6, 7, 8]\n```\n\n### Jennifer\n\n`Pager::JenniferCollection` extends `Jennifer::QueryBuilder::ModelQuery` with `#paginate` methods which accepts current page number and count of records in a page. This method is executable one so should be the last one in a chain.\n\n```crystal\nUser.all.where { _active }.paginate(1, 4)\n```\n\n### Configuration\n\n```crystal\nPager.configure do |config|\n  config.default_presenter = Pager::Bootstrap\n  config.visible_pages = 7\n  config.per_page = 20\nend\n```\n\nAvailable configurations:\n\n* `default_presenter` - presenter class to be used by `ViewHelper#paginate`\n* `visible_pages` - number of page links generated by `ViewHelper#paginate`\n* `per_page` - default number of pages for collection\n\n### View\n\nTo render navigation section include `Pager::ViewHelper` to appropriate context and call `#paginate` method passing collection, path to be used to generate links and number of visible pages.\n\n```erb\n\u003c%= paginate((1..100).collection(1, 5), \"/\", 3) %\u003e\n```\n\nWill generate next html:\n\n```html\n\u003cnav\u003e\n  \u003cul class='pagination'\u003e\n    \u003cli class=\"page-item \"\u003e\n      \u003ca class=\"page-link\" href=\"/?page=0\" aria-label=\"Previous\"\u003e\n        \u003cspan class=\"sr-only\"\u003ePrevious\u003c/span\u003e\n        \u003cspan aria-hidden=\"true\"\u003e\u0026lsaquo; Previous\u003c/span\u003e\n      \u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli class='page-item '\u003e\n      \u003ca class='page-link' href='/?page=0'\u003e1\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli class='page-item disabled'\u003e\n      \u003ca class='page-link' href='#'\u003e2\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli class='page-item '\u003e\n      \u003ca class='page-link' href='/?page=2'\u003e3\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli class=\"page-item \"\u003e\n      \u003ca class=\"page-link\" href=\"/?page=2\" aria-label=\"Next\"\u003e\n        \u003cspan class=\"sr-only\"\u003eNext\u003c/span\u003e\n        \u003cspan aria-hidden=\"true\"\u003eNext \u0026rsaquo;\u003c/span\u003e\n      \u003c/a\u003e\n    \u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/nav\u003e\n```\n\nAs you can see page is added as a GET parameter `page`. If query already has some GET parameter this will be recognized and `page` will be added to the end.\n\n### Translation\n\nThe default labels for the \"next\" and \"previous\" texts are stored in the i18n yaml. It can be easily override. Here is existing translation file:\n\n```yaml\npager:\n  previous_label: \"\u0026lsaquo; Previous\"\n  next_label: \"Next \u0026rsaquo;\"\n```\n\nFor the translation purpose `crimson-knight/i18n.cr` library is used.\n\n## Development\n\n### Presenter\n\nTBA. Take a look at existing [bootstrap](./src/pager/presenters/bootstrap.cr) presenter implementation.\n\n### Collection\n\nTBA. Take a look at existing [array](./src/pager/collections/array.cr) presenter implementation.\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/imdrasil/pager/fork\u003e)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## Contributors\n\n- [Roman Kalnytskyi](https://github.com/imdrasil) - creator and maintainer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimdrasil%2Fpager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimdrasil%2Fpager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimdrasil%2Fpager/lists"}