Class: ActiveAdmin::Views::IndexAsTable

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

Overview

Index as a Table

By default, the index page is a table with each of the models content columns and links to show, edit and delete the object. There are many ways to customize what gets displayed.

Defining Columns

To display an attribute or a method on a resource, simply pass a symbol into the column method:

index do
  selectable_column
  column :title
end

If the default title does not work for you, pass it as the first argument:

index do
  selectable_column
  column "My Custom Title", :title
end

Sometimes calling methods just isn’t enough and you need to write some view specific code. For example, say we wanted a colum called Title which holds a link to the posts admin screen.

The column method accepts a block as an argument which will then be rendered within the context of the view for each of the objects in the collection.

index do
  selectable_column
  column "Title" do |post|
    link_to post.title, admin_post_path(post)
  end
end

The block gets called once for each resource in the collection. The resource gets passed into the block as an argument.

To setup links to View, Edit and Delete a resource, use the default_actions method:

index do
  selectable_column
  column :title
  default_actions
end

Alternatively, you can create a column with custom links:

index do
  selectable_column
  column :title
  column "Actions" do |post|
    link_to "View", admin_post_path(post)
  end
end

Sorting

When a column is generated from an Active Record attribute, the table is sortable by default. If you are creating a custom column, you may need to give Active Admin a hint for how to sort the table.

If a column is defined using a block, you must pass the key to turn on sorting. The key is the attribute which gets used to sort objects using Active Record.

By default, this is the column on the resource’s table that the attribute corresponds to. Otherwise, any attribute that the resource collection responds to can be used.

index do
  column "Title", :sortable => :title do |post|
    link_to post.title, admin_post_path(post)
  end
end

You can also sort using an attribute on another table by passing the table name and the attribute separated by a dot:

index do
  column :title, :sortable => 'categories.name'
end

You can turn off sorting on any column by passing false:

index do
  column :title, :sortable => false
end

Showing and Hiding Columns

The entire index block is rendered within the context of the view, so you can easily do things that show or hide columns based on the current context.

For example, if you were using CanCan:

index do
  column :title, :sortable => false
  if can? :manage, Post
    column :some_secret_data
  end
end

Defined Under Namespace

Classes: IndexTableFor

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.index_name ⇒ Object 



139
140
141
 
# File 'lib/active_admin/views/index_as_table.rb', line 139

def self.index_name
  "table"
end

Instance Method Details

#build(page_presenter, collection) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/active_admin/views/index_as_table.rb', line 110

def build(page_presenter, collection)
  table_options = {
    :id => "index_table_#{active_admin_config.resource_name.plural}",
    :sortable => true,
    :class => "index_table index",
    :i18n => active_admin_config.resource_class,
    :paginator => page_presenter[:paginator] != false
  }

  table_for collection, table_options do |t|
    table_config_block = page_presenter.block || default_table
    instance_exec(t, &table_config_block)
  end
end

#default_table ⇒ Object 



129
130
131
132
133
134
135
136
137
 
# File 'lib/active_admin/views/index_as_table.rb', line 129

def default_table
  proc do
    id_column
    resource_class.content_columns.each do |col|
      column col.name.to_sym
    end
    default_actions
  end
end

#table_for(*args, &block) ⇒ Object 



125
126
127
 
# File 'lib/active_admin/views/index_as_table.rb', line 125

def table_for(*args, &block)
  insert_tag IndexTableFor, *args, &block
end