Class: ActiveAdmin::SidebarSection

Inherits:
Object
  • Object
show all
Includes:
OptionalDisplay
Defined in:
lib/active_admin/sidebar_section.rb

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods included from OptionalDisplay

#display_on?

Constructor Details

- (SidebarSection) initialize(name, options = {}, &block)



8
9
10
11
# File 'lib/active_admin/sidebar_section.rb', line 8

def initialize(name, options = {}, &block)
  @name, @options, @block = name, options, block
  normalize_display_options!
end

Instance Attribute Details

- (Object) block

Returns the value of attribute block



6
7
8
# File 'lib/active_admin/sidebar_section.rb', line 6

def block
  @block
end

- (Object) name

Returns the value of attribute name



6
7
8
# File 'lib/active_admin/sidebar_section.rb', line 6

def name
  @name
end

- (Object) options

Returns the value of attribute options



6
7
8
# File 'lib/active_admin/sidebar_section.rb', line 6

def options
  @options
end

Instance Method Details

- (Object) custom_class



36
37
38
# File 'lib/active_admin/sidebar_section.rb', line 36

def custom_class
  options[:class]
end

- (Object) icon



22
23
24
# File 'lib/active_admin/sidebar_section.rb', line 22

def icon
  options[:icon] if icon?
end

- (Boolean) icon?



18
19
20
# File 'lib/active_admin/sidebar_section.rb', line 18

def icon?
  !!options[:icon]
end

- (Object) id

The id gets used for the div in the view



14
15
16
# File 'lib/active_admin/sidebar_section.rb', line 14

def id
  "#{name.to_s.downcase.underscore}_sidebar_section".parameterize
end

- (Object) partial_name

If a block is not passed in, the name of the partial to render



32
33
34
# File 'lib/active_admin/sidebar_section.rb', line 32

def partial_name
  options[:partial] || "#{name.to_s.downcase.gsub(' ', '_')}_sidebar"
end

- (Object) priority



40
41
42
# File 'lib/active_admin/sidebar_section.rb', line 40

def priority
  options[:priority] || 10
end

- (Object) title

The title gets displayed within the section in the view



27
28
29
# File 'lib/active_admin/sidebar_section.rb', line 27

def title
  I18n.t("active_admin.sidebars.#{name.to_s}", default: name.to_s.titlecase)
end