activeadmin_froala_editor 0.2.4 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9749605f9f60196e6c2a7c5c4896dd542d0090d413efc70114005efa50756e8f
-  data.tar.gz: 31dd928db47987a934d114c200f6956a182191a009c8ba8e270f197f8294ea13
+  metadata.gz: e66d66d41a835a90bea94e459269eda888b2827a79212ee15e8ad19599601505
+  data.tar.gz: 2d4e2b1d9298f6694641564cdd599f5b5297b9d81c9e3672505c1d8e68c87ce7
 SHA512:
-  metadata.gz: '084f552b2767fd5266427a42ee7b480ff57ae7ab6115bea21603936e9d636e31f2557b6ea3e6cda1976803f88043822abbd7136290362676ab7555198cc07779'
-  data.tar.gz: 0740ba637e5b9cf2bf7403423775243db8132afd8f9e148196c8f3454c5081bc1f36100e7d557349e3644ea08bbd2cfd4cd63fecdd3c6d13b0237b457eaf0aae
+  metadata.gz: 1bb69003f8ed110ed582d1a44b27e8d97b72d04bc1fb1fd1989fb8d86ddbcaaeccdc6ad83ce3d2106c5a3d3081d3bf8f9db9e560c3af50125db104319d8ce1a9
+  data.tar.gz: 48a278d486e936ea5e8a11b8bc68ea3625a8083b0cc49582b4f19d4abe08f38ec2a4e6d656b805db5f52259b47412a8ad2b935f72b79f1c422ea6521b07764a2

data/README.md

@@ -23,11 +23,14 @@ Features:
 ```
 - Use the input with `as: :froala_editor` in Active Admin model conf
 
-## Options
-**data-options**: permits to set *froala editor* options directly - see [options list](https://www.froala.com/wysiwyg-editor/docs/options)
+## Notes
+- To use this plugins with Active Admin 1.x please use the version [0.1.3](https://github.com/blocknotes/activeadmin_froala_editor/releases/tag/v0.1.3)
+- **data-options**: permits to set *froala editor* options directly from the form field (examples below) - see [options list](https://www.froala.com/wysiwyg-editor/docs/options)
 
 ## Examples
 
+### Basic usage
+
 ```ruby
 # Active Admin article form conf:
   form do |f|
@@ -40,21 +43,35 @@ Features:
   end
 ```
 
-Toolbar buttons configuration:
+### Toolbar buttons configuration
 
 ```ruby
+# Form field
 f.input :description, as: :froala_editor, input_html: { data: { options: { toolbarButtons: ['undo', 'redo', '|', 'bold', 'italic'] } } }
 ```
 
-Froala upload plugin: for the relevant files of an upload example see [here](examples/upload_plugin_using_activestorage/).
+### Froala upload plugin
+
+```ruby
+# Upload method (to be included in the admin entity configuration)
+member_action :upload, method: [:post] do
+  success = resource.images.attach(params[:file_upload])
+  result = success ? { link: url_for(resource.images.last) } : {}
+  render json: result
+end
+```
+
+```ruby
+# Form field
+f.input :description, as: :froala_editor, input_html: { data: { options: { imageUploadParam: 'file_upload', imageUploadURL: upload_admin_post_path(resource.id), toolbarButtons: %w[bold italic underline | insertImage insertVideo insertFile] } } }
+```
+
+For the relevant files of an 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).
 
-## Notes
-- To use this plugins with Active Admin 1.x please use the version [0.1.3](https://github.com/blocknotes/activeadmin_froala_editor/releases/tag/v0.1.3)
-
 ## 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.
 
@@ -65,5 +82,6 @@ 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)
-- For Froala editor License: see [Froala website](https://froala.com/wysiwyg-editor/)
+The gem is available as open-source under the terms of the [MIT](LICENSE.txt).
+
+For Froala editor License: see [Froala website](https://froala.com/wysiwyg-editor/).

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

@@ -1,48 +1,54 @@
-function initFroalaEditors() {
-  $('.froala-editor').each(function () {
-    if(!$(this).hasClass('froala-editor--active')) {
-      var name = $(this).attr('name');
-      if(name) {
-        var options = {
-          quickInsertButtons: ['table', 'ol', 'ul', 'hr'],
-          requestHeaders: {
-            'X-CSRF-Token': $('meta[name="csrf-token"]').attr('content')
-          },
-          toolbarButtons: {
-            moreText: {
-              buttons: ['bold', 'italic', 'underline', 'strikeThrough', 'subscript', 'superscript', 'fontFamily', 'fontSize', 'textColor', 'backgroundColor', 'inlineClass', 'inlineStyle', 'clearFormatting'],
-              align: 'left',
-              buttonsVisible: 3
-            },
-            moreParagraph: {
-              buttons: ['alignLeft', 'alignCenter', 'formatOLSimple', 'alignRight', 'alignJustify', 'formatOL', 'formatUL', 'paragraphFormat', 'paragraphStyle', 'lineHeight', 'outdent', 'indent', 'quote'],
-              align: 'left',
-              buttonsVisible: 3
-            },
-            moreRich: {
-              buttons: ['insertLink', 'insertTable', 'emoticons', 'specialCharacters', 'insertHR'],
-              align: 'left',
-              buttonsVisible: 2
+(function () {
+  'use strict'
+
+  // --- functions -------------------------------------------------------------
+  function initFroalaEditors() {
+    $('[data-aa-froala-editor]').each(function () {
+      if (!$(this).hasClass('froala-editor--active')) {
+        let name = $(this).attr('name');
+        if (name) {
+          let options = {
+            quickInsertButtons: ['table', 'ol', 'ul', 'hr'],
+            requestHeaders: {
+              'X-CSRF-Token': $('meta[name="csrf-token"]').attr('content')
             },
-            moreMisc: {
-              buttons: ['undo', 'redo', 'print'],
-              align: 'right',
-              buttonsVisible: 3
+            toolbarButtons: {
+              moreText: {
+                buttons: ['bold', 'italic', 'underline', 'strikeThrough', 'subscript', 'superscript', 'fontFamily', 'fontSize', 'textColor', 'backgroundColor', 'inlineClass', 'inlineStyle', 'clearFormatting'],
+                align: 'left',
+                buttonsVisible: 3
+              },
+              moreParagraph: {
+                buttons: ['alignLeft', 'alignCenter', 'formatOLSimple', 'alignRight', 'alignJustify', 'formatOL', 'formatUL', 'paragraphFormat', 'paragraphStyle', 'lineHeight', 'outdent', 'indent', 'quote'],
+                align: 'left',
+                buttonsVisible: 3
+              },
+              moreRich: {
+                buttons: ['insertLink', 'insertTable', 'emoticons', 'specialCharacters', 'insertHR'],
+                align: 'left',
+                buttonsVisible: 2
+              },
+              moreMisc: {
+                buttons: ['undo', 'redo', 'print'],
+                align: 'right',
+                buttonsVisible: 3
+              }
             }
           }
-        };
-        options = $.extend({}, options, $(this).data('options'));
-        new FroalaEditor('.froala-editor[name="' + name + '"]', options);
-        $(this).addClass('froala-editor--active');
+          options = $.extend({}, options, $(this).data('options'))
+          new FroalaEditor('[data-aa-froala-editor][name="' + name + '"]', options)
+          $(this).addClass('froala-editor--active')
+        }
       }
-    }
-  });
-}
+    })
+  }
 
-$(document).on('has_many_add:after', function () {
-  initFroalaEditors();
-});
+  // --- events ----------------------------------------------------------------
+  $(document).ready(() => {
+    initFroalaEditors()
+  })
 
-$(document).ready( function() {
-  initFroalaEditors();
-});
+  $(document).on('has_many_add:after', '.has_many_container', () => {
+    initFroalaEditors()
+  })
+})()

data/lib/activeadmin/froala_editor/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveAdmin
   module FroalaEditor
-    VERSION = '0.2.4'
+    VERSION = '0.2.8'
   end
 end

data/lib/formtastic/inputs/froala_editor_input.rb

@@ -4,7 +4,7 @@ module Formtastic
   module Inputs
     class FroalaEditorInput < Formtastic::Inputs::TextInput
       def input_html_options
-        super.merge( class: 'froala-editor' )
+        super.merge('data-aa-froala-editor': '1')
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin_froala_editor
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.8
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin