Class: ActiveAdmin::Views::TableFor::Column

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args, &block) ⇒ Column

Returns a new instance of Column.



127
128
129
130
131
132
133
134
135
 
# File 'lib/active_admin/views/components/table_for.rb', line 127

def initialize(*args, &block)
  @options = args.extract_options!

  @title = args[0]
  @html_class = @options.delete(:class) || @title.to_s.downcase.underscore.gsub(/ +/,'_')
  @data  = args[1] || args[0]
  @data = block if block
  @resource_class = args[2]
end

Instance Attribute Details

#data ⇒ Object

Returns the value of attribute data.



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

def data
  @data
end

#html_class ⇒ Object

Returns the value of attribute html_class.



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

def html_class
  @html_class
end

#title ⇒ Object

Returns the value of attribute title.



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

def title
  @title
end

Instance Method Details

#pretty_title ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/active_admin/views/components/table_for.rb', line 176

def pretty_title
  if @title.is_a?(Symbol)
    default_title =  @title.to_s.titleize
    if @options[:i18n] && @options[:i18n].respond_to?(:human_attribute_name)
      @title = @options[:i18n].human_attribute_name(@title, :default => default_title)
    else
      default_title
    end
  else
    @title
  end
end

#sort_key ⇒ Object

Returns the key to be used for sorting this column

Defaults to the column’s method if its a symbol

column :username
# => Sort key will be set to 'username'

You can set the sort key by passing a string or symbol to the sortable option:

column :username, :sortable => 'other_column_to_sort_on'

If you pass a block to be rendered for this column, the column will not be sortable unless you pass a string to sortable to sort the column on:

column('Username', :sortable => 'login'){ @user.pretty_name }
# => Sort key will be 'login'



167
168
169
170
171
172
173
174
 
# File 'lib/active_admin/views/components/table_for.rb', line 167

def sort_key
  # If boolean or nil, use the default sort key.
  if @options[:sortable] == true || @options[:sortable] == false || @options[:sortable].nil?
    @data.to_s
  else
    @options[:sortable].to_s
  end
end

#sortable? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/active_admin/views/components/table_for.rb', line 137

def sortable?
  if @data.is_a?(Proc)
    [String, Symbol].include?(@options[:sortable].class)
  elsif @options.has_key?(:sortable)
    @options[:sortable]
  elsif @data.respond_to?(:to_sym) && @resource_class
    !@resource_class.reflect_on_association(@data.to_sym)
  else
    true
  end
end