Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@activeadmin/activeadmin

activeadmin144kMIT3.3.0

The administration framework for Ruby on Rails.

administration, administrative, rails

readme

Active Admin

Active Admin is a Ruby on Rails framework for creating elegant backends for website administration.

Version Github Actions Coverage Tidelift Inch CI

Goals

  • Enable developers to quickly create good-looking administration interfaces.
  • Build a DSL for developers and an interface for businesses.
  • Ensure that developers can easily customize every nook and cranny.

Getting started

  • Check out the docs.
  • Try the live demo.
  • The wiki includes links to tutorials, articles and sample projects.

For enterprise

Active Admin for enterprise is available via the Tidelift subscription. Learn More.

Need help?

Please use StackOverflow for help requests and how-to questions.

Please open GitHub issues for bugs and enhancements only, not general help requests. Please search previous issues (and Google and StackOverflow) before creating a new issue.

Google Groups, IRC #activeadmin and Gitter are not actively monitored.

Want to contribute?

If you want to contribute through code or documentation, the Contributing guide is the best place to start. If you have questions, feel free to ask.

Want to support us?

If you want to support us financially, you can help fund the project through a Tidelift subscription. By buying a Tidelift subscription you make sure your whole dependency stack is properly maintained, while also getting a comprehensive view of outdated dependencies, new releases, security alerts, and licensing compatibility issues.

You can also support us with a weekly tip via Liberapay.

Finally, we have an Open Collective where you can become a backer or sponsor for the project, and also submit expenses to it.

Dependencies

We try not to reinvent the wheel, so Active Admin is built with other open source projects:

Tool Description
Arbre Ruby -> HTML, just like that.
Devise Powerful, extensible user authentication
Formtastic A Rails form builder plugin with semantically rich and accessible markup
Inherited Resources Simplifies controllers with pre-built RESTful controller actions
Kaminari Elegant pagination for any sort of collection
Ransack Provides a simple search API to query your data

Security contact information

Please use the Tidelift security contact to report a security vulnerability. Tidelift will coordinate the fix and disclosure.

Acknowledgements

Thanks to Greg Bell for creating and sharing this project with the open source community.

Thanks to all the people that ever contributed through code or other means such as bug reports, issue triaging, feature suggestions, code snippet tips, Slack discussions and so on.

Thanks to Tidelift and all our Tidelift subscribers.

Thanks to Open Collective and all our Open Collective contributors.

changelog

Changelog

Unreleased

3.3.0

Enhancements

Bug Fixes

  • Backport Fix attributes passed to form has_many not being set on new record form items #8551 by @Fs00
  • Backport Fix deprecation warning in Ruby 3.4 #8596 by @tagliala
  • Backport Fix circular require warning in belongs_to.rb #8601 by @tagliala

3.2.5

Enhancements

  • Backport Add favicon to template app to fix Rails 7.2 test suite run #8468 by @mgrunberg
  • Backport Use attribute_types instead of columns_hash to determine type #8469 by @mgrunberg
  • Backport Optimize count query for pagination_total: false option #8470 by @mgrunberg

Bug Fixes

3.2.4

Enhancements

Bug Fixes

  • Backport Improve form f.inputs attributes rendering #8446 by @amiel

3.2.3

Enhancements

Bug Fixes

  • Remove deprecation warnings when building with dart sass >= 1.77.7 #8405 by @mgrunberg

3.2.2

Security Fixes

Enhancements

3.2.1

Enhancements

3.2.0

Security Fixes

Enhancements

  • Backport support citext column type in string filter. #8165 by @mgrunberg
  • Backport provide detail in DB statement timeout error for filters. #8163 by @mgrunberg

Bug Fixes

  • Backport make sure menu creation does not modify menu options. #8166 by @mgrunberg
  • Backport ransack error with filters when ActiveStorage is used. #8164 by @mgrunberg

3.1.0

Enhancements

3.0.0

Breaking Changes

Enhancements

Translation Improvements

2.14.0

Enhancements

Bug Fixes

  • Fix form layout for hints and checkboxes. #7772 by @JewelSam
  • Update filters disabled error to include specific action. #6195 by @javawizard
  • Fix Comments controller destroy declaration. #6482 by @bliof
  • Stop pagination elements from overflowing outside of panel container. #7599 by @ray-curran

Translation Improvements

Documentation

Performance

2.13.1

Bug Fixes

  • Honor load paths order when loading admin files. #7488 by @tf
  • Fix passing expected hash payload argument. #7487 by @ispyropoulos

2.13.0

Documentation

  • Update validation errors documentation to account for deprecated ActiveModel::Errors#keys. #7475 by @amit

Dependency Changes

Performance

2.12.0

Enhancements

Bug Fixes

Documentation

  • Don't mention webpacker as the default asset generator in Rails. #7377 by @jaynetics

Performance

2.11.2

Bug Fixes

  • Fix disappearing BOM option for CSVBuilder. #7170 by @Karoid

2.11.1

Enhancements

  • Add turbolinks support to has many js. #7384 by @amiel

Documentation

2.11.0

Enhancements

Bug Fixes

  • Fix form SCSS variables no longer being defined in the outermost scope, so no longer being accessible. #7341 by @gigorok

2.10.1

Enhancements

Bug Fixes

2.10.0

Enhancements

Bug Fixes

  • Show ransackable_scopes filters in search results. #7127 by @vlad-psh

Translation Improvements

Documentation

Dependency Changes

2.9.0

Enhancements

Bug Fixes

  • Pick up upstream fixes in devise templates. #6536 by @munen

Documentation

  • Fix has_many syntax in forms documentation. #6583 by @krzcho
  • Add example of using default_main_content in show pages. #6487 by @sjieg

Dependency Changes

2.8.1

Bug Fixes

2.8.0

Enhancements

  • Allow using PORO decorators. #6249 by @brunvez
  • Make sure ActiveAdmin.routes provides routes in a consistent order. #6124 by @jiikko
  • Use proper closing tags for HTML in ModalDialog component. #6221 by @javierjulio

Bug Fixes

  • Fix comment layout so regardless of size, each is aligned and spaced evenly. #6393 by @Ivanov-Anton

Translation Improvements

Documentation

  • Fix filter_columns_for_large_association and filter_method_for_large_association examples. #6232 by @ndbroadbent

Dependency Changes

2.7.0

Enhancements

  • Extend menu to allow for nested submenus. #5994 by @taralbass
  • Add Webpacker compatibility with opt-in config switch and installation generator. #5855 by @sgara

Bug Fixes

  • Fix scopes renderer when resource has only optional scopes and their conditions are false. #6149 by @Looooong
  • Fix some missing wrapper markup in "logged out" layout. #6086 by @irmela
  • Fix some typos in Vietnamese translation. #6099 by @giapnhdev

2.6.1

Bug Fixes

  • Fix some ruby 2.7 warnings about keyword args. #6000 by @vcsjones
  • Missing create_another translation in Vietnamese. #6002 by @imcvampire
  • Using "destroy" for user facing message is too robotic, prefer "delete". #6047 by @vfonic
  • Typo in confirmation message for comment deletion. #6047 by @vfonic

2.6.0

Enhancements

  • Display multiple flash messages in separate elements. #5929 by @mirelon
  • Make delete confirmation messages in French & Spanish gender-neutral. #5946 by @cprodhomme

Bug Fixes

  • Export ModalDialog component to re-enable client side usage. #5956 by @sgara
  • Use default ActionView options instead of default Formtastic options for DateRangeInput #5957 by @mirelon
  • Fix i18n key in docs example to translate scopes. #5943 by @adler99

2.5.0

Enhancements

Bug Fixes

  • Convert namespace to sym to prevent duplicate namespaces such as :foo and 'foo'. #5931 by @westonganger
  • Use filter label when condition has a predicate. #5886 by @ko-lem
  • Fix error when routing with array containing symbol. #5870 by @jwesorick
  • Fix error when there is a model named Tag and meta_tags have been configured. #5895 by @micred, @FabioRos and @deivid-rodriguez
  • Allow specifying custom input_html for DateRangeInput. #5867 by @mirelon
  • Adjust #main_content right margin to take into account possible custom values of $sidebar-width and $section-padding. #5887 by @guigs
  • Improved polymorphic routes generation to avoid problems when multiple belongs_to are defined. #5938 by @leio10

Dependency Changes

2.4.0

Enhancements

  • Make optimization to not use expensive COUNT queries also work for decorated actions. #5811 by @irmela
  • Render a text filter instead of a select for large associations (opt-in). #5548 by @DanielHeath
  • Improve German translations. #5874 by @juril33t

2.3.1

Bug Fixes

2.3.0

Enhancements

  • Bump minimum ransack requirement to make sure everyone gets a version that works ok with all supported versions of Rails. #5831 by @deivid-rodriguez

Bug Fixes

  • Fix CSVBuilder not respecting ActiveAdmin.application.csv_options = { humanize_name: false } setting. #5800 by @HappyKadaver
  • Fix crash when displaying current filters after filtering by a nested resource. #5816 by @deivid-rodriguez
  • Fix pagination when pagination_total is false to not show a "Last" link, since it's incorrect because we don't have the total pages information. #5822 by @deivid-rodriguez
  • Fix optional nested resources causing incorrect routes to be generated, when renamed resources (through :as option) are involved. #5826 by @ndbroadbent, @Kris-LIBIS and @deivid-rodriguez
  • Fix double modal issue in applications using turbolinks 5. #5842 by @sgara

2.2.0

Enhancements

  • The status_tag component now supports different labels for false and nil boolean cases through the locale. Both default to display "No" for backwards compatibility. #5794 by @javierjulio
  • Add Macedonian locale. #5710 by @violeta-p

Bug Fixes

2.1.0

Bug Fixes

  • Ensure application gets reloaded only once. #5740 by @jscheid
  • Crash when rendering comments from a custom controller block. #5758 by @deivid-rodriguez
  • Switch sass dependency to sassc-rails, since sass is no longer supported and since it restores support for directly importing css files. #5504 by @deivid-rodriguez

Dependency Changes

2.0.0

No changes.

2.0.0.rc2

Enhancements

2.0.0.rc1

Enhancements

  • Add your own content to the site <head>, like analytics. #5590 by @buren

    ActiveAdmin.setup do |config|
      config.head = ''.html_safe
    end
  • Consider authorization when displaying comments in show page. #5555 by @amiuhle

  • Add better support for rendering lists. #5370 by @dkniffin
  • Undeprecate config.register_stylesheet and config.register_javascript for lack of better solution for including external assets. It might be reevaluated in the future. #5662 by @deivid-rodriguez

Security Fixes

  • Prevent leaking hashed passwords via user CSV export and adds a config option for sensitive attributes. #5486 by @chrp

Bug Fixes

Dependency Changes

  • Rails 4.2 support has been dropped. #5104 by @javierjulio and @deivid-rodriguez
  • Dependency on coffee-rails has been removed. #5081 by @javierjulio If your application uses coffescript but was relying on ActiveAdmin to provide the dependency, you need to add the coffee-script gem to your Gemfile to restore it. If your only usage of coffescript was the active_admin.js.coffee generated by ActiveAdmin's generator, you can also convert that file to plain JS (//= require active_admin/base if you didn't add any stuff to it).
  • Devise 3 support has been dropped. #5608 by @deivid-rodriguez and @javierjulio
  • action_item without a name has been removed. #5099 by @javierjulio

1.4.3

Bug Fixes

1.4.2

Bug Fixes

  • Fix input_html filter option evaluated only once. #5376 by @kjeldahl

1.4.1

Bug Fixes

1.4.0

Enhancements

Bug Fixes

  • Fixed the string representation of the resolved sort_key when no explicit sortable attribute is passed. #5464 by @chumakoff
  • Fixed docs on the column sortable attribute (which actually doesn't have to be explicitly specified when a block is passed to column). #5464 by @chumakoff
  • Fixed if: scope option when a lambda is passed. #5501 by @deivid-rodriguez
  • Comment validation adding redundant errors when resource is missing. #5517 by @deivid-rodriguez
  • Fixed resource filtering by association when the resource has custom primary key. #5446 by @wasifhossain
  • Fixed "create anoter" checkbox styling. #5324 by @faucct

1.3.1

Bug Fixes

  • gemspec should have more permissive ransack dependency. #5448 by @varyonic

1.3.0

Enhancements

1.2.1

Bug Fixes

1.2.0

Enhancements

Bug Fixes

1.1.0

Bug Fixes

  • Fixed #5093 Handle table prefix & table suffix for ActiveAdminComment model
  • Fixed #4173 by including the default Kaminari templates. #5069 by @javierjulio
  • Fixed #5043. Do not crash in sidebar rendering when a default scope is not specified. #5044 by @Fivell
  • Fixed #3894. Make tab's component work with non-ascii titles. #5046 by @Fivell

Dependency Changes

  • Ruby 2.1 support has been dropped. #5003 by @deivid-rodriguez
  • Replaced sass-rails with sass dependency. #5037 by @javierjulio
  • Removed jquery-ui-rails as a dependency. #5052 by @javierjulio The specific jQuery UI assets used are now within the vendor directory. This will be replaced by alternatives and dropped entirely in a major release. Please remove any direct inclusions of //= require jquery-ui. This allows us to upgrade to jquery v3.

Deprecations

  • Deprecated config.register_stylesheet and config.register_javascript. Import your CSS and JS files in active_admin.scss or active_admin.js. #5060 by @javierjulio
  • Deprecated type param from status_tag and related CSS classes #4989 by @javierjulio The method signature has changed from:

    status_tag(status, :ok, class: 'completed', label: 'on')

    to:

    status_tag(status, class: 'completed ok', label: 'on')

    The following CSS classes have been deprecated and will be removed in the future:

    .status_tag {
      &.ok, &.published, &.complete, &.completed, &.green { background: #8daa92; }
      &.warn, &.warning, &.orange { background: #e29b20; }
      &.error, &.errored, &.red { background: #d45f53; }
    }

Enhancements

  • Support proc as an input_html option value when declaring filters. #5029 by @Fivell
  • Base localization support, better associations handling for active filters sidebar. #4951 by @Fivell
  • Allow AA scopes to return paginated collections. #4996 by @Fivell
  • Added scopes_show_count configuration to setup show_count attribute for scopes globally. #4950 by @Fivell
  • Allow custom panel title given with attributes_table. #4940 by @ajw725
  • Allow passing a class to action_item block. #4997 by @Fivell
  • Add pagination to the comments section. #5088 by @alex-bogomolov

1.0.0

Breaking Changes

Enhancements

Security Fixes

Bug Fixes

  • Fixes filters for has_many :through relationships. #2541 by @shekibobo
  • "New" action item now only shows up on the index page. bf659bc by @seanlinsley
  • Fixes comment creation bug with aliased resources. 9a082486 by @seanlinsley
  • Fixes the deletion of :if and :unless from filters. #2523 by @PChambino

Deprecations

  • ActiveAdmin::Event (ActiveAdmin::EventDispatcher). #3435 by @timoschilling ActiveAdmin::Event will be removed in a future version, ActiveAdmin switched to use ActiveSupport::Notifications NOTE: The blog parameters has changed:

    ActiveSupport::Notifications.subscribe ActiveAdmin::Application::BeforeLoadEvent do |event, *args|
      # some code
    end
    
    ActiveSupport::Notifications.publish ActiveAdmin::Application::BeforeLoadEvent, "some data"
  • action_item without a name, to introduce a solution for removing action items (remove_action_item(name)). #3091 by @amiel

Previous Changes

Please check 0-6-stable for previous changes.