Admin Toolbox

Reusable admin components for the Neoteric Design CMS.

Gear up your ActiveAdmin resources with these commonly needed tools.

Installation

Neoteric CMS gems are served from a private host. Replace SECURE_GEMHOST with the source address.

# Gemfile
source SECURE_GEMHOST do
  gem 'admin_toolbox', '~> 0.5.0'
end

$ bundle install

Usage

Call the admin_toolbox method and pass in which tools you'd like for that resource.

# app/admin/my_model.rb
ActiveAdmin.register MyModel do
  admin_toolbox :previewable, :action_bar, :friendly_findable, :sortable
end

The Toolbox

ActionBar

Provides a floating container for your form's actions

Usage

// active_admin.scss

@import "admin_toolbox/action_bar";

# app/admin/my_model.rb

admin_toolbox :action_bar

form do |f|
  # ...
  f.action_bar
end

With no actions specified, you get a standard cancel and save actions.

f.action_bar
# is equivalent to
f.action_bar :cancel, :save

# Specify the actions you want from the readymade selection
f.action_bar :cancel, :preview, :draft, :publish


# Add your own actions

f.action_bar :cancel, :preview,
             -> { attribute_submit(field: 'state', new_value: 'in_review', label: "Mark for Review") }

# ActionBar adds the `attribute_submit` method to Rails' FormBuilder, to make # setting an attribute with different buttons (like we want for publish/draft)
# easy. Labels can be set through I18n. See config/locales/en.yml for details

Ready made actions

FriendlyFindable

Configures a resource to use FriendlyId's finder method.

Usage

# app/admin/my_model.rb

admin_toolbox :friendly_findable

Previewable

Allows resources to be previewed as if they were on the live site, even before saving.

Usage

# app/admin/my_model.rb

admin_toolbox :previewable

Override the preview_options method with a hash of your desired settings.

All other options are passed to the controller's render method.

Sortable

Adds editorial sort to your index table. Defaults to a position column named position but can be customized by overriding the position_field method in the controller. When constructing your index table, call sort_column where you'd like to insert the UI handle for sorting.

Usage

Relies on the jQuery sortable table plugin for the dragon drop, it's included with AdminToolbox

# active_admin.coffee

#= require admin_toolbox/sortable_table

$ ->
  $('table#index_table_plural_model_name').sortable_table()

# app/admin/my_model.rb

admin_toolbox :sortable

index do
  # ...
  sort_column
  # ...
end