ActiveAdmin Addons will extend your ActiveAdmin and enable a set of addons you can optionally use to improve the ActiveAdmin UI and make it awesome.
This gem now supports ActiveAdmin 4! The latest beta version includes:
- Support for modern JavaScript bundlers (esbuild, webpack, importmap)
- ESM module support for better tree-shaking
- Updated CSS selectors for ActiveAdmin 4 compatibility
- NPM package available for easier JavaScript management
- Shrine Image: show thumbnails on your show/index views.
- AASM Integration: nice looking tags for states.
- Rails Enum Integration: nice looking tags for enums.
- Boolean Values: beautiful boolean values.
- Toggleable Booleans: have switches to toggle values directly at the index
- Number Formatting: format you currencies with ease.
- List: show Arrays or Hashes like a list.
- Select2 Input: cool select boxes for everyone.
- Tag Input: to add tags using select2.
- Search Select Input: easy ajax search with activeadmin.
- Selected List Input: to handle your many to many associations.
- Nested Select Input: to build related select inputs.
- Color Picker Input: select colors from a pretty popup.
- Date Time Picker Input: pick date and time comfortably.
- Numeric Range Filter: filter your results using a numeric range (i.e. age between 18-30).
- Date Time Picker Filter: filter your results using a datetime range.
- Search Select Filter: filter your results using the ajax select input.
- No Theme: ActiveAdmin default style.
- Ruby >= 3.2
- Rails >= 7.0
- ActiveAdmin >= 3.0 (ActiveAdmin 4 supported!)
Add this line to your application's Gemfile:
gem 'activeadmin_addons', '~> 2.0.0.beta'And then execute:
$ bundleAfter that, run the generator with your preferred bundler:
# Auto-detect your bundler (recommended)
$ rails g activeadmin_addons:install
# Or specify explicitly:
$ rails g activeadmin_addons:install --bundler=esbuild
$ rails g activeadmin_addons:install --bundler=importmap
$ rails g activeadmin_addons:install --bundler=webpack
$ rails g activeadmin_addons:install --bundler=sprocketsFor better JavaScript module management, you can also install via NPM:
npm install @platanus/activeadmin_addonsThen import in your active_admin.js:
import '@platanus/activeadmin_addons';For ActiveAdmin 3.x, use version 1.x of this gem:
gem 'activeadmin_addons', '~> 1.0'Check here to see more information about the generator.
If you're upgrading from ActiveAdmin 3 to 4, please note:
- Update your Gemfile: Use version 2.x of activeadmin_addons
- Run the installer again: The asset pipeline has changed significantly
- CSS Selectors: Some CSS classes have changed (e.g.,
.filter_form→.filters-form) - JavaScript modules: Consider switching to the NPM package for better module management
For detailed migration instructions, see ActiveAdmin 4 Migration Guide.
Installing this gem will enable the following changes by default:
- The default date input will be
:datepickerinstead of:date_select - Select filters will show translated values when used with Rails built-in
enums - All select boxes will use Slim Select (replacing Select2 in v2.x)
Display images in the index and show views. This implementation supports Shrine.
You can show aasm values as active admin tags.
You can show Rails' built in enums as active admin tags.
Modifies how boolean values are displayed.
Have switches to toggle values directly at the index
You can show numbers with format supported by Rails NumberHelper
You can show Array or Hash values as html lists.
You can render text as markdown.
With Slim Select the select control looks nicer, it works great with large collections.
Using tags input, you can add tags using slim select.
This form control allows you to handle your many to many associations.
Using search_select input, you can easily add ajax search to activeadmin.
Using nested_select input, you can build related select inputs.
You can pick colors using JQuery Palette Color Picker
f.input :color, as: :color_picker
You can pick dates with time using the xdan's jQuery Plugin Date and Time Picker
f.input :updated_at, as: :date_time_picker
To filter based on a range of values you can use numeric_range_filter like this:
filter :number, as: :numeric_range_filter
To filter based on a range of datetimes you can use date_time_picker_filter like this:
filter :created_at, as: :date_time_picker_filter
You can use the ajax select input to filter values on index view like this:
filter :category, as: :search_select_filter
Use default active_admin theme.
On a new branch:
- Change
VERSIONinlib/activeadmin_addons/version.rb. Note that beta versions should have a.betasuffix (e.g.2.0.0.beta.5). - Change
"version"inpackage.jsonto the same version. Note that beta versions should have a-betasuffix (e.g.2.0.0-beta.5). - Change
Unreleasedtitle to current version inCHANGELOG.md. - Run
bundle install. - Open a new PR with those changes.
- Once the PR is merged, checkout to master and pull the changes.
- Create tag. For example:
git tag v2.0.0.beta.5. - Push tag. For example:
git push origin v2.0.0.beta.5.
The GitHub Actions workflow will automatically:
- Publish the Ruby gem to RubyGems (requires
RUBYGEMS_API_KEYsecret) - Publish the NPM package to npm registry (requires
NPM_TOKENsecret)
If needed, you can publish manually:
# Ruby Gem
gem build activeadmin_addons.gemspec
gem push activeadmin_addons-2.0.0.beta.5.gem
# NPM Package
npm run prepublishOnly
npm publish --access public- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
If you want to collaborate, please check the rules first.
Thank you contributors!
activeadmin_addons is maintained by platanus.
ActiveAdminAddons is © 2021 Platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.