Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/platanus/activeadmin_addons
Extends ActiveAdmin to enable a set of great optional UX improving add-ons
https://github.com/platanus/activeadmin_addons
activeadmin rails
Last synced: 30 days ago
JSON representation
Extends ActiveAdmin to enable a set of great optional UX improving add-ons
- Host: GitHub
- URL: https://github.com/platanus/activeadmin_addons
- Owner: platanus
- License: mit
- Created: 2014-06-06T15:26:37.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T18:13:17.000Z (2 months ago)
- Last Synced: 2024-05-03T00:19:15.263Z (about 2 months ago)
- Topics: activeadmin, rails
- Language: Ruby
- Homepage:
- Size: 8.56 MB
- Stars: 746
- Watchers: 27
- Forks: 282
- Open Issues: 69
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: MIT-LICENSE
Lists
- awesome-stars - platanus/activeadmin_addons - Extends ActiveAdmin to enable a set of great optional UX improving add-ons (Ruby)
- awesome-stars - activeadmin_addons - ons | platanus | 666 | (Ruby)
README
# ActiveAdmin Addons
[](https://badge.fury.io/rb/activeadmin_addons)
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.
## What you get:
#### Rows/Columns
- [Shrine Image](#shrine-image): show thumbnails on your show/index views.
- [AASM Integration](#aasm-integration): nice looking tags for states.
- [Rails Enum Integration](#rails-enum-integration): nice looking tags for enums.
- [Boolean Values](#boolean-values): beautiful boolean values.
- [Toggleable Booleans](#toggleable-boolean-columns): have switches to toggle values directly at the index
- [Number Formatting](#number-formatting): format you currencies with ease.
- [List](#list): show Arrays or Hashes like a list.
#### Inputs
- [Select2 Input](#select2-input): cool select boxes for everyone.
- [Tag Input](#tag-input): to add tags using select2.
- [Search Select Input](#search-select-input): easy ajax search with activeadmin.
- [Selected List Input](#selected-list-input): to handle your many to many associations.
- [Nested Select Input](#nested-select-input): to build related select inputs.
- [Color Picker Input](#color-picker-input): select colors from a pretty popup.
- [Date Time Picker Input](#date-time-picker-input): pick date and time comfortably.
#### Filters
- [Numeric Range Filter](#numeric-range-filter): filter your results using a numeric range (i.e. age between 18-30).
- [Date Time Picker Filter](#date-time-picker-filter): filter your results using a datetime range.
- [Search Select Filter](#search-select-filter): filter your results using the ajax select input.
#### Themes
- [No Theme](#no-theme): ActiveAdmin default style.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'activeadmin_addons'
```
And then execute:
```bash
$ bundle
```
After that, run the generator:
```bash
$ rails g activeadmin_addons:install
```
Check [here](docs/install_generator.md) to see more information about this generator.
## Default changes to behaviour
Installing this gem will enable the following changes by default:
* The default date input will be `:datepicker` instead of `:date_select`
* Select filters will show translated values when used with Rails built-in `enums`
* All select boxes will use select2
## Addons
### Rows/Columns
#### Images
Display images in the index and show views. This implementation supports [Shrine](https://github.com/shrinerb/shrine).
[Read more!](docs/images.md)
#### AASM Integration
You can show [aasm](https://github.com/aasm/aasm) values as active admin tags.
[Read more!](docs/aasm_integration.md)
#### Rails Enum Integration
You can show Rails' built in `enums` as active admin tags.
[Read more!](docs/enum_integration.md)
#### Boolean Values
Modifies how boolean values are displayed.
[Read more!](docs/boolean_values.md)
#### Toggleable Boolean Columns
Have switches to toggle values directly at the index
[Read more!](docs/toggle_bool.md)
#### Number Formatting
You can show numbers with format supported by [Rails NumberHelper](http://apidock.com/rails/v4.2.1/ActionView/Helpers/NumberHelper)
[Read more!](docs/number-formatting.md)
#### List
You can show `Array` or `Hash` values as html lists.
[Read more!](docs/list.md)
#### Markdown
You can render text as markdown.
[Read more!](docs/markdown.md)
### Inputs
#### Slim Select Input
With [Slim Select](https://slimselectjs.com/) the select control looks nicer, it works great with large collections.
[Read more!](docs/slim-select_default.md)
#### Tag Input
Using tags input, you can add tags using slim select.
[Read more!](docs/slim-select_tags.md)
#### Selected List Input
This form control allows you to handle your many to many associations.
[Read more!](docs/slim-select_selected_list.md)
#### Search Select Input
Using `search_select` input, you can easily add ajax search to activeadmin.
[Read more!](docs/slim-select_search.md)
#### Nested Select Input
Using `nested_select` input, you can build related select inputs.
[Read more!](docs/slim-select_nested_select.md)
### Color Picker Input
You can pick colors using [JQuery Palette Color Picker](https://github.com/carloscabo/jquery-palette-color-picker)
```ruby
f.input :color, as: :color_picker
```
[Read more!](docs/color-picker.md)
### Date Time Picker Input
You can pick dates with time using the xdan's [jQuery Plugin Date and Time Picker](https://github.com/xdan/datetimepicker)
```ruby
f.input :updated_at, as: :date_time_picker
```
[Read more!](docs/date-time-picker.md)
### Filters
#### Numeric Range Filter
To filter based on a range of values you can use `numeric_range_filter` like this:
```ruby
filter :number, as: :numeric_range_filter
```
#### Date Time Picker Filter
To filter based on a range of datetimes you can use `date_time_picker_filter` like this:
```ruby
filter :created_at, as: :date_time_picker_filter
```
#### Search Select Filter
You can use the ajax select input to filter values on index view like this:
```ruby
filter :category, as: :search_select_filter
```
[Read more!](docs/slim-select_search.md#filter-usage)
### Themes
#### NO Theme
Use default active_admin theme.
## Publishing
On a new branch:
1. Change `VERSION` in `lib/activeadmin_addons/version.rb`. Note that beta versions should have a `.beta` suffix (e.g. `1.0.0.beta.1`).
2. Change `"version"` in `package.json` to the same version. Note that beta versions should have a `-beta` suffix (e.g. `1.0.0-beta.1`).
3. Change `Unreleased` title to current version in `CHANGELOG.md`.
4. Run `bundle install`.
5. Open a new PR with those changes.
6. Once the PR is merged, checkout to master and pull the changes.
8. Create tag. For example: `git tag v1.0.0`.
9. Push tag. For example: `git push origin v1.0.0`. This will trigger the CI to publish the new version to npm and rubygems.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
If you want to collaborate, please check [the rules](docs/CONTRIBUTING.md) first.
## Credits
Thank you [contributors](https://github.com/platanus/activeadmin_addons/graphs/contributors)!
activeadmin_addons is maintained by [platanus](http://platan.us).
## License
ActiveAdminAddons is © 2021 Platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.