@oat-sa/tao-core-ui 1.60.2 → 1.61.0

package/src/inplacer.js

@@ -1,316 +1,316 @@
-/**
- * @author Bertrand Chevrier <bertrand@taotesting.com>
- * @requires jquery
- * @requires core/pluginifier
- * @requires core/dataattrhandler
- */
-import $ from 'jquery';
-import _ from 'lodash';
-import Pluginifier from 'core/pluginifier';
-import DataAttrHandler from 'core/dataattrhandler';
-
-var ns = 'inplacer';
-var dataNs = 'ui.' + ns;
-
-var defaults = {
-    disableClass: 'disabled',
-    bindEvent: 'click',
-    inplaceClass: 'inplace',
-    mapping: {
-        textarea: ['p', 'div']
-        //input otherwise
-    }
-};
-
-/**
- * Get the element text but not the text of children
- * @param {jQueryElement} $elt - the element to get the text from
- * @returns {String} the content
- */
-
-function getText($elt) {
-    var text = '';
-    $elt.contents().filter(function() {
-        if (this.nodeType === Node.TEXT_NODE && $.trim(this.nodeValue) !== '') {
-            text += $.trim(this.nodeValue);
-        }
-    });
-    return text;
-}
-
-/**
- * Set the element text without removing children
- * @param {jQueryElement} $elt - the element to set the text to
- * @param {String} text - the content to set
- */
-
-function setText($elt, text) {
-    var set = false;
-    $elt.contents().filter(function() {
-        if (this.nodeType === Node.TEXT_NODE && set === false) {
-            set = true;
-            this.nodeValue = text;
-            return;
-        }
-    });
-    if (set === false) {
-        $elt.prepend(text);
-    }
-}
-
-/**
- * Empty the text node of the element
- * @param {jQueryElement} $elt - the element to set the text to
- */
-function emptyText($elt) {
-    var set = false;
-    $elt.contents().filter(function() {
-        if (this.nodeType === Node.TEXT_NODE) {
-            this.nodeValue = '';
-        }
-    });
-}
-/**
- * The InPlacer component,
- * @exports ui/inplacer
- */
-var InPlacer = {
-    /**
-     * Initialize the plugin.
-     *
-     * Called the jQuery way once registered by the Pluginifier.
-     * @example $('selector').inplacer({target : $('target') });
-     * @public
-     *
-     * @constructor
-     * @param {Object} options - the plugin options
-     * @param {jQueryElement} options.target - the element to be toggled
-     * @param {string|boolean} [options.bindEvent = 'click'] - the event that trigger the toggling
-     * @param {string} [options.openedClass = 'opened'] - the css added to element (not the target) for the opened state
-     * @param {string} [options.closedClass = 'closed'] - the css added to element (not the target) for the closed state
-     * @fires InPlacer#create.inplacer
-     * @returns {jQueryElement} for chaining
-     */
-    init: function(options) {
-        //get options using default
-        options = $.extend(true, {}, defaults, options);
-
-        return this.each(function() {
-            var $elt = $(this);
-
-            if (!$elt.data(dataNs)) {
-                var $target = options.target;
-
-                if (!/^#/.test($target.selector)) {
-                    $.error('The target selector must referr to the of an element id or to the element to create.');
-                }
-
-                if ($target.length === 0) {
-                    //add an hidden field next to the edited element
-                    $elt.after("<input id='" + $target.selector.replace('#', '') + "' type='hidden' />");
-                    options.target = $($target.selector);
-                } else if ($target.prop('tagName') !== 'INPUT') {
-                    $.error('The target must be an input element.');
-                }
-
-                //add data to the element
-                $elt.data(dataNs, options);
-
-                $elt.addClass(options.inplaceClass);
-
-                InPlacer._sync($elt, $target);
-
-                //bind an event to trigger the toggling
-                if (options.bindEvent !== false) {
-                    $elt.on(options.bindEvent, function(e) {
-                        if ($elt.children(':text').length === 0) {
-                            e.preventDefault();
-                            InPlacer._edit($elt);
-                        }
-                    });
-                }
-
-                /**
-                 * The plugin have been created.
-                 * @event InPlacer#create.inplacer
-                 */
-                $elt.trigger('create.' + ns);
-            }
-        });
-    },
-
-    /**
-     * Toggle state.
-     *
-     * Called the jQuery way once registered by the Pluginifier.
-     * @example $('selector').inplacer('toggle');
-     * @param {jQueryElement} $elt - plugin's element
-     * @fires InPlacer#toggle.inplacer
-     */
-    _toggle: function($elt) {
-        if ($elt.children(':text').length > 0) {
-            this._leave($elt);
-        } else {
-            this._edit($elt);
-        }
-    },
-
-    /**
-     * Change the state to the edit mode.
-     *
-     * Called the jQuery way once registered by the Pluginifier.
-     * @example $('selector').inplacer('edit');
-     * @param {jQueryElement} $elt - plugin's element
-     * @fires InPlacer#edit.inplacer
-     */
-    _edit: function($elt) {
-        var self = this;
-        var options = $elt.data(dataNs);
-        var $target = options.target;
-        var text = getText($elt);
-        var width = options.width || $elt.width() + 'px';
-        var $editor;
-        emptyText($elt);
-        if (_.contains(options.mapping.textarea, $elt.prop('tagName').toLowerCase())) {
-            var height = options.height || $elt.height() + 'px';
-            $editor = $elt
-                .append('<textarea>' + text + '</textarea>')
-                .children(':input')
-                .width(width)
-                .height(height);
-        } else {
-            //set focus before adding text allow focus in the end of the text
-            $editor = $elt
-                .prepend($('<input>', { type: 'text' }))
-                .children(':input')
-                .width(width)
-                .focus()
-                .val(text);
-        }
-
-        $editor
-            .off('click')
-            .change(function(e) {
-                e.stopPropagation(); //the change evt is triggered on the top element on leaving
-            })
-            .keyup(function(e) {
-                if (e.which === 13) {
-                    self._leave($elt);
-                }
-            })
-            .blur(function() {
-                self._leave($elt);
-            })
-            .focus();
-
-        self._sync($elt, $target);
-
-        /**
-         * The element is in edit state
-         * @event InPlacer#edit.inplacer
-         * @param {string} value - the current value
-         */
-        $elt.trigger('edit.' + ns, [$target.val()]);
-    },
-
-    /**
-     * Leave the edit mode to the normal mode.
-     *
-     * Called the jQuery way once registered by the Pluginifier.
-     * @example $('selector').inplacer('_leave');
-     * @param {jQueryElement} $elt - plugin's element
-     * @fires InPlacer#leave.inplacer
-     */
-    _leave: function($elt) {
-        var options = $elt.data(dataNs);
-        var $target = options.target;
-        var $input = $elt.children(':input');
-        var content = $input.val();
-
-        $input.remove();
-
-        setText($elt, content);
-
-        this._sync($elt, $target);
-
-        /**
-         * The target has been toggled.
-         * @event InPlacer#leave.inplacer
-         * @param {string} value - the current value
-         */
-        $elt.trigger('leave.' + ns, [$target.val()]);
-        $elt.trigger('change');
-    },
-
-    /**
-     * Keep the the target and the element value in sync.
-     *
-     * @private
-     * @param {jQueryElement} $elt - plugin's element
-     * @param {jQueryElement} $target - the target to be in sync with
-     */
-    _sync: function($elt, $target) {
-        if ($elt.children(':text').length > 0) {
-            $target.val($elt.children(':text').val());
-        } else {
-            $target.val(getText($elt));
-        }
-    },
-
-    /**
-     * Destroy completely the plugin.
-     *
-     * Called the jQuery way once registered by the Pluginifier.
-     * @example $('selector').inplacer('destroy');
-     * @public
-     */
-    destroy: function() {
-        this.each(function() {
-            var $elt = $(this);
-            var options = $elt.data(dataNs);
-            $elt.removeClass(options.inplaceClass);
-            if (options.bindEvent !== false) {
-                $elt.off(options.bindEvent);
-            }
-            $elt.removeData(dataNs);
-            /**
-             * The plugin have been destroyed.
-             * @event InPlacer#destroy.inplacer
-             */
-            $elt.trigger('destroy.' + ns);
-        });
-    }
-};
-
-//Register the inplacer to behave as a jQuery plugin.
-Pluginifier.register(ns, InPlacer, {
-    expose: ['toggle', 'leave', 'edit']
-});
-
-/**
- * The only exposed function is used to start listening on data-attr
- *
- * @public
- * @example define(['ui/inplacer'], function(inplacer){ inplacer($('rootContainer')); });
- * @param {jQueryElement} $container - the root context to listen in
- */
-export default function listenDataAttr($container) {
-    new DataAttrHandler('in-place', {
-        container: $container,
-        listenerEvent: 'click',
-        namespace: dataNs
-    })
-        .init(function($elt, $target) {
-            var options = {
-                target: $target,
-                bindEvent: false
-            };
-            if ($elt.data('width')) {
-                options.width = $elt.data('width');
-            }
-            $elt.inplacer(options);
-        })
-        .trigger(function($elt) {
-            $elt.inplacer('toggle');
-        });
-}
+/**
+ * @author Bertrand Chevrier <bertrand@taotesting.com>
+ * @requires jquery
+ * @requires core/pluginifier
+ * @requires core/dataattrhandler
+ */
+import $ from 'jquery';
+import _ from 'lodash';
+import Pluginifier from 'core/pluginifier';
+import DataAttrHandler from 'core/dataattrhandler';
+
+var ns = 'inplacer';
+var dataNs = 'ui.' + ns;
+
+var defaults = {
+    disableClass: 'disabled',
+    bindEvent: 'click',
+    inplaceClass: 'inplace',
+    mapping: {
+        textarea: ['p', 'div']
+        //input otherwise
+    }
+};
+
+/**
+ * Get the element text but not the text of children
+ * @param {jQueryElement} $elt - the element to get the text from
+ * @returns {String} the content
+ */
+
+function getText($elt) {
+    var text = '';
+    $elt.contents().filter(function() {
+        if (this.nodeType === Node.TEXT_NODE && $.trim(this.nodeValue) !== '') {
+            text += $.trim(this.nodeValue);
+        }
+    });
+    return text;
+}
+
+/**
+ * Set the element text without removing children
+ * @param {jQueryElement} $elt - the element to set the text to
+ * @param {String} text - the content to set
+ */
+
+function setText($elt, text) {
+    var set = false;
+    $elt.contents().filter(function() {
+        if (this.nodeType === Node.TEXT_NODE && set === false) {
+            set = true;
+            this.nodeValue = text;
+            return;
+        }
+    });
+    if (set === false) {
+        $elt.prepend(text);
+    }
+}
+
+/**
+ * Empty the text node of the element
+ * @param {jQueryElement} $elt - the element to set the text to
+ */
+function emptyText($elt) {
+    var set = false;
+    $elt.contents().filter(function() {
+        if (this.nodeType === Node.TEXT_NODE) {
+            this.nodeValue = '';
+        }
+    });
+}
+/**
+ * The InPlacer component,
+ * @exports ui/inplacer
+ */
+var InPlacer = {
+    /**
+     * Initialize the plugin.
+     *
+     * Called the jQuery way once registered by the Pluginifier.
+     * @example $('selector').inplacer({target : $('target') });
+     * @public
+     *
+     * @constructor
+     * @param {Object} options - the plugin options
+     * @param {jQueryElement} options.target - the element to be toggled
+     * @param {string|boolean} [options.bindEvent = 'click'] - the event that trigger the toggling
+     * @param {string} [options.openedClass = 'opened'] - the css added to element (not the target) for the opened state
+     * @param {string} [options.closedClass = 'closed'] - the css added to element (not the target) for the closed state
+     * @fires InPlacer#create.inplacer
+     * @returns {jQueryElement} for chaining
+     */
+    init: function(options) {
+        //get options using default
+        options = $.extend(true, {}, defaults, options);
+
+        return this.each(function() {
+            var $elt = $(this);
+
+            if (!$elt.data(dataNs)) {
+                var $target = options.target;
+
+                if (!/^#/.test($target.selector)) {
+                    $.error('The target selector must referr to the of an element id or to the element to create.');
+                }
+
+                if ($target.length === 0) {
+                    //add an hidden field next to the edited element
+                    $elt.after("<input id='" + $target.selector.replace('#', '') + "' type='hidden' />");
+                    options.target = $($target.selector);
+                } else if ($target.prop('tagName') !== 'INPUT') {
+                    $.error('The target must be an input element.');
+                }
+
+                //add data to the element
+                $elt.data(dataNs, options);
+
+                $elt.addClass(options.inplaceClass);
+
+                InPlacer._sync($elt, $target);
+
+                //bind an event to trigger the toggling
+                if (options.bindEvent !== false) {
+                    $elt.on(options.bindEvent, function(e) {
+                        if ($elt.children(':text').length === 0) {
+                            e.preventDefault();
+                            InPlacer._edit($elt);
+                        }
+                    });
+                }
+
+                /**
+                 * The plugin have been created.
+                 * @event InPlacer#create.inplacer
+                 */
+                $elt.trigger('create.' + ns);
+            }
+        });
+    },
+
+    /**
+     * Toggle state.
+     *
+     * Called the jQuery way once registered by the Pluginifier.
+     * @example $('selector').inplacer('toggle');
+     * @param {jQueryElement} $elt - plugin's element
+     * @fires InPlacer#toggle.inplacer
+     */
+    _toggle: function($elt) {
+        if ($elt.children(':text').length > 0) {
+            this._leave($elt);
+        } else {
+            this._edit($elt);
+        }
+    },
+
+    /**
+     * Change the state to the edit mode.
+     *
+     * Called the jQuery way once registered by the Pluginifier.
+     * @example $('selector').inplacer('edit');
+     * @param {jQueryElement} $elt - plugin's element
+     * @fires InPlacer#edit.inplacer
+     */
+    _edit: function($elt) {
+        var self = this;
+        var options = $elt.data(dataNs);
+        var $target = options.target;
+        var text = getText($elt);
+        var width = options.width || $elt.width() + 'px';
+        var $editor;
+        emptyText($elt);
+        if (_.contains(options.mapping.textarea, $elt.prop('tagName').toLowerCase())) {
+            var height = options.height || $elt.height() + 'px';
+            $editor = $elt
+                .append('<textarea>' + text + '</textarea>')
+                .children(':input')
+                .width(width)
+                .height(height);
+        } else {
+            //set focus before adding text allow focus in the end of the text
+            $editor = $elt
+                .prepend($('<input>', { type: 'text' }))
+                .children(':input')
+                .width(width)
+                .focus()
+                .val(text);
+        }
+
+        $editor
+            .off('click')
+            .change(function(e) {
+                e.stopPropagation(); //the change evt is triggered on the top element on leaving
+            })
+            .keyup(function(e) {
+                if (e.which === 13) {
+                    self._leave($elt);
+                }
+            })
+            .blur(function() {
+                self._leave($elt);
+            })
+            .focus();
+
+        self._sync($elt, $target);
+
+        /**
+         * The element is in edit state
+         * @event InPlacer#edit.inplacer
+         * @param {string} value - the current value
+         */
+        $elt.trigger('edit.' + ns, [$target.val()]);
+    },
+
+    /**
+     * Leave the edit mode to the normal mode.
+     *
+     * Called the jQuery way once registered by the Pluginifier.
+     * @example $('selector').inplacer('_leave');
+     * @param {jQueryElement} $elt - plugin's element
+     * @fires InPlacer#leave.inplacer
+     */
+    _leave: function($elt) {
+        var options = $elt.data(dataNs);
+        var $target = options.target;
+        var $input = $elt.children(':input');
+        var content = $input.val();
+
+        $input.remove();
+
+        setText($elt, content);
+
+        this._sync($elt, $target);
+
+        /**
+         * The target has been toggled.
+         * @event InPlacer#leave.inplacer
+         * @param {string} value - the current value
+         */
+        $elt.trigger('leave.' + ns, [$target.val()]);
+        $elt.trigger('change');
+    },
+
+    /**
+     * Keep the the target and the element value in sync.
+     *
+     * @private
+     * @param {jQueryElement} $elt - plugin's element
+     * @param {jQueryElement} $target - the target to be in sync with
+     */
+    _sync: function($elt, $target) {
+        if ($elt.children(':text').length > 0) {
+            $target.val($elt.children(':text').val());
+        } else {
+            $target.val(getText($elt));
+        }
+    },
+
+    /**
+     * Destroy completely the plugin.
+     *
+     * Called the jQuery way once registered by the Pluginifier.
+     * @example $('selector').inplacer('destroy');
+     * @public
+     */
+    destroy: function() {
+        this.each(function() {
+            var $elt = $(this);
+            var options = $elt.data(dataNs);
+            $elt.removeClass(options.inplaceClass);
+            if (options.bindEvent !== false) {
+                $elt.off(options.bindEvent);
+            }
+            $elt.removeData(dataNs);
+            /**
+             * The plugin have been destroyed.
+             * @event InPlacer#destroy.inplacer
+             */
+            $elt.trigger('destroy.' + ns);
+        });
+    }
+};
+
+//Register the inplacer to behave as a jQuery plugin.
+Pluginifier.register(ns, InPlacer, {
+    expose: ['toggle', 'leave', 'edit']
+});
+
+/**
+ * The only exposed function is used to start listening on data-attr
+ *
+ * @public
+ * @example define(['ui/inplacer'], function(inplacer){ inplacer($('rootContainer')); });
+ * @param {jQueryElement} $container - the root context to listen in
+ */
+export default function listenDataAttr($container) {
+    new DataAttrHandler('in-place', {
+        container: $container,
+        listenerEvent: 'click',
+        namespace: dataNs
+    })
+        .init(function($elt, $target) {
+            var options = {
+                target: $target,
+                bindEvent: false
+            };
+            if ($elt.data('width')) {
+                options.width = $elt.data('width');
+            }
+            $elt.inplacer(options);
+        })
+        .trigger(function($elt) {
+            $elt.inplacer('toggle');
+        });
+}