Class: ActiveAdmin::Views::PaginatedCollection

Inherits:
Component
  • Object
show all
Defined in:
lib/active_admin/views/components/paginated_collection.rb

Overview

Wraps the content with pagination and available formats.

Example:

paginated_collection collection, :entry_name => "Post" do
  div do
    h2 "Inside the
  end
end

This will create a div with a sentence describing the number of posts in one of the following formats:

  • “No Posts found”

  • “Displaying all 10 Posts”

  • “Displaying Posts 1 - 30 of 31 in total”

It will also generate pagination links.

Instance Method Summary collapse

Methods inherited from Component

#default_class_name, #initialize, #tag_name

Constructor Details

This class inherits a constructor from ActiveAdmin::Component

Instance Method Details

#add_child(*args, &block) ⇒ Object

Override add_child to insert all children into the @contents div



43
44
45
46
47
48
49
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 43

def add_child(*args, &block)
  if @built
    @contents.add_child(*args, &block)
  else
    super
  end
end

#build(collection, options = {}) ⇒ Object

Builds a new paginated collection component

Parameters:

  • collection (Array) —

    A “paginated” collection from kaminari

  • options (Hash) (defaults to: {}) —

    These options will be passed on to the page_entries_info method. Useful keys:

    :entry_name - The name to display for this resource collection



34
35
36
37
38
39
40
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 34

def build(collection, options = {})
  @collection = collection
  div(page_entries_info(options).html_safe, :class => "pagination_information")
  @contents = div(:class => "paginated_collection_contents")
  build_pagination_with_formats
  @built = true
end

#build_download_format_links(formats = [:csv, :xml, :json]) ⇒ Object (protected)

TODO: Refactor to new HTML DSL



65
66
67
68
69
70
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 65

def build_download_format_links(formats = [:csv, :xml, :json])
  links = formats.collect do |format|
    link_to format.to_s.upcase, { :format => format}.merge(request.query_parameters.except(:commit, :format))
  end
  text_node [I18n.t('active_admin.download'), links].flatten.join(" ").html_safe
end

#build_pagination ⇒ Object (protected) 



60
61
62
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 60

def build_pagination
  text_node paginate(collection)
end

#build_pagination_with_formats ⇒ Object (protected) 



53
54
55
56
57
58
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 53

def build_pagination_with_formats
  div :id => "index_footer" do
    build_download_format_links
    build_pagination
  end
end

#page_entries_info(options = {}) ⇒ Object (protected)

modified from will_paginate



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 73

def page_entries_info(options = {})
  entry_name = options[:entry_name] ||
    (collection.empty?? 'entry' : collection.first.class.name.underscore.sub('_', ' '))

  if collection.num_pages < 2
    case collection.size
    when 0; I18n.t('active_admin.pagination.empty', :model => entry_name.pluralize)
    when 1; I18n.t('active_admin.pagination.one', :model => entry_name)
    else;   I18n.t('active_admin.pagination.one_page', :model => entry_name.pluralize, :n => collection.size)
    end
  else
    offset = collection.current_page * active_admin_application.default_per_page
    total  = collection.total_count
    I18n.t('active_admin.pagination.multiple', :model => entry_name.pluralize, :from => (offset - active_admin_application.default_per_page + 1), :to => offset > total ? total : offset, :total => total)
  end
end