ActiveAdmin Quill Editor Gem Version CircleCI

An Active Admin plugin to use Quill Rich Text Editor in form fields.

screenshot

Install

  • After installing Active Admin, add to your Gemfile: gem 'activeadmin_quill_editor' (and execute bundle)
  • Add at the end of your Active Admin styles (app/assets/stylesheets/active_admin.scss): scss @import 'activeadmin/quill_editor/quill.snow'; @import 'activeadmin/quill_editor_input';
  • Add at the end of your Active Admin javascripts (app/assets/javascripts/active_admin.js): js //= require activeadmin/quill_editor/quill //= require activeadmin/quill_editor_input
  • Use the input with as: :quill_editor in Active Admin model conf

Why 2 separated scripts/styles? In this way you can include a different version of quill editor if you like.

UPDATE FROM VERSION <= 2.0: please add to your app/assets/stylesheets/active_admin.scss the line @import 'activeadmin/quill_editor/quill.snow';

Options

data-options: permits to set quill editor options directly - see options list

Examples

Basic usage

# Active Admin article form conf:
  form do |f|
    f.inputs 'Article' do
      f.input :title
      f.input :description, as: :quill_editor
      f.input :published
    end
    f.actions
  end

Toolbar buttons configuration

f.input :description, as: :quill_editor, input_html: { data: { options: { modules: { toolbar: [['bold', 'italic', 'underline'], ['link']] }, placeholder: 'Type something...', theme: 'snow' } } }

Notes

  • Upload features (images/documents/files): not tested yet.

Do you like it? Star it!

If you use this component just star it. A developer is more motivated to improve a project when there is some interest.

Take a look at other Active Admin components that I made if you are curious.

Contributors

  • Mattia Roccoberton: author
  • The good guys that opened issues and pull requests from time to time

License

The gem is available as open-source under the terms of the MIT.