activeadmin_quill_editor 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad04679c2c87aaf9cc8e2e8577ec9b9f216b91c0c61692f5261e126047ece83d
-  data.tar.gz: 7afbcb26e9049f76a48582c4c8fbdf4e7a09a592a4a0cc95ffb023d47b12d01f
+  metadata.gz: a4c64ad878e1367dbc40efb644f4372e3cc85e726a2dafa9e602f16311f59ba3
+  data.tar.gz: c35421055ae083865000d9c02525e715f2a273502c60e026796233a686fce96f
 SHA512:
-  metadata.gz: 6188c7952e753a9d6da501062d2e779c25759b2dd1441b8cf9475ecfa0d5e0e8d299e15f3ae8cfe745181539c710a7f670fd6b727d0b043781662eb730f77914
-  data.tar.gz: 1d918e65c25b1771af61473fda8a961ba9d6b3d0f0dad3d5a598998684e79f065c0f04a94caf32e32ab02e11dfbffa216ad3f50a808933588a96764b04f9fc2b
+  metadata.gz: ae07acc5c4c31c1d67b7f53056b571c3daaad81d29793cb7a3cb79ae05cc2a8686cced1a899df4e204f9d18b4336d6e324d7daff2490bbe56b9696a7d8508b9a
+  data.tar.gz: a46ca361536d05ba54166df559448230c3283a3a9477ead220aece61cc54d6341d3af28fb7e01ac6fbf650e080721f7ca1c2096f78fb650da8d09411f52cb257

data/README.md

@@ -1,11 +1,14 @@
 # ActiveAdmin Quill Editor [![Gem Version](https://badge.fury.io/rb/activeadmin_quill_editor.svg)](https://badge.fury.io/rb/activeadmin_quill_editor) [![CircleCI](https://circleci.com/gh/blocknotes/activeadmin_quill_editor.svg?style=svg)](https://circleci.com/gh/blocknotes/activeadmin_quill_editor)
 
-An Active Admin plugin to use [Quill Rich Text Editor](https://github.com/quilljs/quill)
+An Active Admin plugin to use [Quill Rich Text Editor](https://github.com/quilljs/quill) in form fields.
 
 ![screenshot](screenshot.png)
 
 ## Install
-- After installing Active Admin, add to your Gemfile: `gem 'activeadmin_quill_editor'` (and execute *bundle*)
+After installing Active Admin, add to your Gemfile: `gem 'activeadmin_quill_editor'` (and execute *bundle*)
+
+If you installed Active Admin without Webpacker support (default for now):
+
 - Add at the end of your Active Admin styles (_app/assets/stylesheets/active_admin.scss_):
 ```scss
 @import 'activeadmin/quill_editor/quill.snow';
@@ -16,13 +19,23 @@ An Active Admin plugin to use [Quill Rich Text Editor](https://github.com/quillj
 //= 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.
 
 > **UPDATE FROM VERSION <= 2.0**: please add to your _app/assets/stylesheets/active_admin.scss_ the line `@import 'activeadmin/quill_editor/quill.snow';`
 
-## Options
+If you installed Active Admin with Webpacker support:
+
+- Execute in your project root:
+```sh
+yarn add blocknotes/activeadmin_quill_editor
+```
+- Add to your *app/javascript/packs/active_admin.js*:
+```js
+require('activeadmin_quill_editor')
+```
+
+## Usage
+In your Active Admin models, form configuration, set the text inputs with `as: :quill_editor` where needed.
+
 **data-options**: permits to set *quill editor* options directly - see [options list](https://quilljs.com/docs/configuration/)
 
 ## Examples
@@ -44,11 +57,34 @@ Why 2 separated scripts? In this way you can include a different version of *qui
 ### Toolbar buttons configuration
 
 ```ruby
-f.input :description, as: :quill_editor, input_html: {data: {options: {modules: {toolbar: [['bold', 'italic', 'underline'], ['link']]}, placeholder: 'Type something...', theme: 'snow'}}}
+f.input :description, as: :quill_editor, input_html: { data: { options: { modules: { toolbar: [['bold', 'italic', 'underline'], ['link']] }, placeholder: 'Type something...', theme: 'snow' } } }
+```
+
+### ImageUploader plugin
+This plugin allows to upload images to the server (instead of storing them in *base64* by default), reference [here](https://github.com/NoelOConnell/quill-image-uploader).
+
+```ruby
+# Upload method (to be included in the admin entity configuration)
+member_action :upload, method: [:post] do
+  result = { success: resource.images.attach(params[:file_upload]) }
+  result[:url] = url_for(resource.images.last) if result[:success]
+  render json: result
+end
+```
+
+```ruby
+# Form field
+unless object.new_record?
+  plugin_opts = { image_uploader: { server_url: upload_admin_post_path(object.id), field_name: 'file_upload' } }
+  f.input :description, as: :quill_editor, input_html: { data: { plugins: plugin_opts } }
+end
 ```
 
-## Notes
-- Upload functions (Images, Documents, Files, etc.) are not implemented yet
+For the relevant files of the upload example see [here](examples/upload_plugin_using_activestorage/).
+Consider that this is just a basic example: images are uploaded as soon as they are attached to the
+ editor (regardless of the form submit), it shows the editor only for an existing record (because of
+the *upload_admin_post_path*) and it doesn't provide a way to remove images (just deleting them from
+the editor will not destroy them, you'll need to implement a purge logic for that).
 
 ## 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.
@@ -60,4 +96,4 @@ Take a look at [other Active Admin components](https://github.com/blocknotes?utf
 - 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](LICENSE.txt)
+The gem is available as open-source under the terms of the [MIT](LICENSE.txt).

data/app/assets/javascripts/activeadmin/quill.imageUploader.min.js

@@ -0,0 +1 @@
+!function(e){var t={};function n(i){if(t[i])return t[i].exports;var r=t[i]={i:i,l:!1,exports:{}};return e[i].call(r.exports,r,r.exports,n),r.l=!0,r.exports}n.m=e,n.c=t,n.d=function(e,t,i){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:i})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var i=Object.create(null);if(n.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var r in e)n.d(i,r,function(t){return e[t]}.bind(null,r));return i},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s=1)}([function(e,t){e.exports=Quill},function(e,t,n){"use strict";n.r(t);var i=n(0),r=n.n(i),o=function(){function e(e,t){for(var n=0;n<t.length;n++){var i=t[n];i.enumerable=i.enumerable||!1,i.configurable=!0,"value"in i&&(i.writable=!0),Object.defineProperty(e,i.key,i)}}return function(t,n,i){return n&&e(t.prototype,n),i&&e(t,i),t}}(),a=function e(t,n,i){null===t&&(t=Function.prototype);var r=Object.getOwnPropertyDescriptor(t,n);if(void 0===r){var o=Object.getPrototypeOf(t);return null===o?void 0:e(o,n,i)}if("value"in r)return r.value;var a=r.get;return void 0!==a?a.call(i):void 0};function l(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}function s(e,t){if(!e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return!t||"object"!=typeof t&&"function"!=typeof t?e:t}var u=function(e){function t(){return l(this,t),s(this,(t.__proto__||Object.getPrototypeOf(t)).apply(this,arguments))}return function(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Super expression must either be null or a function, not "+typeof t);e.prototype=Object.create(t&&t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}}),t&&(Object.setPrototypeOf?Object.setPrototypeOf(e,t):e.__proto__=t)}(t,e),o(t,[{key:"deleteAt",value:function(e,n){a(t.prototype.__proto__||Object.getPrototypeOf(t.prototype),"deleteAt",this).call(this,e,n),this.cache={}}}],[{key:"create",value:function(e){var n=a(t.__proto__||Object.getPrototypeOf(t),"create",this).call(this,e);if(!0===e)return n;var i=document.createElement("img");return i.setAttribute("src",e),n.appendChild(i),n}},{key:"value",value:function(e){var t=e.dataset;return{src:t.src,custom:t.custom}}}]),t}(r.a.import("blots/block"));u.blotName="imageBlot",u.className="image-uploading",u.tagName="span",r.a.register({"formats/imageBlot":u});var c=u,f=(n(3),function(){function e(e,t){for(var n=0;n<t.length;n++){var i=t[n];i.enumerable=i.enumerable||!1,i.configurable=!0,"value"in i&&(i.writable=!0),Object.defineProperty(e,i.key,i)}}return function(t,n,i){return n&&e(t.prototype,n),i&&e(t,i),t}}());var d=function(){function e(t,n){!function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}(this,e),this.quill=t,this.options=n,this.range=null,"function"!=typeof this.options.upload&&console.warn("[Missing config] upload function that returns a promise is required"),this.quill.getModule("toolbar").addHandler("image",this.selectLocalImage.bind(this)),this.handleDrop=this.handleDrop.bind(this),this.handlePaste=this.handlePaste.bind(this),this.quill.root.addEventListener("drop",this.handleDrop,!1),this.quill.root.addEventListener("paste",this.handlePaste,!1)}return f(e,[{key:"selectLocalImage",value:function(){var e=this;this.range=this.quill.getSelection(),this.fileHolder=document.createElement("input"),this.fileHolder.setAttribute("type","file"),this.fileHolder.setAttribute("accept","image/*"),this.fileHolder.setAttribute("style","visibility:hidden"),this.fileHolder.onchange=this.fileChanged.bind(this),document.body.appendChild(this.fileHolder),this.fileHolder.click(),window.requestAnimationFrame((function(){document.body.removeChild(e.fileHolder)}))}},{key:"handleDrop",value:function(e){var t=this;if(e.stopPropagation(),e.preventDefault(),e.dataTransfer&&e.dataTransfer.files&&e.dataTransfer.files.length){if(document.caretRangeFromPoint){var n=document.getSelection(),i=document.caretRangeFromPoint(e.clientX,e.clientY);n&&i&&n.setBaseAndExtent(i.startContainer,i.startOffset,i.startContainer,i.startOffset)}else{var r=document.getSelection(),o=document.caretPositionFromPoint(e.clientX,e.clientY);r&&o&&r.setBaseAndExtent(o.offsetNode,o.offset,o.offsetNode,o.offset)}this.range=this.quill.getSelection();var a=e.dataTransfer.files[0];setTimeout((function(){t.range=t.quill.getSelection(),t.readAndUploadFile(a)}),0)}}},{key:"handlePaste",value:function(e){var t=this,n=e.clipboardData||window.clipboardData;if(n&&(n.items||n.files))for(var i=n.items||n.files,r=/^image\/(jpe?g|gif|png|svg|webp)$/i,o=0;o<i.length;o++)r.test(i[o].type)&&function(){var n=i[o].getAsFile?i[o].getAsFile():i[o];n&&(t.range=t.quill.getSelection(),e.preventDefault(),setTimeout((function(){t.range=t.quill.getSelection(),t.readAndUploadFile(n)}),0))}()}},{key:"readAndUploadFile",value:function(e){var t=this,n=!1,i=new FileReader;i.addEventListener("load",(function(){if(!n){var e=i.result;t.insertBase64Image(e)}}),!1),e&&i.readAsDataURL(e),this.options.upload(e).then((function(e){t.insertToEditor(e)}),(function(e){n=!0,t.removeBase64Image(),console.warn(e)}))}},{key:"fileChanged",value:function(){var e=this.fileHolder.files[0];this.readAndUploadFile(e)}},{key:"insertBase64Image",value:function(e){var t=this.range;this.quill.insertEmbed(t.index,c.blotName,""+e,"user")}},{key:"insertToEditor",value:function(e){var t=this.range;this.quill.deleteText(t.index,3,"user"),this.quill.insertEmbed(t.index,"image",""+e,"user"),t.index++,this.quill.setSelection(t,"user")}},{key:"removeBase64Image",value:function(){var e=this.range;this.quill.deleteText(e.index,3,"user")}}]),e}();window.ImageUploader=d;t.default=d},,function(e,t){}]);

data/app/assets/javascripts/activeadmin/quill_editor_input.js

@@ -1,45 +1,95 @@
-function initQuillEditors() {
-  var editors = document.querySelectorAll('.quill-editor');
-  var default_options = {
-    modules: {
-      toolbar: [
-        ['bold', 'italic', 'underline'],
-        ['link', 'blockquote', 'code-block'],
-        [{ 'script': 'sub'}, { 'script': 'super' }],
-        [{ 'align': [] }, { list: 'ordered' }, { list: 'bullet' }],
-        [{ 'color': [] }, { 'background': [] }],
-        ['clean'],
-      ]
-    },
-    placeholder: '',
-    theme: 'snow'
-  };
-
-  for(var i = 0; i < editors.length; i++) {
-    var content = editors[i].querySelector('.quill-editor-content');
-    var isActive = editors[i].classList.contains('quill-editor--active');
-    if(content && !isActive) {
-      var options = editors[i].getAttribute('data-options') ? JSON.parse(editors[i].getAttribute('data-options')) : default_options;
-      editors[i]['_quill-editor'] = new Quill(content, options);
-      editors[i].classList += ' quill-editor--active';
+(function () {
+  'use strict'
+
+  // --- functions ---------------------------------------------------------------
+  function initQuillEditors() {
+    let default_theme = 'snow'
+    let default_toolbar = [
+      ['bold', 'italic', 'underline'],
+      ['link', 'blockquote', 'code-block'],
+      [{ 'script': 'sub' }, { 'script': 'super' }],
+      [{ 'align': [] }, { list: 'ordered' }, { list: 'bullet' }],
+      [{ 'color': [] }, { 'background': [] }],
+      ['image'],
+      ['clean'],
+    ]
+    let editors = document.querySelectorAll('[data-aa-quill-editor]')
+    let registered_plugins = {}
+
+    for (let i = 0; i < editors.length; i++) {
+      let content = editors[i].querySelector('[data-aa-quill-content]')
+      let isActive = editors[i].classList.contains('quill-editor--active')
+      if (content && !isActive) {
+        // Setup editor options
+        let options = editors[i].getAttribute('data-options') ? JSON.parse(editors[i].getAttribute('data-options')) : {}
+        if (!options.theme) options.theme = default_theme
+        if (!options.modules) options.modules = {}
+        if (!options.modules.toolbar) options.modules.toolbar = default_toolbar
+
+        // Setup plugin options
+        let plugin_options = editors[i].getAttribute('data-plugins') ? JSON.parse(editors[i].getAttribute('data-plugins')) : {}
+        if (plugin_options.image_uploader && plugin_options.image_uploader.server_url) {
+          if (!registered_plugins.image_uploader) {
+            Quill.register('modules/imageUploader', ImageUploader)
+            registered_plugins.image_uploader = true
+          }
+          let opts = plugin_options.image_uploader
+          options.modules.imageUploader = setupImageUploader(opts.server_url, opts.field_name)
+        }
+
+        // Init editor
+        editors[i]['_quill-editor'] = new Quill(content, options)
+        editors[i].classList += ' quill-editor--active'
+      }
+    }
+
+    let formtastic = document.querySelector('form.formtastic')
+    if (formtastic) {
+      formtastic.onsubmit = () => {
+        for (let i = 0; i < editors.length; i++) {
+          let input = editors[i].querySelector('input[type="hidden"]')
+          if (editors[i]['_quill-editor'].editor.isBlank()) {
+            input.value = ''
+          } else {
+            input.value = editors[i]['_quill-editor'].root.innerHTML
+          }
+        }
+      };
     }
   }
 
-  var formtastic = document.querySelector('form.formtastic');
-  if(formtastic) {
-    formtastic.onsubmit = function() {
-      for(var i = 0; i < editors.length; i++) {
-        var input = editors[i].querySelector('input[type="hidden"]');
-        input.value = editors[i]['_quill-editor'].root.innerHTML;
+  function setupImageUploader(server_url, field_name) {
+    return {
+      upload: file => {
+        return new Promise((resolve, reject) => {
+          const formData = new FormData()
+          formData.append(field_name || 'file_upload', file)
+
+          fetch(server_url, {
+            body: formData,
+            headers: {
+              'X-CSRF-Token': document.querySelector('meta[name="csrf-token"]').getAttribute('content')
+            },
+            method: 'POST'
+          }).then(response => response.json())
+            .then(result => {
+              resolve(result.url);
+            })
+            .catch(error => {
+              reject('Upload failed')
+              console.error('Error: ', error)
+            })
+        })
       }
-    };
+    }
   }
-}
 
-$(document).ready( function() {
-  initQuillEditors();
-});
+  // --- events ------------------------------------------------------------------
+  $(document).ready(() => {
+    initQuillEditors()
+  })
 
-$(document).on('has_many_add:after', function() {
-  initQuillEditors();
-});
+  $(document).on('has_many_add:after', '.has_many_container', () => {
+    initQuillEditors()
+  })
+})()

data/app/assets/stylesheets/activeadmin/_quill_editor_input.scss

@@ -1,4 +1,11 @@
-body.active_admin .quill-editor {
+// reset internal elements
+.ql-editor * {
+  margin: initial;
+  padding: initial;
+  text-align: initial;
+}
+
+body.active_admin [data-aa-quill-editor] {
   display: inline-block;
   width: calc(80% - 2px);
 
@@ -23,13 +30,6 @@ body.active_admin .quill-editor {
     min-height: 150px;
     padding: 10px;
 
-    // reset internal elements
-    * {
-      margin: initial;
-      padding: initial;
-      text-align: initial;
-    }
-
     ol {
       list-style-type: decimal;
     }

data/app/assets/stylesheets/activeadmin/quill.imageUploader.min.css

@@ -0,0 +1,33 @@
+.image-uploading {
+  position: relative;
+  display: inline-block;
+}
+
+.image-uploading img {
+  max-width: 98% !important;
+  filter: blur(5px);
+  opacity: 0.3;
+}
+
+.image-uploading::before {
+  content: "";
+  box-sizing: border-box;
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  width: 30px;
+  height: 30px;
+  margin-top: -15px;
+  margin-left: -15px;
+  border-radius: 50%;
+  border: 3px solid #ccc;
+  border-top-color: #1e986c;
+  z-index: 1;
+  animation: spinner 0.6s linear infinite;
+}
+
+@keyframes spinner {
+  to {
+    transform: rotate(360deg);
+  }
+}

data/lib/activeadmin/quill_editor/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveAdmin
   module QuillEditor
-    VERSION = '0.2.8'
+    VERSION = '0.3.0'
   end
 end

data/lib/formtastic/inputs/quill_editor_input.rb

@@ -6,9 +6,9 @@ module Formtastic
       def to_html
         input_wrapping do
           label_html <<
-            template.content_tag(:div, input_html_options.merge(class: 'quill-editor')) do
+            template.content_tag(:div, input_html_options.merge('data-aa-quill-editor': '1')) do
               builder.hidden_field(input_name) <<
-                template.content_tag(:div, class: 'quill-editor-content') do
+                template.content_tag(:div, 'data-aa-quill-content': '1') do
                   object.send(method).try :html_safe
                 end
             end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin_quill_editor
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -159,11 +159,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/javascripts/activeadmin/quill.imageUploader.min.js
 - app/assets/javascripts/activeadmin/quill_editor/quill.core.js
 - app/assets/javascripts/activeadmin/quill_editor/quill.js
 - app/assets/javascripts/activeadmin/quill_editor/quill.min.js
 - app/assets/javascripts/activeadmin/quill_editor_input.js
 - app/assets/stylesheets/activeadmin/_quill_editor_input.scss
+- app/assets/stylesheets/activeadmin/quill.imageUploader.min.css
 - app/assets/stylesheets/activeadmin/quill_editor/quill.bubble.css
 - app/assets/stylesheets/activeadmin/quill_editor/quill.core.css
 - app/assets/stylesheets/activeadmin/quill_editor/quill.snow.css