43.7.0
Powered by

  series_nav

series_nav
series_nav
series_nav(:bootstrap)
series_nav(:bootstrap)
series_nav(:bulma)
series_nav(:bulma)

Check it out with bundle exec pagy demo

series_nav returns an HTML string containing pagination links, wrapped in a nav tag, ready to be used in your view.

<%== @pagy.series_nav(**options) %>  <%# default pagy style %>
<%== @pagy.series_nav(:bootstrap, **options) %>
<%== @pagy.series_nav(:bulma, **options) %>
Console
require 'pagy/console'
=> true

>> @pagy, @records = pagy(:offset, collection.new, page: 3)
=> [#<Pagy::Offset:0x00007f0802af1fe8 @request=#<Pagy::Request:0x00007f0802faae68 @options={page: 3, request: #<Pagy::Request:0x00007f0802faae68 ...>, client_limit: nil, limit: 20, count: 1000}, @base_url="http://www.example.com", @path="/path", @params={example: "123"}, @cookie=nil>, @options={limit: 20, limit_key: "limit", page_key: "page", page: 3, client_limit: nil, count: 1000}, @limit=20, @count=1000, @page=3, @last=50, @offset=40, @in_range=true, @from=41, @to=60, @in=20, @previous=2, @next=4>, [41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60]]

>> puts @pagy.series_nav
<nav class="pagy series-nav" aria-label="Pages"><a href="/path?example=123&amp;page=2" rel="prev" aria-label="Previous">&lt;</a><a href="/path?example=123&amp;page=1">1</a><a href="/path?example=123&amp;page=2" rel="prev">2</a><a role="link" aria-disabled="true" aria-current="page">3</a><a href="/path?example=123&amp;page=4" rel="next">4</a><a href="/path?example=123&amp;page=5">5</a><a role="separator" aria-disabled="true">&hellip;</a><a href="/path?example=123&amp;page=50">50</a><a href="/path?example=123&amp;page=4" rel="next" aria-label="Next">&gt;</a></nav>
=> nil

>> puts @pagy.series_nav(:bulma, id: 'my-nav', aria_label: 'Products', slots: 3)
<nav id="my-nav" class="pagy-bulma series-nav pagination" aria-label="Products"><ul class="pagination-list"><li><a href="/path?example=123&amp;page=2" class="pagination-previous" rel="prev" aria-label="Previous">&lt;</a></li><li><a href="/path?example=123&amp;page=2" class="pagination-link" rel="prev">2</a></li><li><a role="link" class="pagination-link is-current" aria-current="page" aria-disabled="true">3</a></li><li><a href="/path?example=123&amp;page=4" class="pagination-link" rel="next">4</a></li><li><a href="/path?example=123&amp;page=4" class="pagination-next" rel="next" aria-label="Next">&gt;</a></li></ul></nav>
=> nil
:pagy/nil
Pagy default style
:bootstrap
Set classes: 'pagination pagination-sm any-class' style option to override the default 'pagination' class.
:bulma
Set classes: 'pagination is-small any-class' style option to override the default 'pagination' classes.
slots: 9

Override the default number of page :slots used for the navigation bar.

  • slots < 7 fills the slots with contiguous pages around the current one.
  • slots >= 7 reserves the first and last slots for the first and last pages, separated from the rest by a ... (:gap) slot when needed.
  • Prefer odd numbers of slots, which place the current page in the central slot.
compact: true
Fill all the slots with contiguous pages, regardless of the number of slots.
id: 'my-nav'
Set the id HTML attribute of the nav tag.
aria_label: 'My Label'

Override the default pagy.aria_label.nav string of the aria-label attribute.
See ARIA.

anchor_string: 'data-turbo-frame="paginate"'
Concatenate a verbatim raw string to the internal HTML of the anchor tags. It must contain properly formatted HTML attributes. It's not suitable for *_hash helpers.
absolute: true
Makes the URL absolute.
path: '/my_path'
Overrides the request path in pagination URLs. Use the path only (not the absolute URL). (see Override the request path)
fragment: '...'
URL fragment string.
querify: tweak

Set it to a lambda to directly edit the passed string-keyed params hash itself. Its result is ignored.

tweak = ->(q) { q.except!('not_useful').merge!('custom' => 'useful') }