Class: ActiveAdmin::Page

Inherits:
Object
  • Object
show all
Includes:
Base, Resource::ActionItems, Resource::Controllers, Resource::Menu, Resource::Naming, Resource::PagePresenters, Resource::Sidebars
Defined in:
lib/active_admin/page.rb

Overview

Page is the primary data storage for page configuration in Active Admin

When you register a page (ActiveAdmin.page “Status”) you are actually creating a new Page instance within the given Namespace.

The instance of the current page is available in PageController and views by calling the #active_admin_config method.

Defined Under Namespace

Modules: Base

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Resource::Naming

#camelized_resource_name, #plural_camelized_resource_name, #plural_underscored_resource_name, #resource_key, #underscored_resource_name

Methods included from Resource::Menu

#include_in_menu?, #menu, #menu_item_display_if, #menu_item_name, #menu_item_priority, #menu_options, #parent_menu_item_name

Methods included from Resource::ActionItems

#action_items, #action_items?, #action_items_for, #add_action_item, #clear_action_items!, #initialize

Methods included from Resource::Sidebars

#clear_sidebar_sections!, #initialize, #sidebar_sections, #sidebar_sections?, #sidebar_sections_for

Methods included from Resource::PagePresenters

#get_page_presenter, #page_presenters, #set_page_presenter

Methods included from Resource::Controllers

#controller, #controller_name, #route_collection_path, #route_prefix

Methods included from Base

#initialize

Instance Attribute Details

#name ⇒ Object (readonly)

The name of the page



16
17
18
 
# File 'lib/active_admin/page.rb', line 16

def name
  @name
end

#namespace ⇒ Object (readonly)

The namespace this config belongs to



13
14
15
 
# File 'lib/active_admin/page.rb', line 13

def namespace
  @namespace
end

#page_actions ⇒ Object (readonly)

An array of custom actions defined for this page



19
20
21
 
# File 'lib/active_admin/page.rb', line 19

def page_actions
  @page_actions
end

Instance Method Details

#add_default_action_items ⇒ Object 



62
63
 
# File 'lib/active_admin/page.rb', line 62

def add_default_action_items
end

#add_default_sidebar_sections ⇒ Object 



65
66
 
# File 'lib/active_admin/page.rb', line 65

def add_default_sidebar_sections
end

#belongs_to? ⇒ Boolean 



58
59
60
 
# File 'lib/active_admin/page.rb', line 58

def belongs_to?
  false
end

#clear_page_actions! ⇒ Object

Clears all the custom actions this page knows about



69
70
71
 
# File 'lib/active_admin/page.rb', line 69

def clear_page_actions!
  @page_actions = []
end

#plural_resource_name ⇒ Object

Force plural to be singular



49
50
51
 
# File 'lib/active_admin/page.rb', line 49

def plural_resource_name
  name
end

#plural_safe_resource_name ⇒ Object

Force plural to be singular



54
55
56
 
# File 'lib/active_admin/page.rb', line 54

def plural_safe_resource_name
  name
end

#resource_name ⇒ Object

plural_resource_name is singular



39
40
41
 
# File 'lib/active_admin/page.rb', line 39

def resource_name
  name
end

#safe_resource_name ⇒ Object 



43
44
45
 
# File 'lib/active_admin/page.rb', line 43

def safe_resource_name
  name
end