Ckeditor_wave NPM

CkeditorWave

This gem integrates CKEditor 5 with CarrierWave to allow image upload.

Installation

Add this line to your application's Gemfile:

gem 'ckeditor_wave', '~> 2.0'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ckeditor_wave

To generate and execute the migration, run:

$ rails g ckeditor_wave
$ rails db:migrate

Add the following at the bottom of your application.js:

//= require ckeditor_wave

Add the following to your routes.rb file:

mount CkeditorWave::Engine => 'ckeditor_wave'

To attach CKEditor 5 to HTML forms, call the initiateCkeditor() function inside your application.js by wrapping in in a DOMContentLoaded EventListener and giving it one or more CSS selectors as arguments. For example:

document.addEventListener('DOMContentLoaded', () => {
  initiateCkeditor('#editor1', '#editor2', '#editor3');
});

Dependencies

CKEditor 5 - classic editor build 10.0.1
CarrierWave - version ~> 1.2

To install CKEditor 5, download the 'classic editor build 10.0.1' ZIP package from this link and insert the ckeditor.js file inside you app/assets/javascripts folder. Alternatively, you can use the CDN also available from the same link.

If you do not have the CarrierWave gem installed, please add the following to your Gemfile: