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

#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