@oat-sa/tao-core-ui 1.64.2 → 1.65.0

package/src/groupedComboBox.js

@@ -1,99 +1,99 @@
-/**
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; under version 2
- * of the License (non-upgradable).
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
- *
- * Copyright (c) 2015 (original work) Open Assessment Technologies SA ;
- */
-import $ from 'jquery';
-import _ from 'lodash';
-import __ from 'i18n';
-import component from 'ui/component';
-import selectTpl from 'ui/bulkActionPopup/tpl/select';
-import 'select2';
-
-var selectedValues = {};
-
-/**
- * Create a combobox and initialize it with select2
- *
- * @param {Number} level
- * @param {array} categoriesDefinitions - the array that defines the number and config for each level of combobox cascade
- * @param {array} categories - the array that contains nested array of categories
- * @param {array} selected - the array that contains options selected
- * @returns {jQuery}
- */
-function createCombobox(level, categoriesDefinitions, categories, selected) {
-    if (categoriesDefinitions[level] && categories[level]) {
-        selected = selected || [];
-        const categoryDef = categoriesDefinitions[level];
-        let $comboBox;
-        if (categoryDef.id) {
-            //init <select> DOM element
-            $comboBox = $(
-                selectTpl({
-                    comboboxId: categoryDef.id,
-                    comboboxLabel: categoryDef.label || '',
-                    options: categories[level]
-                })
-            );
-
-            $comboBox.find('select').val(selected[level] || '');
-
-            //add event handler
-            $comboBox.on('change', function () {
-                var $selected = $comboBox.find(':selected');
-                selectedValues[categoryDef.id] = $selected.val();
-                //trigger event
-                $comboBox.trigger('selected.cascading-combobox', [selectedValues]);
-            });
-
-            //init select 2 on $comboBox
-            $comboBox.find('select').select2({
-                allowClear: true,
-                dropdownAutoWidth: true,
-                placeholder: categoryDef.placeholder || __('select...'),
-                minimumResultsForSearch: -1
-            });
-
-            return $comboBox;
-        }
-    } else {
-        throw new Error(`missing category definition on level : ${level}`);
-    }
-}
-
-/**
- * @param {object} options
- * @param {Array} [options.categoriesDefinitions] - the array that defines the number and config for each level of combobox
- * @param {Array} [options.categories] - the array that contains array of categories
- * @param {Array} [options.selected] - the array that contains array of selected options
- * @returns {function}
- */
-export default function groupedComboBoxFactory(options) {
-    return component()
-        .on('render', function render($container) {
-            if (_.isArray(options.categoriesDefinitions) && _.isArray(options.categories)) {
-                options.categoriesDefinitions.forEach(function (k, i) {
-                    var $comboBox = createCombobox(
-                        i,
-                        options.categoriesDefinitions,
-                        options.categories,
-                        options.selected
-                    );
-                    $container.append($comboBox);
-                });
-            }
-        })
-        .init(options);
-}
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2015 (original work) Open Assessment Technologies SA ;
+ */
+import $ from 'jquery';
+import _ from 'lodash';
+import __ from 'i18n';
+import component from 'ui/component';
+import selectTpl from 'ui/bulkActionPopup/tpl/select';
+import 'select2';
+
+var selectedValues = {};
+
+/**
+ * Create a combobox and initialize it with select2
+ *
+ * @param {Number} level
+ * @param {array} categoriesDefinitions - the array that defines the number and config for each level of combobox cascade
+ * @param {array} categories - the array that contains nested array of categories
+ * @param {array} selected - the array that contains options selected
+ * @returns {jQuery}
+ */
+function createCombobox(level, categoriesDefinitions, categories, selected) {
+    if (categoriesDefinitions[level] && categories[level]) {
+        selected = selected || [];
+        const categoryDef = categoriesDefinitions[level];
+        let $comboBox;
+        if (categoryDef.id) {
+            //init <select> DOM element
+            $comboBox = $(
+                selectTpl({
+                    comboboxId: categoryDef.id,
+                    comboboxLabel: categoryDef.label || '',
+                    options: categories[level]
+                })
+            );
+
+            $comboBox.find('select').val(selected[level] || '');
+
+            //add event handler
+            $comboBox.on('change', function () {
+                var $selected = $comboBox.find(':selected');
+                selectedValues[categoryDef.id] = $selected.val();
+                //trigger event
+                $comboBox.trigger('selected.cascading-combobox', [selectedValues]);
+            });
+
+            //init select 2 on $comboBox
+            $comboBox.find('select').select2({
+                allowClear: true,
+                dropdownAutoWidth: true,
+                placeholder: categoryDef.placeholder || __('select...'),
+                minimumResultsForSearch: -1
+            });
+
+            return $comboBox;
+        }
+    } else {
+        throw new Error(`missing category definition on level : ${level}`);
+    }
+}
+
+/**
+ * @param {object} options
+ * @param {Array} [options.categoriesDefinitions] - the array that defines the number and config for each level of combobox
+ * @param {Array} [options.categories] - the array that contains array of categories
+ * @param {Array} [options.selected] - the array that contains array of selected options
+ * @returns {function}
+ */
+export default function groupedComboBoxFactory(options) {
+    return component()
+        .on('render', function render($container) {
+            if (_.isArray(options.categoriesDefinitions) && _.isArray(options.categories)) {
+                options.categoriesDefinitions.forEach(function (k, i) {
+                    var $comboBox = createCombobox(
+                        i,
+                        options.categoriesDefinitions,
+                        options.categories,
+                        options.selected
+                    );
+                    $container.append($comboBox);
+                });
+            }
+        })
+        .init(options);
+}

package/src/groupvalidator.js

@@ -1,84 +1,84 @@
-import $ from 'jquery';
-import _ from 'lodash';
-import 'ui/validator';
-
-/**
- * Register a plugin to validate a group of elements
- *
- * @example $('form').groupValidator();
- * @exports validator/jquery.groupvalidator
- *
- * @param {Object} options - the plugin options
- * @param {string} [options.errorClass = 'error'] - the class added to the element itself if the validation fails
- * @param {string} [options.errorMessageClass = 'validate-error'] - the class added to the inserted node that contains the failure message itself
- * @param {string} [options.validateOnInit = false] - trigger validation upon initialization
- * @param {string|Array} [options.events = ['change', 'blur']] - the default event that triggers the validation
- * @param {function} [options.callback] - the default callback function triggered after validation.
- * @fires validated.group
- * @returns {jQueryElement} for chaining
- */
-$.fn.groupValidator = function(options) {
-    options = _.defaults(options || {}, $.fn.groupValidator.defaults);
-
-    return this.each(function() {
-        var $container = (options.$container = $(this));
-        var states = [];
-        var callback = function(valid, results) {
-            var $elt = $(this);
-
-            //update global state
-            states[$elt.attr('name')] = valid;
-
-            //call custom callback
-            options.callback.call(this, valid, results, options);
-
-            //trigger event on single validation
-            $elt.trigger('validated.single', [valid]);
-
-            /**
-             * Gives the validation state of the entire group.
-             * Fired at each validation
-             * @event validated.group
-             * @param {boolean} isValid - wheter the group is valid
-             */
-            $container.trigger('validated.group', [
-                _(states)
-                    .values()
-                    .contains(false) === false,
-                this
-            ]);
-        };
-
-        var $toValidate = $('[data-validate]', $container).validator({
-            event: options.events,
-            validated: callback
-        });
-
-        if (options.validateOnInit) {
-            $toValidate.validator('validate', {}, callback);
-        }
-    });
-};
-
-$.fn.groupValidator.defaults = {
-    validateOnInit: false,
-    errorClass: 'error',
-    errorMessageClass: 'validate-error',
-    events: ['change', 'blur'],
-    callback: function(valid, results, options) {
-        var $elt = $(this),
-            rule;
-        //removes previous error messages
-        $elt.siblings('.' + options.errorMessageClass).remove();
-
-        if (valid === false) {
-            rule = _.where(results, { type: 'failure' })[0];
-            $elt.addClass(options.errorClass);
-            if (rule && rule.data.message) {
-                $elt.after("<span class='" + options.errorMessageClass + "'>" + rule.data.message + '</span>');
-            }
-        } else {
-            $elt.removeClass(options.errorClass);
-        }
-    }
-};
+import $ from 'jquery';
+import _ from 'lodash';
+import 'ui/validator';
+
+/**
+ * Register a plugin to validate a group of elements
+ *
+ * @example $('form').groupValidator();
+ * @exports validator/jquery.groupvalidator
+ *
+ * @param {Object} options - the plugin options
+ * @param {string} [options.errorClass = 'error'] - the class added to the element itself if the validation fails
+ * @param {string} [options.errorMessageClass = 'validate-error'] - the class added to the inserted node that contains the failure message itself
+ * @param {string} [options.validateOnInit = false] - trigger validation upon initialization
+ * @param {string|Array} [options.events = ['change', 'blur']] - the default event that triggers the validation
+ * @param {function} [options.callback] - the default callback function triggered after validation.
+ * @fires validated.group
+ * @returns {jQueryElement} for chaining
+ */
+$.fn.groupValidator = function(options) {
+    options = _.defaults(options || {}, $.fn.groupValidator.defaults);
+
+    return this.each(function() {
+        var $container = (options.$container = $(this));
+        var states = [];
+        var callback = function(valid, results) {
+            var $elt = $(this);
+
+            //update global state
+            states[$elt.attr('name')] = valid;
+
+            //call custom callback
+            options.callback.call(this, valid, results, options);
+
+            //trigger event on single validation
+            $elt.trigger('validated.single', [valid]);
+
+            /**
+             * Gives the validation state of the entire group.
+             * Fired at each validation
+             * @event validated.group
+             * @param {boolean} isValid - wheter the group is valid
+             */
+            $container.trigger('validated.group', [
+                _(states)
+                    .values()
+                    .contains(false) === false,
+                this
+            ]);
+        };
+
+        var $toValidate = $('[data-validate]', $container).validator({
+            event: options.events,
+            validated: callback
+        });
+
+        if (options.validateOnInit) {
+            $toValidate.validator('validate', {}, callback);
+        }
+    });
+};
+
+$.fn.groupValidator.defaults = {
+    validateOnInit: false,
+    errorClass: 'error',
+    errorMessageClass: 'validate-error',
+    events: ['change', 'blur'],
+    callback: function(valid, results, options) {
+        var $elt = $(this),
+            rule;
+        //removes previous error messages
+        $elt.siblings('.' + options.errorMessageClass).remove();
+
+        if (valid === false) {
+            rule = _.where(results, { type: 'failure' })[0];
+            $elt.addClass(options.errorClass);
+            if (rule && rule.data.message) {
+                $elt.after("<span class='" + options.errorMessageClass + "'>" + rule.data.message + '</span>');
+            }
+        } else {
+            $elt.removeClass(options.errorClass);
+        }
+    }
+};

package/src/hider.js

@@ -1,88 +1,88 @@
-/**
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; under version 2
- * of the License (non-upgradable).
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
- *
- * Copyright (c) 2016 (original work) Open Assessment Technologies SA ;
- */
-
-/**
- * This helps you to show hide elements in a more reliable way than using jQuery.show/hide methods
- * by simply using a css class that has the display: none property in TAO.
- *
- * @author Bertrand Chevrier <bertrand@taotesting.com>
- */
-import $ from 'jquery';
-import 'core/eventifier';
-
-var hiddenClass = 'hidden';
-
-/**
- * Wrap an element to ensure it's a jquery elt.
- * @private
- * @param {jQueryElement|HTMLElement|String} element - the element/node/selector
- * @returns {jQueryElement} the element
- */
-function jqWrap(element) {
-    return element instanceof $ ? element : $(element);
-}
-
-/**
- * The hider object
- */
-export default {
-    /**
-     * Show the given element (let say unhide)
-     * @param {jQueryElement|HTMLElement|String} element - the element/node/selector
-     * @returns {jQueryElement} the element
-     */
-    show: function show(element) {
-        return jqWrap(element).removeClass(hiddenClass);
-    },
-
-    /**
-     * Hide the given element
-     * @param {jQueryElement|HTMLElement|String} element - the element/node/selector
-     * @returns {jQueryElement} the element
-     */
-    hide: function hide(element) {
-        return jqWrap(element).addClass(hiddenClass);
-    },
-
-    /**
-     * Toggle (show if hidden / hide if shown) the given element
-     * @param {jQueryElement|HTMLElement|String} element - the element/node/selector
-     * @param {Boolean} [state] - An optional flag that tells if the element must be shown (true) or hidden (false)
-     * @returns {jQueryElement} the element
-     */
-    toggle: function toggle(element, state) {
-        if ('undefined' !== typeof state) {
-            state = !state;
-        }
-        return jqWrap(element).toggleClass(hiddenClass, state);
-    },
-
-    /**
-     * Check whether the given element is hidden
-     * @param {jQueryElement|HTMLElement|String} element - the element/node/selector
-     * @param {Boolean} [real = false] - if the check takes in account the real display/visibility status.
-     * @returns {jQueryElement} the element
-     */
-    isHidden: function isHidden(element, real) {
-        var $elt = jqWrap(element);
-        if (!real) {
-            return $elt.hasClass(hiddenClass);
-        }
-        return $elt.hasClass(hiddenClass) || $elt.css('display') === 'none' || $elt.css('visibility') === 'hidden';
-    }
-};
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2016 (original work) Open Assessment Technologies SA ;
+ */
+
+/**
+ * This helps you to show hide elements in a more reliable way than using jQuery.show/hide methods
+ * by simply using a css class that has the display: none property in TAO.
+ *
+ * @author Bertrand Chevrier <bertrand@taotesting.com>
+ */
+import $ from 'jquery';
+import 'core/eventifier';
+
+var hiddenClass = 'hidden';
+
+/**
+ * Wrap an element to ensure it's a jquery elt.
+ * @private
+ * @param {jQueryElement|HTMLElement|String} element - the element/node/selector
+ * @returns {jQueryElement} the element
+ */
+function jqWrap(element) {
+    return element instanceof $ ? element : $(element);
+}
+
+/**
+ * The hider object
+ */
+export default {
+    /**
+     * Show the given element (let say unhide)
+     * @param {jQueryElement|HTMLElement|String} element - the element/node/selector
+     * @returns {jQueryElement} the element
+     */
+    show: function show(element) {
+        return jqWrap(element).removeClass(hiddenClass);
+    },
+
+    /**
+     * Hide the given element
+     * @param {jQueryElement|HTMLElement|String} element - the element/node/selector
+     * @returns {jQueryElement} the element
+     */
+    hide: function hide(element) {
+        return jqWrap(element).addClass(hiddenClass);
+    },
+
+    /**
+     * Toggle (show if hidden / hide if shown) the given element
+     * @param {jQueryElement|HTMLElement|String} element - the element/node/selector
+     * @param {Boolean} [state] - An optional flag that tells if the element must be shown (true) or hidden (false)
+     * @returns {jQueryElement} the element
+     */
+    toggle: function toggle(element, state) {
+        if ('undefined' !== typeof state) {
+            state = !state;
+        }
+        return jqWrap(element).toggleClass(hiddenClass, state);
+    },
+
+    /**
+     * Check whether the given element is hidden
+     * @param {jQueryElement|HTMLElement|String} element - the element/node/selector
+     * @param {Boolean} [real = false] - if the check takes in account the real display/visibility status.
+     * @returns {jQueryElement} the element
+     */
+    isHidden: function isHidden(element, real) {
+        var $elt = jqWrap(element);
+        if (!real) {
+            return $elt.hasClass(hiddenClass);
+        }
+        return $elt.hasClass(hiddenClass) || $elt.css('display') === 'none' || $elt.css('visibility') === 'hidden';
+    }
+};