Module: Kaminari::ActionViewExtension
- Defined in:
- lib/kaminari/helpers/action_view_extension.rb
Overview
Helpers
Instance Method Summary collapse
-
#link_to_next_page(scope, name, options = {}, &block) ⇒ Object
A simple “Twitter like” pagination link that creates a link to the next page.
-
#link_to_previous_page(scope, name, options = {}, &block) ⇒ Object
A simple “Twitter like” pagination link that creates a link to the previous page.
-
#page_entries_info(collection, options = {}) ⇒ Object
Renders a helpful message with numbers of displayed vs.
-
#paginate(scope, options = {}, &block) ⇒ Object
A helper that renders the pagination links.
-
#rel_next_prev_link_tags(scope, options = {}) ⇒ Object
Renders rel=“next” and rel=“prev” links to be used in the head.
Instance Method Details
#link_to_next_page(scope, name, options = {}, &block) ⇒ Object
A simple “Twitter like” pagination link that creates a link to the next page.
Examples
Basic usage:
<%= link_to_next_page @items, 'Next Page' %>
Ajax:
<%= link_to_next_page @items, 'Next Page', :remote => true %>
By default, it renders nothing if there are no more results on the next page. You can customize this output by passing a block.
<%= link_to_next_page @users, 'Next Page' do %>
<span>No More Pages</span>
<% end %>
64 65 66 67 68 69 70 |
# File 'lib/kaminari/helpers/action_view_extension.rb', line 64 def link_to_next_page(scope, name, = {}, &block) params = .delete(:params) || {} param_name = .delete(:param_name) || Kaminari.config.param_name link_to_unless scope.last_page?, name, params.merge(param_name => (scope.current_page + 1)), .reverse_merge(:rel => 'next') do block.call if block end end |
#link_to_previous_page(scope, name, options = {}, &block) ⇒ Object
A simple “Twitter like” pagination link that creates a link to the previous page.
Examples
Basic usage:
<%= link_to_previous_page @items, 'Previous Page' %>
Ajax:
<%= link_to_previous_page @items, 'Previous Page', :remote => true %>
By default, it renders nothing if there are no more results on the previous page. You can customize this output by passing a block.
<%= link_to_previous_page @users, 'Previous Page' do %>
<span>At the Beginning</span>
<% end %>
39 40 41 42 43 44 45 |
# File 'lib/kaminari/helpers/action_view_extension.rb', line 39 def link_to_previous_page(scope, name, = {}, &block) params = .delete(:params) || {} param_name = .delete(:param_name) || Kaminari.config.param_name link_to_unless scope.first_page?, name, params.merge(param_name => (scope.current_page - 1)), .reverse_merge(:rel => 'previous') do block.call if block end end |
#page_entries_info(collection, options = {}) ⇒ Object
Renders a helpful message with numbers of displayed vs. total entries. Ported from mislav/will_paginate
Examples
Basic usage:
<%= page_entries_info @posts %>
#-> Displaying posts 6 - 10 of 26 in total
By default, the message will use the humanized class name of objects in collection: for instance, “project types” for ProjectType models. The namespace will be cutted out and only the last name will be used. Override this with the :entry_name
parameter:
<%= page_entries_info @posts, :entry_name => 'item' %>
#-> Displaying items 6 - 10 of 26 in total
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/kaminari/helpers/action_view_extension.rb', line 88 def page_entries_info(collection, = {}) entry_name = if [:entry_name] [:entry_name] elsif collection.is_a?(::Kaminari::PaginatableArray) 'entry' else if collection.respond_to? :model # DataMapper collection.model.model_name.human.downcase else # AR collection.model_name.human.downcase end end entry_name = entry_name.pluralize unless collection.total_count == 1 if collection.total_pages < 2 t('helpers.page_entries_info.one_page.display_entries', :entry_name => entry_name, :count => collection.total_count) else first = collection.offset_value + 1 last = collection.last_page? ? collection.total_count : collection.offset_value + collection.limit_value t('helpers.page_entries_info.more_pages.display_entries', :entry_name => entry_name, :first => first, :last => last, :total => collection.total_count) end.html_safe end |
#paginate(scope, options = {}, &block) ⇒ Object
A helper that renders the pagination links.
<%= paginate @articles %>
Options
-
:window
- The “inner window” size (4 by default). -
:outer_window
- The “outer window” size (0 by default). -
:left
- The “left outer window” size (0 by default). -
:right
- The “right outer window” size (0 by default). -
:params
- url_for parameters for the links (:controller, :action, etc.) -
:param_name
- parameter name for page number in the links (:page by default) -
:remote
- Ajax? (false by default) -
:ANY_OTHER_VALUES
- Any other hash key & values would be directly passed into each tag as :locals value.
17 18 19 20 |
# File 'lib/kaminari/helpers/action_view_extension.rb', line 17 def paginate(scope, = {}, &block) paginator = Kaminari::Helpers::Paginator.new self, .reverse_merge(:current_page => scope.current_page, :total_pages => scope.total_pages, :per_page => scope.limit_value, :param_name => Kaminari.config.param_name, :remote => false) paginator.to_s end |
#rel_next_prev_link_tags(scope, options = {}) ⇒ Object
Renders rel=“next” and rel=“prev” links to be used in the head.
Examples
Basic usage:
In head:
<head>
<title>My Website</title>
<%= yield :head %>
</head>
Somewhere in body:
<% content_for :head do %>
<%= rel_next_prev_link_tags @items %>
<% end %>
#-> <link rel="next" href="/items/page/3" /><link rel="prev" href="/items/page/1" />
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/kaminari/helpers/action_view_extension.rb', line 129 def (scope, = {}) params = .delete(:params) || {} param_name = .delete(:param_name) || Kaminari.config.param_name output = "" if !scope.first_page? && !scope.last_page? # If not first and not last, then output both links. output << '<link rel="next" href="' + url_for(params.merge(param_name => (scope.current_page + 1))) + '"/>' output << '<link rel="prev" href="' + url_for(params.merge(param_name => (scope.current_page - 1))) + '"/>' elsif scope.first_page? # If first page, add next link unless last page. output << '<link rel="next" href="' + url_for(params.merge(param_name => (scope.current_page + 1))) + '"/>' unless scope.last_page? else # If last page, add prev link unless first page. output << '<link rel="prev" href="' + url_for(params.merge(param_name => (scope.current_page - 1))) + '"/>' unless scope.first_page? end output.html_safe end |