@themarioga/grid-editor 5.1.2 → 5.2.0

package/src/js/plugins/grideditor.summernote.js

@@ -0,0 +1,93 @@
+/**
+ * Summernote for grid-editor's content areas.
+ *
+ * A text editor plugin: load this file after the editor, and summernote
+ * after or before it, and content_types: ['summernote'] edits each content
+ * area with summernote in air mode. What it can ask the editor for is the
+ * handle its factory is called with, described in docs/plugins.md.
+ *
+ *   <script src="summernote/summernote-bs5.min.js"></script>
+ *   <script src="dist/jquery.grideditor.min.js"></script>
+ *   <script src="dist/plugins/grideditor.summernote.min.js"></script>
+ *
+ * Up to 6.0 the main bundle carries a copy of this file too.
+ */
+(function($) {
+
+    var INITIAL_CONTENT = '<p>Lorem ipsum dolores</p>';
+
+    $.fn.gridEditor.texts.summernote = function(ge) {
+        return {
+            initialContent: INITIAL_CONTENT,
+            missingKey: 'error.summernote_missing',
+
+            available: function() { return !!$.fn.summernote; },
+
+            start: function(contentAreas) {
+                var settings = ge.settings;
+
+                // Summernote 0.9.1 calls $.now(), which jQuery 4 removed, and
+                // cannot open without it. Given back only where it is missing,
+                // and only once summernote is actually used.
+                if (!$.now) { $.now = Date.now; }
+
+                contentAreas.each(function() {
+                    var contentArea = $(this);
+                    if (contentArea.hasClass('active')) { return; }
+
+                    if (contentArea.html() == INITIAL_CONTENT) {
+                        contentArea.html('');
+                    }
+                    contentArea.addClass('active');
+
+                    var configuration = $.extend(
+                        true, // deep copy
+                        {},
+                        (settings.summernote && settings.summernote.config ? settings.summernote.config : {}),
+                        {
+                            tabsize: 2,
+                            airMode: true,
+                            // Focus editor on creation
+                            callbacks: {
+                                onInit: function() {
+
+                                    // Call original oninit function, if one was passed in the config
+                                    var callback;
+                                    try {
+                                        callback = settings.summernote.config.callbacks.onInit;
+                                    } catch (err) {
+                                        // No callback passed
+                                    }
+                                    if (callback) {
+                                        callback.call(this);
+                                    }
+
+                                    // The editor owns what is inside the
+                                    // content area now, so the grid editor is
+                                    // told to put its own furniture back
+                                    ge.textReady(contentArea);
+
+                                    contentArea.summernote('focus');
+                                }
+                            }
+                        }
+                    );
+                    contentArea.summernote(configuration);
+                });
+            },
+
+            stop: function(contentAreas) {
+                contentAreas.filter('.active').each(function() {
+                    var contentArea = $(this);
+                    contentArea.summernote('destroy');
+                    contentArea
+                        .removeClass('active')
+                        .removeAttr('id')
+                        .removeAttr('style')
+                        .removeAttr('spellcheck')
+                    ;
+                });
+            },
+        };
+    };
+})(jQuery);

package/src/js/plugins/grideditor.tinymce.js

@@ -0,0 +1,157 @@
+/**
+ * tinyMCE for grid-editor's content areas.
+ *
+ * A text editor plugin: load this file after the editor, and tinyMCE 6
+ * after or before it, and content_types: ['tinymce'] edits each content area
+ * with an inline tinyMCE. What it can ask the editor for is the handle its
+ * factory is called with, described in docs/plugins.md.
+ *
+ *   <script src="tinymce/tinymce.min.js"></script>
+ *   <script src="dist/jquery.grideditor.min.js"></script>
+ *   <script src="dist/plugins/grideditor.tinymce.min.js"></script>
+ *
+ * Up to 6.0 the main bundle carries a copy of this file too.
+ */
+(function($) {
+
+    // tinyMCE snapshots the target element's attributes when an inline editor is
+    // created and restores them on remove(), so this has to run *after* remove()
+    // to keep the grid editor's own class and tinyMCE's leftovers off the element.
+    function cleanUp(contentArea) {
+        contentArea
+            .removeClass('active')
+            .removeClass('ge-rte-active')
+            .removeAttr('id')
+            .removeAttr('style')
+            .removeAttr('spellcheck')
+            .removeAttr('contenteditable')
+            .removeAttr('data-mce-style')
+        ;
+    }
+
+    var INITIAL_CONTENT = '<p>Lorem ipsum dolores</p>';
+
+    $.fn.gridEditor.texts.tinymce = function(ge) {
+        return {
+            initialContent: INITIAL_CONTENT,
+            missingKey: 'error.tinymce_missing',
+
+            available: function() { return !!window.tinymce; },
+
+            start: function(contentAreas) {
+                var settings = ge.settings;
+                var userConfig = (settings.tinymce && settings.tinymce.config) ? settings.tinymce.config : {};
+
+                contentAreas.each(function() {
+                    var contentArea = $(this);
+                    if (contentArea.hasClass('active')) { return; }
+
+                    if (contentArea.html() == INITIAL_CONTENT) {
+                        contentArea.html('');
+                    }
+                    contentArea.addClass('active');
+
+                    var configuration = $.extend({
+                        // tinyMCE's own "Upgrade" badge in the menubar. Off by
+                        // default because an inline editor here is a column of
+                        // someone's page, not tinyMCE's own interface; a host that
+                        // wants it back passes promotion: true.
+                        promotion: false,
+                    }, userConfig, {
+                        target: this,
+                        inline: true,
+                        init_instance_callback: function(editor) {
+                            // deinit ran before this init finished, so tear it down again
+                            if (contentArea.data('ge-tinymce-pending-remove')) {
+                                contentArea.removeData('ge-tinymce-pending-remove');
+                                editor.remove();
+                                // deinit already ran and cannot clean up after this
+                                // late remove(), so do it here instead
+                                cleanUp(contentArea);
+                                return;
+                            }
+
+                            contentArea.data('ge-tinymce', editor);
+
+                            // The editor rewrote what is inside this content area
+                            // while it took it over, so whatever the grid editor
+                            // had in there is gone. Saying so lets it put its own
+                            // furniture back.
+                            ge.textReady(contentArea);
+
+                            // Undo and redo rewrite it too, from snapshots that
+                            // leave out whatever is marked data-mce-bogus - an
+                            // element's drawer among them - so it goes back in
+                            // after each of those as well
+                            editor.on('Undo Redo', function() {
+                                ge.textReady(contentArea);
+                            });
+
+                            // The inline toolbar is laid out against the element's
+                            // geometry at the moment tinyMCE draws it, and an
+                            // element that has just appeared - a tab pane, an
+                            // accordion body, a column whose width is still
+                            // settling - may not have its own width yet. Asking
+                            // for the ui again once the browser has laid the frame
+                            // out measures it as it now is, instead of leaving a
+                            // toolbar wrapped into a narrow column.
+                            window.requestAnimationFrame(function() {
+                                if (editor.removed || !editor.ui || !editor.ui.show) { return; }
+
+                                editor.ui.show();
+                            });
+
+                            // And again whenever the user comes back to this
+                            // editor: by then the element may have been resized,
+                            // hidden and shown again - a tab switched away from
+                            // and back, a column made narrower - and the toolbar
+                            // is only ever as right as its last measurement.
+                            editor.on('focus', function() {
+                                window.requestAnimationFrame(function() {
+                                    if (editor.removed || !editor.ui || !editor.ui.show) { return; }
+
+                                    editor.ui.show();
+                                });
+                            });
+
+                            // Bring focus to text field
+                            editor.focus();
+
+                            // Call the original callbacks, if any were passed in the config
+                            if (userConfig.init_instance_callback) {
+                                userConfig.init_instance_callback.call(this, editor);
+                            }
+                            // 'oninit' is the pre-6 name, honoured so existing configs keep working
+                            if (userConfig.oninit) {
+                                userConfig.oninit.call(this, editor);
+                            }
+                        }
+                    });
+                    // We always edit the element we were handed, so a selector in the
+                    // user config would only fight with target
+                    delete configuration.selector;
+
+                    window.tinymce.init(configuration);
+                });
+            },
+
+            stop: function(contentAreas) {
+                contentAreas.filter('.active').each(function() {
+                    var contentArea = $(this);
+                    var editor = contentArea.data('ge-tinymce');
+
+                    if (editor) {
+                        contentArea.removeData('ge-tinymce');
+                        editor.remove();
+                    } else {
+                        // tinymce.init() is asynchronous, so the editor may not exist
+                        // yet. Leave a note for init_instance_callback to remove it.
+                        contentArea.data('ge-tinymce-pending-remove', true);
+                    }
+
+                    cleanUp(contentArea);
+                });
+            },
+        };
+    };
+})(jQuery);

package/src/js/jquery.grideditor.ckeditor.js

@@ -1,77 +0,0 @@
-(function($) {
-    $.fn.gridEditor.RTEs.ckeditor = {
-
-        init: function(settings, contentAreas) {
-
-            if (!window.CKEDITOR) {
-                console.error($.fn.gridEditor.t(settings, 'error.ckeditor_missing'));
-            }
-
-            var self = this;
-            contentAreas.each(function() {
-                var contentArea = $(this);
-                if (!contentArea.hasClass('active')) {
-                    if (contentArea.html() == self.initialContent) {
-                        // CKEditor kills this '&nbsp' creating a non usable box :/ 
-                        contentArea.html(' '); 
-                    }
-                    
-                    // Add the .attr('contenteditable',''true') or CKEditor loads readonly
-                    contentArea.addClass('active').attr('contenteditable', 'true');
-                    
-                    var configuration = $.extend(
-                        {},
-                        (settings.ckeditor && settings.ckeditor.config ? settings.ckeditor.config : {}), 
-                        {
-                            // Focus editor on creation
-                            on: {
-                                instanceReady: function( evt ) {
-                                    // Call original instanceReady function, if one was passed in the config
-                                    var callback;
-                                    try {
-                                        callback = settings.ckeditor.config.on.instanceReady;
-                                    } catch (err) {
-                                        // No callback passed
-                                    }
-                                    if (callback) {
-                                        callback.call(this, evt);
-                                    }
-
-                                    // The editor owns what is inside the
-                                    // content area now, so the grid editor is
-                                    // told to put its own furniture back
-                                    contentArea.trigger('ge-rte-ready');
-
-                                    instance.focus();
-                                }
-                            }
-                        }
-                    );
-                    var instance = CKEDITOR.inline(contentArea.get(0), configuration);
-                }
-            });
-        },
-
-        deinit: function(settings, contentAreas) {
-            contentAreas.filter('.active').each(function() {
-                var contentArea = $(this);
-                
-                // Destroy all CKEditor instances
-                $.each(CKEDITOR.instances, function(_, instance) {
-                    instance.destroy();
-                });
-
-                // Cleanup
-                contentArea
-                    .removeClass('active cke_focus')
-                    .removeAttr('id')
-                    .removeAttr('style')
-                    .removeAttr('spellcheck')
-                    .removeAttr('contenteditable')
-                ;
-            });
-        },
-
-        initialContent: '<p>Lorem initius... </p>',
-    };
-})(jQuery);

package/src/js/jquery.grideditor.summernote.js

@@ -1,72 +0,0 @@
-(function($) {
-
-    $.fn.gridEditor.RTEs.summernote = {
-
-        init: function(settings, contentAreas) {
-            
-            if (!jQuery().summernote) {
-                console.error($.fn.gridEditor.t(settings, 'error.summernote_missing'));
-            }
-
-            var self = this;
-            contentAreas.each(function() {
-                var contentArea = $(this);
-                if (!contentArea.hasClass('active')) {
-                    if (contentArea.html() == self.initialContent) {
-                        contentArea.html('');
-                    }
-                    contentArea.addClass('active');
-
-                    var configuration = $.extend(
-                        true, // deep copy
-                        {},
-                        (settings.summernote && settings.summernote.config ? settings.summernote.config : {}),
-                        {
-                            tabsize: 2,
-                            airMode: true,
-                            // Focus editor on creation
-                            callbacks: {
-                                onInit: function() {
-                                    
-                                    // Call original oninit function, if one was passed in the config
-                                    var callback;
-                                    try {
-                                        callback = settings.summernote.config.callbacks.onInit;
-                                    } catch (err) {
-                                        // No callback passed
-                                    }
-                                    if (callback) {
-                                        callback.call(this);
-                                    }
-
-                                    // The editor owns what is inside the
-                                    // content area now, so the grid editor is
-                                    // told to put its own furniture back
-                                    contentArea.trigger('ge-rte-ready');
-                                    
-                                    contentArea.summernote('focus');
-                                }
-                            }
-                        }
-                    );
-                    contentArea.summernote(configuration);
-                }
-            });
-        },
-
-        deinit: function(settings, contentAreas) {
-            contentAreas.filter('.active').each(function() {
-                var contentArea = $(this);
-                contentArea.summernote('destroy');
-                contentArea
-                    .removeClass('active')
-                    .removeAttr('id')
-                    .removeAttr('style')
-                    .removeAttr('spellcheck')
-                ;
-            });
-        },
-
-        initialContent: '<p>Lorem ipsum dolores</p>',
-    };
-})(jQuery);

package/src/js/jquery.grideditor.tinymce.js

@@ -1,143 +0,0 @@
-(function($) {
-
-    // tinyMCE snapshots the target element's attributes when an inline editor is
-    // created and restores them on remove(), so this has to run *after* remove()
-    // to keep the grid editor's own class and tinyMCE's leftovers off the element.
-    function cleanUp(contentArea) {
-        contentArea
-            .removeClass('active')
-            .removeClass('ge-rte-active')
-            .removeAttr('id')
-            .removeAttr('style')
-            .removeAttr('spellcheck')
-            .removeAttr('contenteditable')
-            .removeAttr('data-mce-style')
-        ;
-    }
-
-    $.fn.gridEditor.RTEs.tinymce = {
-
-        init: function(settings, contentAreas) {
-
-            if (!window.tinymce) {
-                console.error($.fn.gridEditor.t(settings, 'error.tinymce_missing'));
-                return;
-            }
-
-            var self = this;
-            var userConfig = (settings.tinymce && settings.tinymce.config) ? settings.tinymce.config : {};
-
-            contentAreas.each(function() {
-                var contentArea = $(this);
-                if (contentArea.hasClass('active')) { return; }
-
-                if (contentArea.html() == self.initialContent) {
-                    contentArea.html('');
-                }
-                contentArea.addClass('active');
-
-                var configuration = $.extend({
-                    // tinyMCE's own "Upgrade" badge in the menubar. Off by
-                    // default because an inline editor here is a column of
-                    // someone's page, not tinyMCE's own interface; a host that
-                    // wants it back passes promotion: true.
-                    promotion: false,
-                }, userConfig, {
-                    target: this,
-                    inline: true,
-                    init_instance_callback: function(editor) {
-                        // deinit ran before this init finished, so tear it down again
-                        if (contentArea.data('ge-tinymce-pending-remove')) {
-                            contentArea.removeData('ge-tinymce-pending-remove');
-                            editor.remove();
-                            // deinit already ran and cannot clean up after this
-                            // late remove(), so do it here instead
-                            cleanUp(contentArea);
-                            return;
-                        }
-
-                        contentArea.data('ge-tinymce', editor);
-
-                        // The editor rewrote what is inside this content area
-                        // while it took it over, so whatever the grid editor
-                        // had in there is gone. Saying so lets it put its own
-                        // furniture back (see RTE_READY in the core).
-                        contentArea.trigger('ge-rte-ready');
-
-                        // Undo and redo rewrite it too, from snapshots that
-                        // leave out whatever is marked data-mce-bogus - an
-                        // element's drawer among them - so it goes back in
-                        // after each of those as well
-                        editor.on('Undo Redo', function() {
-                            contentArea.trigger('ge-rte-ready');
-                        });
-
-                        // The inline toolbar is laid out against the element's
-                        // geometry at the moment tinyMCE draws it, and an
-                        // element that has just appeared - a tab pane, an
-                        // accordion body, a column whose width is still
-                        // settling - may not have its own width yet. Asking
-                        // for the ui again once the browser has laid the frame
-                        // out measures it as it now is, instead of leaving a
-                        // toolbar wrapped into a narrow column.
-                        window.requestAnimationFrame(function() {
-                            if (editor.removed || !editor.ui || !editor.ui.show) { return; }
-
-                            editor.ui.show();
-                        });
-
-                        // And again whenever the user comes back to this
-                        // editor: by then the element may have been resized,
-                        // hidden and shown again - a tab switched away from
-                        // and back, a column made narrower - and the toolbar
-                        // is only ever as right as its last measurement.
-                        editor.on('focus', function() {
-                            window.requestAnimationFrame(function() {
-                                if (editor.removed || !editor.ui || !editor.ui.show) { return; }
-
-                                editor.ui.show();
-                            });
-                        });
-
-                        // Bring focus to text field
-                        editor.focus();
-
-                        // Call the original callbacks, if any were passed in the config
-                        if (userConfig.init_instance_callback) {
-                            userConfig.init_instance_callback.call(this, editor);
-                        }
-                        // 'oninit' is the pre-6 name, honoured so existing configs keep working
-                        if (userConfig.oninit) {
-                            userConfig.oninit.call(this, editor);
-                        }
-                    }
-                });
-                // We always edit the element we were handed, so a selector in the
-                // user config would only fight with target
-                delete configuration.selector;
-
-                window.tinymce.init(configuration);
-            });
-        },
-
-        deinit: function(settings, contentAreas) {
-            contentAreas.filter('.active').each(function() {
-                var contentArea = $(this);
-                var editor = contentArea.data('ge-tinymce');
-
-                if (editor) {
-                    contentArea.removeData('ge-tinymce');
-                    editor.remove();
-                } else {
-                    // tinymce.init() is asynchronous, so the editor may not exist
-                    // yet. Leave a note for init_instance_callback to remove it.
-                    contentArea.data('ge-tinymce-pending-remove', true);
-                }
-
-                cleanUp(contentArea);
-            });
-        },
-
-        initialContent: '<p>Lorem ipsum dolores</p>',
-    };
-})(jQuery);