/activeadmin_quill_editor

Quill Rich Text Editor for ActiveAdmin

Primary LanguageJavaScriptMIT LicenseMIT

ActiveAdmin Quill Editor Gem Version

An Active Admin plugin to use Quill Rich Text Editor

screenshot

Install

  • Update your Gemfile: gem 'activeadmin_quill_editor' (and execute bundle)
  • For ActiveAdmin2 alpha use: gem 'activeadmin_quill_editor', git: 'https://github.com/blocknotes/activeadmin_quill_editor', branch: 'aa2'
  • Add at the end of your ActiveAdmin styles (app/assets/stylesheets/active_admin.scss):
@import 'activeadmin/quill_editor_input';
  • Add at the end of your ActiveAdmin javascripts (app/assets/javascripts/active_admin.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? In this way you can include a different version of quill editor if you like.

Options

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

Examples

# ActiveAdmin 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 functions (Images, Documents, Files, etc.) are not implemented 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 ActiveAdmin components that I made if you are curious.

Contributors

License

MIT