Module: ActiveAdmin

Defined in:
lib/active_admin.rb,
lib/active_admin/dsl.rb,
lib/active_admin/menu.rb,
lib/active_admin/page.rb,
lib/active_admin/event.rb,
lib/active_admin/scope.rb,
lib/active_admin/views.rb,
lib/active_admin/devise.rb,
lib/active_admin/engine.rb,
lib/active_admin/iconic.rb,
lib/active_admin/inputs.rb,
lib/active_admin/router.rb,
lib/active_admin/version.rb,
lib/active_admin/page_dsl.rb,
lib/active_admin/reloader.rb,
lib/active_admin/resource.rb,
lib/active_admin/callbacks.rb,
lib/active_admin/component.rb,
lib/active_admin/menu_item.rb,
lib/active_admin/namespace.rb,
lib/active_admin/dashboards.rb,
lib/active_admin/application.rb,
lib/active_admin/csv_builder.rb,
lib/active_admin/deprecation.rb,
lib/active_admin/filters/dsl.rb,
lib/active_admin/form_builder.rb,
lib/active_admin/iconic/icons.rb,
lib/active_admin/menu_builder.rb,
lib/active_admin/resource_dsl.rb,
lib/active_admin/sass/helpers.rb,
lib/active_admin/view_factory.rb,
lib/active_admin/view_helpers.rb,
lib/active_admin/views/footer.rb,
lib/active_admin/views/header.rb,
lib/active_admin/filters/forms.rb,
lib/active_admin/resource/menu.rb,
lib/active_admin/page_presenter.rb,
lib/active_admin/base_controller.rb,
lib/active_admin/page_controller.rb,
lib/active_admin/resource/naming.rb,
lib/active_admin/resource/scopes.rb,
lib/active_admin/sidebar_section.rb,
lib/active_admin/views/title_bar.rb,
lib/active_admin/comments/comment.rb,
lib/active_admin/helpers/settings.rb,
lib/active_admin/views/pages/base.rb,
lib/active_admin/views/pages/form.rb,
lib/active_admin/views/pages/page.rb,
lib/active_admin/views/pages/show.rb,
lib/active_admin/controller_action.rb,
lib/active_admin/resource/sidebars.rb,
lib/active_admin/views/pages/index.rb,
lib/active_admin/views/utility_nav.rb,
lib/active_admin/asset_registration.rb,
lib/active_admin/dashboards/section.rb,
lib/active_admin/dependency_checker.rb,
lib/active_admin/helpers/collection.rb,
lib/active_admin/inputs/filter_base.rb,
lib/active_admin/views/action_items.rb,
lib/active_admin/views/pages/layout.rb,
lib/active_admin/helpers/scope_chain.rb,
lib/active_admin/resource/belongs_to.rb,
lib/active_admin/resource/pagination.rb,
lib/active_admin/resource_collection.rb,
lib/active_admin/resource_controller.rb,
lib/active_admin/views/index_as_blog.rb,
lib/active_admin/views/index_as_grid.rb,
lib/active_admin/base_controller/menu.rb,
lib/active_admin/resource/controllers.rb,
lib/active_admin/views/index_as_block.rb,
lib/active_admin/views/index_as_table.rb,
lib/active_admin/abstract_view_factory.rb,
lib/active_admin/resource/action_items.rb,
lib/active_admin/views/pages/dashboard.rb,
lib/active_admin/views/components/panel.rb,
lib/active_admin/inputs/datepicker_input.rb,
lib/active_admin/view_helpers/fields_for.rb,
lib/active_admin/views/components/scopes.rb,
lib/active_admin/views/tabbed_navigation.rb,
lib/active_admin/batch_actions/controller.rb,
lib/active_admin/comments/resource_helper.rb,
lib/active_admin/helpers/optional_display.rb,
lib/active_admin/resource/page_presenters.rb,
lib/active_admin/view_helpers/form_helper.rb,
lib/active_admin/view_helpers/icon_helper.rb,
lib/active_admin/views/components/columns.rb,
lib/active_admin/views/components/popover.rb,
lib/active_admin/comments/namespace_helper.rb,
lib/active_admin/comments/show_page_helper.rb,
lib/active_admin/view_helpers/flash_helper.rb,
lib/active_admin/view_helpers/title_helper.rb,
lib/active_admin/filters/resource_extension.rb,
lib/active_admin/inputs/filter_select_input.rb,
lib/active_admin/inputs/filter_string_input.rb,
lib/active_admin/views/components/table_for.rb,
lib/active_admin/inputs/filter_boolean_input.rb,
lib/active_admin/inputs/filter_numeric_input.rb,
lib/active_admin/resource_controller/actions.rb,
lib/active_admin/resource_controller/scoping.rb,
lib/active_admin/view_helpers/display_helper.rb,
lib/active_admin/view_helpers/sidebar_helper.rb,
lib/active_admin/views/components/site_title.rb,
lib/active_admin/views/components/status_tag.rb,
lib/active_admin/resource_controller/sidebars.rb,
lib/active_admin/views/components/blank_slate.rb,
lib/active_admin/resource_controller/callbacks.rb,
lib/active_admin/view_helpers/auto_link_helper.rb,
lib/active_admin/inputs/filter_date_range_input.rb,
lib/active_admin/resource_controller/collection.rb,
lib/active_admin/resource_controller/decorators.rb,
lib/active_admin/view_helpers/breadcrumb_helper.rb,
lib/active_admin/views/components/dropdown_menu.rb,
lib/active_admin/dashboards/dashboard_controller.rb,
lib/active_admin/inputs/filter_check_boxes_input.rb,
lib/active_admin/batch_actions/resource_extension.rb,
lib/active_admin/view_helpers/view_factory_helper.rb,
lib/active_admin/views/components/sidebar_section.rb,
lib/active_admin/views/dashboard_section_renderer.rb,
lib/active_admin/views/components/attributes_table.rb,
lib/active_admin/resource_controller/action_builder.rb,
lib/generators/active_admin/assets/assets_generator.rb,
lib/generators/active_admin/devise/devise_generator.rb,
lib/active_admin/batch_actions/views/selection_cells.rb,
lib/active_admin/comments/views/active_admin_comments.rb,
lib/active_admin/views/components/action_list_popover.rb,
lib/generators/active_admin/install/install_generator.rb,
lib/active_admin/batch_actions/views/batch_action_form.rb,
lib/active_admin/views/components/paginated_collection.rb,
lib/generators/active_admin/resource/resource_generator.rb,
lib/active_admin/batch_actions/views/batch_action_popover.rb,
lib/active_admin/batch_actions/views/batch_action_selector.rb,
lib/active_admin/view_helpers/download_format_links_helper.rb,
lib/active_admin/resource_controller/resource_class_methods.rb,
lib/active_admin/view_helpers/active_admin_application_helper.rb

Defined Under Namespace

Modules: AssetRegistration, BatchActions, Callbacks, Comments, Dashboards, DependencyChecker, Deprecation, Devise, Filters, Generators, Helpers, Iconic, Inputs, OptionalDisplay, Reloader, Sass, ScopeChain, Settings, ViewHelpers, Views Classes: AbstractViewFactory, ActionItem, Application, BaseController, BatchAction, CSVBuilder, Comment, Component, ControllerAction, DSL, Engine, EventDispatcher, FormBuilder, Menu, MenuBuilder, MenuItem, Namespace, Page, PageController, PageDSL, PagePresenter, Railtie, Resource, ResourceCollection, ResourceController, ResourceDSL, ResourceMismatchError, Router, Scope, SidebarSection, Stylesheet, ViewFactory

Constant Summary collapse

Event =

ActiveAdmin::Event is set to a dispatcher

EventDispatcher.new
VERSION =
'0.5.1'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.applicationObject

Returns the value of attribute application.



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

def application
  @application
end

Class Method Details

.after_load(&block) ⇒ Object

A callback is triggered each time (after) Active Admin loads the configuration files. This is an opportunity to hook into Resources after they’ve been loaded.

The block takes the current instance of [ActiveAdmin::Application]

Example:

ActiveAdmin.after_load do |app|
  app.namespaces.each do |name, namespace|
    puts "Namespace: #{name} loaded!"
  end
end

Parameters:

  • block (Block)

    A block to call each time (after) AA loads resources



124
125
126
# File 'lib/active_admin.rb', line 124

def after_load(&block)
  ActiveAdmin::Event.subscribe ActiveAdmin::Application::AfterLoadEvent, &block
end

.before_load(&block) ⇒ Object

A callback is triggered each time (before) Active Admin loads the configuration files. In development mode, this will happen whenever the user changes files. In production it only happens on boot.

The block takes the current instance of [ActiveAdmin::Application]

Example:

ActiveAdmin.before_load do |app|
  # Do some stuff before AA loads
end

Parameters:

  • block (Block)

    A block to call each time (before) AA loads resources



106
107
108
# File 'lib/active_admin.rb', line 106

def before_load(&block)
  ActiveAdmin::Event.subscribe ActiveAdmin::Application::BeforeLoadEvent, &block
end

.setup {|application| ... } ⇒ Object

Gets called within the initializer

Yields:



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

def setup
  application.setup!
  yield(application)
  application.prepare!
end

.use_asset_pipeline?Boolean

Returns true if this rails application has the asset pipeline enabled.

Returns:

  • (Boolean)


83
84
85
# File 'lib/active_admin.rb', line 83

def use_asset_pipeline?
  DependencyChecker.rails_3_1? && Rails.application.config.try(:assets).try(:enabled)
end