Module: Pagy::Frontend

Includes:
BootstrapExtra, BulmaExtra, CalendarExtra::UrlHelperAddOn, FoundationExtra, Pagy::FrontendHelpers::FrontendAddOn, I18nExtra::FrontendOverride, ItemsExtra::FrontendAddOn, MaterializeExtra, NavsExtra, SemanticExtra, SupportExtra, TrimExtra, UikitExtra, UrlHelpers
Defined in:
lib/pagy/frontend.rb

Overview

Frontend modules are specially optimized for performance. The resulting code may not look very elegant, but produces the best benchmarks

Constant Summary

Constants included from ItemsExtra::FrontendAddOn

ItemsExtra::FrontendAddOn::ITEMS_PLACEHOLDER

Instance Method Summary collapse

Methods included from UikitExtra

#pagy_uikit_combo_nav_js, #pagy_uikit_nav, #pagy_uikit_nav_js

Methods included from UrlHelpers

#pagy_set_query_params, #pagy_url_for

Methods included from JsonApiExtra::UrlHelperOverride

#pagy_set_query_params

Methods included from StandaloneExtra

#pagy_url_for

Methods included from NavsExtra

#pagy_combo_nav_js, #pagy_nav_js

Methods included from TrimExtra

#pagy_trim

Methods included from BulmaExtra

#pagy_bulma_combo_nav_js, #pagy_bulma_nav, #pagy_bulma_nav_js

Methods included from ItemsExtra::FrontendAddOn

#pagy_items_selector_js

Methods included from SupportExtra

#pagy_next_html, #pagy_next_link_tag, #pagy_next_url, #pagy_prev_html, #pagy_prev_link_tag, #pagy_prev_url

Methods included from CalendarExtra::UrlHelperAddOn

#pagy_calendar_url_at

Methods included from SemanticExtra

#pagy_semantic_combo_nav_js, #pagy_semantic_nav, #pagy_semantic_nav_js

Methods included from BootstrapExtra

#pagy_bootstrap_combo_nav_js, #pagy_bootstrap_nav, #pagy_bootstrap_nav_js

Methods included from FoundationExtra

#pagy_foundation_combo_nav_js, #pagy_foundation_nav, #pagy_foundation_nav_js

Methods included from MaterializeExtra

#pagy_materialize_combo_nav_js, #pagy_materialize_nav, #pagy_materialize_nav_js

Methods included from Pagy::FrontendHelpers::FrontendAddOn

#pagy_data

Instance Method Details

#pagy_info(pagy, pagy_id: nil, item_name: nil, item_i18n_key: nil) ⇒ Object

Return examples: “Displaying items 41-60 of 324 in total” or “Displaying Products 41-60 of 324 in total”



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/pagy/frontend.rb', line 42

def pagy_info(pagy, pagy_id: nil, item_name: nil, item_i18n_key: nil)
  p_id    = %( id="#{pagy_id}") if pagy_id
  p_count = pagy.count
  key     = if    p_count.zero?   then 'pagy.info.no_items'
            elsif pagy.pages == 1 then 'pagy.info.single_page'
            else                       'pagy.info.multiple_pages' # rubocop:disable Lint/ElseLayout
            end

  %(<span#{p_id} class="pagy-info">#{
      pagy_t key, item_name: item_name || pagy_t(item_i18n_key || pagy.vars[:item_i18n_key], count: p_count),
                  count: p_count, from: pagy.from, to: pagy.to
    }</span>)
end

#pagy_link_proc(pagy, link_extra: '') ⇒ Object

Return a performance optimized lambda to generate the HTML links Benchmarked on a 20 link nav: it is ~22x faster and uses ~18x less memory than rails’ link_to



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/pagy/frontend.rb', line 58

def pagy_link_proc(pagy, link_extra: '')
  p_prev      = pagy.prev
  p_next      = pagy.next
  p_page      = pagy.page.to_s
  left, right = %(<a href="#{pagy_url_for(pagy, PAGE_TOKEN)}" #{
                    pagy.vars[:link_extra]} #{link_extra}).split(PAGE_TOKEN, 2)
  # lambda used by all the helpers
  lambda do |page, text = pagy.label_for(page), extra_attrs = ''|
    %(#{left}#{page}#{right}#{ case page
                               when p_prev then ' rel="prev"'
                               when p_next then ' rel="next"'
                               when p_page then ' aria-disabled="true" aria-current="page"'
                               else             ''
                               end } #{extra_attrs}>#{text}</a>)
  end
end

#pagy_nav(pagy, pagy_id: nil, link_extra: '', nav_aria_label: nil, nav_i18n_key: nil, **vars) ⇒ Object

Generic pagination: it returns the html with the series of links to the pages



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/pagy/frontend.rb', line 18

def pagy_nav(pagy, pagy_id: nil, link_extra: '',
             nav_aria_label: nil, nav_i18n_key: nil, **vars)
  p_id = %( id="#{pagy_id}") if pagy_id
  link = pagy_link_proc(pagy, link_extra:)

  html = +%(<nav#{p_id} class="pagy pagy-nav pagination" #{nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)}>)
  html << prev_html(pagy, link)
  pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
    html << case item
            when Integer
              %(<span class="page">#{link.call(item)}</span>)
            when String
              %(<span class="page active">) +
              %(<a role="link" aria-disabled="true" aria-current="page">#{pagy.label_for(item)}</a></span>)
            when :gap
              %(<span class="page gap">#{pagy_t('pagy.gap')}</span>)
            else
              raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
            end
  end
  html << %(#{next_html(pagy, link)}</nav>)
end

#pagy_t(key, opts = {}) ⇒ Object

Similar to I18n.t: just ~18x faster using ~10x less memory (@pagy_locale explicitly initialized in order to avoid warning)



77
78
79
 
# File 'lib/pagy/frontend.rb', line 77

def pagy_t(key, opts = {})
  Pagy::I18n.translate(@pagy_locale ||= nil, key, opts)
end