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

package/README.md

@@ -1,23 +1,23 @@
-# tao-core-ui-fe
-TAO Frontend UI Components
-
-UI libraries of TAO.
-
-Available scripts in the project:
-
-- `npm run test <testname>`: run test suite
-  - `testname` (optional): Specific test to run. If it is not provided, all will be ran.
-- `npm run test:keepAlive`: start test server
-- `npm run test:dev`: start test server and watch for changes
-- `npm run test:cov`: run `build:cov` and run tests
-- `npm run coverage`: show coverage report in terminal
-- `npm run coverage:html`: show coverage report in browser
-- `npm run build`: build for production into `dist` directory
-- `npm run build:dev`: build for production into `dist` directory and watch for changes
-- `npm run build:watch`: build for production into `dist` directory and watch for changes
-- `npm run build:cov`: build for coverage into `dist` directory
-- `npm run build:all`: build `scss` files to `css` files, build for production into `dist` directory 
-- `npm run buildScss`: build `scss` files to `css` files
-- `npm run lint:src`: check syntax of code
-- `npm run lint:test`: check syntax of code in the unit tests
+# tao-core-ui-fe
+TAO Frontend UI Components
+
+UI libraries of TAO.
+
+Available scripts in the project:
+
+- `npm run test <testname>`: run test suite
+  - `testname` (optional): Specific test to run. If it is not provided, all will be ran.
+- `npm run test:keepAlive`: start test server
+- `npm run test:dev`: start test server and watch for changes
+- `npm run test:cov`: run `build:cov` and run tests
+- `npm run coverage`: show coverage report in terminal
+- `npm run coverage:html`: show coverage report in browser
+- `npm run build`: build for production into `dist` directory
+- `npm run build:dev`: build for production into `dist` directory and watch for changes
+- `npm run build:watch`: build for production into `dist` directory and watch for changes
+- `npm run build:cov`: build for coverage into `dist` directory
+- `npm run build:all`: build `scss` files to `css` files, build for production into `dist` directory 
+- `npm run buildScss`: build `scss` files to `css` files
+- `npm run lint:src`: check syntax of code
+- `npm run lint:test`: check syntax of code in the unit tests
 - `npm run lint:report`: build a syntax check report

package/dist/actionbar.js

@@ -30,7 +30,7 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
     function program5(depth0,data) {
       
       var buffer = "", stack1, helper;
-      buffer += "\r\n    <button class=\"btn-info small ";
+      buffer += "\n    <button class=\"btn-info small ";
       stack1 = helpers['if'].call(depth0, (depth0 && depth0.conditional), {hash:{},inverse:self.noop,fn:self.program(6, program6, data),data:data});
       if(stack1 || stack1 === 0) { buffer += stack1; }
       buffer += "\" data-control=\"";
@@ -40,14 +40,14 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
         + "\" ";
       stack1 = helpers['if'].call(depth0, (depth0 && depth0.title), {hash:{},inverse:self.noop,fn:self.program(8, program8, data),data:data});
       if(stack1 || stack1 === 0) { buffer += stack1; }
-      buffer += ">\r\n        ";
+      buffer += ">\n        ";
       stack1 = helpers['if'].call(depth0, (depth0 && depth0.icon), {hash:{},inverse:self.noop,fn:self.program(10, program10, data),data:data});
       if(stack1 || stack1 === 0) { buffer += stack1; }
-      buffer += "\r\n        ";
+      buffer += "\n        ";
       if (helper = helpers.label) { stack1 = helper.call(depth0, {hash:{},data:data}); }
       else { helper = (depth0 && depth0.label); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
       buffer += escapeExpression(stack1)
-        + "\r\n    </button>\r\n    ";
+        + "\n    </button>\n    ";
       return buffer;
       }
     function program6(depth0,data) {
@@ -81,10 +81,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
       buffer += "<aside class=\"action-bar ";
       stack1 = helpers['if'].call(depth0, (depth0 && depth0.vertical), {hash:{},inverse:self.program(3, program3, data),fn:self.program(1, program1, data),data:data});
       if(stack1 || stack1 === 0) { buffer += stack1; }
-      buffer += " clearfix\">\r\n    ";
+      buffer += " clearfix\">\n    ";
       stack1 = helpers.each.call(depth0, (depth0 && depth0.buttons), {hash:{},inverse:self.noop,fn:self.program(5, program5, data),data:data});
       if(stack1 || stack1 === 0) { buffer += stack1; }
-      buffer += "\r\n</aside>\r\n";
+      buffer += "\n</aside>\n";
       return buffer;
       });
     function mainTpl(data, options, asString) {
@@ -92,53 +92,53 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
       return (asString || true) ? html : $(html);
     }
 
-    /**
-     * 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 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 ;
      */
 
-    /**
-     * Defines an action bar
-     * @type {Object}
+    /**
+     * Defines an action bar
+     * @type {Object}
      */
     var actionbar = {
-      /**
-       * Gets the definition of a button
-       * @param {String} id - The identifier of the button
-       * @returns {Object|undefined}
+      /**
+       * Gets the definition of a button
+       * @param {String} id - The identifier of the button
+       * @returns {Object|undefined}
        */
       getButton: function getButton(id) {
         if (this.is('rendered')) {
           return this.buttons[id];
         }
       },
-      /**
-       * Gets the DOM element of a button
-       * @param {String} id - The identifier of the button
-       * @returns {jQuery|undefined}
+      /**
+       * Gets the DOM element of a button
+       * @param {String} id - The identifier of the button
+       * @returns {jQuery|undefined}
        */
       getButtonElement: function getButtonElement(id) {
         if (this.is('rendered')) {
           return this.controls.$buttons[id];
         }
       },
-      /**
-       * Shows a button
-       * @param {String} id - The identifier of the button
-       * @returns {actionbar}
+      /**
+       * Shows a button
+       * @param {String} id - The identifier of the button
+       * @returns {actionbar}
        */
       showButton: function showButton(id) {
         var $btn = this.getButtonElement(id);
@@ -147,10 +147,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
         }
         return this;
       },
-      /**
-       * Hides a button
-       * @param {String} id - The identifier of the button
-       * @returns {actionbar}
+      /**
+       * Hides a button
+       * @param {String} id - The identifier of the button
+       * @returns {actionbar}
        */
       hideButton: function hideButton(id) {
         var $btn = this.getButtonElement(id);
@@ -159,11 +159,11 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
         }
         return this;
       },
-      /**
-       * Toggles a button according to a condition
-       * @param {String} id - The identifier of the button
-       * @param {Boolean} condition - If the condition is `true` the button will be displayed
-       * @returns {actionbar}
+      /**
+       * Toggles a button according to a condition
+       * @param {String} id - The identifier of the button
+       * @param {Boolean} condition - If the condition is `true` the button will be displayed
+       * @returns {actionbar}
        */
       toggleButton: function toggleButton(id, condition) {
         var $btn = this.getButtonElement(id);
@@ -175,9 +175,9 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
         }
         return this;
       },
-      /**
-       * Shows the conditional buttons
-       * @returns {actionbar}
+      /**
+       * Shows the conditional buttons
+       * @returns {actionbar}
        */
       showConditionals: function showConditionals() {
         if (this.is('rendered')) {
@@ -185,9 +185,9 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
         }
         return this;
       },
-      /**
-       * Hides the conditional buttons
-       * @returns {actionbar}
+      /**
+       * Hides the conditional buttons
+       * @returns {actionbar}
        */
       hideConditionals: function hideConditionals() {
         if (this.is('rendered')) {
@@ -195,10 +195,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
         }
         return this;
       },
-      /**
-       * Toggles the conditional buttons according to a condition
-       * @param {Boolean} condition - If the condition is `true` the conditional buttons will be displayed
-       * @returns {actionbar}
+      /**
+       * Toggles the conditional buttons according to a condition
+       * @param {Boolean} condition - If the condition is `true` the conditional buttons will be displayed
+       * @returns {actionbar}
        */
       toggleConditionals: function toggleConditionals(condition) {
         if (this.is('rendered')) {
@@ -209,9 +209,9 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
         }
         return this;
       },
-      /**
-       * Shows all the buttons
-       * @returns {actionbar}
+      /**
+       * Shows all the buttons
+       * @returns {actionbar}
        */
       showAll: function showAll() {
         if (this.is('rendered')) {
@@ -219,9 +219,9 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
         }
         return this;
       },
-      /**
-       * Hides all the buttons
-       * @returns {actionbar}
+      /**
+       * Hides all the buttons
+       * @returns {actionbar}
        */
       hideAll: function hideAll() {
         if (this.is('rendered')) {
@@ -229,10 +229,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
         }
         return this;
       },
-      /**
-       * Toggles all the buttons according to a condition
-       * @param {Boolean} condition - If the condition is `true` the buttons will be displayed
-       * @returns {actionbar}
+      /**
+       * Toggles all the buttons according to a condition
+       * @param {Boolean} condition - If the condition is `true` the buttons will be displayed
+       * @returns {actionbar}
        */
       toggleAll: function toggleAll(condition) {
         if (this.is('rendered')) {
@@ -245,28 +245,28 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
       }
     };
 
-    /**
-     * Builds an instance of the actionbar component
-     * @param {Object} config
-     * @param {Array} config.buttons - The list of buttons to display.
-     * @param {String} config.buttons.id - The id of the button
-     * @param {String} config.buttons.label - The text displayed in the button
-     * @param {String} config.buttons.icon - An optional icon displayed in the button
-     * @param {String} config.buttons.title - An optional tooltip displayed on the button
-     * @param {Boolean} config.buttons.conditional - The button is hidden by default and must be displayed later
-     * @param {Function} config.buttons.action - An action called when the button is clicked
-     * @param {Boolean} [config.vertical] - Displays the action bar vertically
-     * @returns {actionbar}
-     *
-     * @event init - Emitted when the component is initialized
-     * @event destroy - Emitted when the component is destroying
-     * @event render - Emitted when the component is rendered
-     * @event button - Emitted when a button is clicked
-     * @event show - Emitted when the component is shown
-     * @event hide - Emitted when the component is hidden
-     * @event enable - Emitted when the component is enabled
-     * @event disable - Emitted when the component is disabled
-     * @event template - Emitted when the template is changed
+    /**
+     * Builds an instance of the actionbar component
+     * @param {Object} config
+     * @param {Array} config.buttons - The list of buttons to display.
+     * @param {String} config.buttons.id - The id of the button
+     * @param {String} config.buttons.label - The text displayed in the button
+     * @param {String} config.buttons.icon - An optional icon displayed in the button
+     * @param {String} config.buttons.title - An optional tooltip displayed on the button
+     * @param {Boolean} config.buttons.conditional - The button is hidden by default and must be displayed later
+     * @param {Function} config.buttons.action - An action called when the button is clicked
+     * @param {Boolean} [config.vertical] - Displays the action bar vertically
+     * @returns {actionbar}
+     *
+     * @event init - Emitted when the component is initialized
+     * @event destroy - Emitted when the component is destroying
+     * @event render - Emitted when the component is rendered
+     * @event button - Emitted when a button is clicked
+     * @event show - Emitted when the component is shown
+     * @event hide - Emitted when the component is hidden
+     * @event enable - Emitted when the component is enabled
+     * @event disable - Emitted when the component is disabled
+     * @event template - Emitted when the template is changed
      */
     function actionbarFactory(config) {
       return component(actionbar).setTemplate(mainTpl)
@@ -308,10 +308,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'lib/handlebars/helper
             button.action.call(self, buttonId, button);
           }
 
-          /**
-           * @event actionbar#button
-           * @param {String} buttonId
-           * @param {Object} button
+          /**
+           * @event actionbar#button
+           * @param {String} buttonId
+           * @param {Object} button
            */
           self.trigger('button', buttonId, button);
         });

package/dist/adder.js

@@ -6,12 +6,12 @@ define(['jquery', 'lodash', 'handlebars', 'core/pluginifier', 'core/dataattrhand
     Pluginifier = Pluginifier && Object.prototype.hasOwnProperty.call(Pluginifier, 'default') ? Pluginifier['default'] : Pluginifier;
     DataAttrHandler = DataAttrHandler && Object.prototype.hasOwnProperty.call(DataAttrHandler, 'default') ? DataAttrHandler['default'] : DataAttrHandler;
 
-    /**
-     * @author Bertrand Chevrier <bertrand@taotesting.com>
-     * @requires jquery
-     * @requires lodash
-     * @requires core/pluginifier
-     * @requires core/dataattrhandler
+    /**
+     * @author Bertrand Chevrier <bertrand@taotesting.com>
+     * @requires jquery
+     * @requires lodash
+     * @requires core/pluginifier
+     * @requires core/dataattrhandler
      */
     const ns = 'adder';
     const dataNs = 'ui.' + ns;
@@ -22,85 +22,85 @@ define(['jquery', 'lodash', 'handlebars', 'core/pluginifier', 'core/dataattrhand
       bindEvent: 'click',
       disableClass: 'disabled',
       position: 'append',
-      /**
-       * Async callback used to populate template data
-       * @example templateData : function(cb){
-       *       $.getJSON(url).done(function(data){
-       *           cb(data);
-       *       }).fails(function(){
-       *           cb({});
-       *       });
-       *
-       *       //or
-       *
-       *       cb({
-       *           key: value,
-       *           key2: value2
-       *       });
-       * }
-       *
-       * @callback templateData
-       * @params {dataCallback} [] - an optionnal callback used
-       * @returns {object} the data to be bound to the template
+      /**
+       * Async callback used to populate template data
+       * @example templateData : function(cb){
+       *       $.getJSON(url).done(function(data){
+       *           cb(data);
+       *       }).fails(function(){
+       *           cb({});
+       *       });
+       *
+       *       //or
+       *
+       *       cb({
+       *           key: value,
+       *           key2: value2
+       *       });
+       * }
+       *
+       * @callback templateData
+       * @params {dataCallback} [] - an optionnal callback used
+       * @returns {object} the data to be bound to the template
        */
       templateData: function (dataCallback) {
-        /**
-         * This callback is used to populate template data
-         * @callback dataCallback
-         * @params {object} data - the data to be bound to the template
+        /**
+         * This callback is used to populate template data
+         * @callback dataCallback
+         * @params {object} data - the data to be bound to the template
          */
         dataCallback({});
       },
-      /**
-       * Async callback used to execute add
-       * @example checkAndCallAdd : function(executeAdd){
-       *       $.getJSON(url).done(function(executeAdd){
-       *           if(data.condition) {
-       *              executeAdd();
-       *           }
-       *       });
-       *
-       *       //or
-       *       if (noItems) {
-       *          executeAdd();
-       *       }
-       * }
-       *
-       * @callback checkAndCallAdd
-       * @params {executeAdd} - callback to run add function
+      /**
+       * Async callback used to execute add
+       * @example checkAndCallAdd : function(executeAdd){
+       *       $.getJSON(url).done(function(executeAdd){
+       *           if(data.condition) {
+       *              executeAdd();
+       *           }
+       *       });
+       *
+       *       //or
+       *       if (noItems) {
+       *          executeAdd();
+       *       }
+       * }
+       *
+       * @callback checkAndCallAdd
+       * @params {executeAdd} - callback to run add function
        */
       checkAndCallAdd: function (executeAdd) {
-        /**
-         * This callback is used to populate template data
-         * @callback executeAdd
+        /**
+         * This callback is used to populate template data
+         * @callback executeAdd
          */
         executeAdd();
       }
     };
 
-    /**
-     * The Adder component, that helps you to add a new element,
-     * from a DOM element or a template
-     * @exports ui/adder
+    /**
+     * The Adder component, that helps you to add a new element,
+     * from a DOM element or a template
+     * @exports ui/adder
      */
     const Adder = {
-      /**
-       * Initialize the plugin.
-       *
-       * Called the jQuery way once registered by the Pluginifier.
-       * @example $('selector').adder({target : $('target'),  content: $('#tmplId') });
-       * @public
-       *
-       * @constructor
-       * @param {Object} options - the plugin options
-       * @param {jQueryElement} options.target - the element to add content to
-       * @param {string|boolean} [options.bindEvent = 'click'] - the event that trigger the adding
-       * @param {jQueryElement} [options.content] - a DOM Element or a 'text/template' script tag that contains the template
-       * @param {string} [options.position = 'append'] - how to add the content regarding the target (the name of a valid jQUery maniuplation function)
-       * @param {templateData} [options.templateData] - a callback used to populate the template
-       * @param {Object} [options.checkAndCallAdd] - a callback used to check conditions before call add
-       * @fires Adder#create.adder
-       * @returns {jQueryElement} for chaining
+      /**
+       * Initialize the plugin.
+       *
+       * Called the jQuery way once registered by the Pluginifier.
+       * @example $('selector').adder({target : $('target'),  content: $('#tmplId') });
+       * @public
+       *
+       * @constructor
+       * @param {Object} options - the plugin options
+       * @param {jQueryElement} options.target - the element to add content to
+       * @param {string|boolean} [options.bindEvent = 'click'] - the event that trigger the adding
+       * @param {jQueryElement} [options.content] - a DOM Element or a 'text/template' script tag that contains the template
+       * @param {string} [options.position = 'append'] - how to add the content regarding the target (the name of a valid jQUery maniuplation function)
+       * @param {templateData} [options.templateData] - a callback used to populate the template
+       * @param {Object} [options.checkAndCallAdd] - a callback used to check conditions before call add
+       * @fires Adder#create.adder
+       * @returns {jQueryElement} for chaining
        */
       init: function (options) {
         options = _.defaults(options || {}, defaults);
@@ -135,42 +135,42 @@ define(['jquery', 'lodash', 'handlebars', 'core/pluginifier', 'core/dataattrhand
               });
             }
 
-            /**
-             * The plugin have been created.
-             * @event Adder#create.adder
+            /**
+             * The plugin have been created.
+             * @event Adder#create.adder
              */
             $elt.trigger('create.' + ns);
           }
         });
       },
-      /**
-       * Trigger the adding.
-       *
-       * Called the jQuery way once registered by the Pluginifier.
-       * @example $('selector').adder('add');
-       * @param {jQueryElement} $elt - plugin's element
-       * @fires Adder#add.adder
-       * @fires Adder#add
+      /**
+       * Trigger the adding.
+       *
+       * Called the jQuery way once registered by the Pluginifier.
+       * @example $('selector').adder('add');
+       * @param {jQueryElement} $elt - plugin's element
+       * @fires Adder#add.adder
+       * @fires Adder#add
        */
       _add: function ($elt) {
         const options = $elt.data(dataNs);
         const applyTemplate = function applyTemplate($content, position, $target, data) {
           $content[position]($target);
 
-          /**
-           * The target has received content.
-           * @event Adder#add
-           * @param {jQueryElement} - the added content
-           * @param {Object} - the data bound to the added content
+          /**
+           * The target has received content.
+           * @event Adder#add
+           * @param {jQueryElement} - the added content
+           * @param {Object} - the data bound to the added content
            */
           $target.trigger('add', [$content, data]);
 
-          /**
-           * The content has been added.
-           * @event Adder#add.adder
-           * @param {jQueryElement} - the target
-           * @param {jQueryElement} - the added content
-           * @param {Object} - the data bound to the added content
+          /**
+           * The content has been added.
+           * @event Adder#add.adder
+           * @param {jQueryElement} - the target
+           * @param {jQueryElement} - the added content
+           * @param {Object} - the data bound to the added content
            */
           $elt.trigger('add.' + ns, [$target, $content, data]);
         };
@@ -186,13 +186,13 @@ define(['jquery', 'lodash', 'handlebars', 'core/pluginifier', 'core/dataattrhand
           applyTemplate($($.parseHTML(options._html)), position, $target);
         }
       },
-      /**
-       * Destroy completely the plugin.
-       *
-       * Called the jQuery way once registered by the Pluginifier.
-       * @example $('selector').adder('destroy');
-       * @public
-       * @fires Adder#destroy.adder
+      /**
+       * Destroy completely the plugin.
+       *
+       * Called the jQuery way once registered by the Pluginifier.
+       * @example $('selector').adder('destroy');
+       * @public
+       * @fires Adder#destroy.adder
        */
       destroy: function () {
         this.each(function () {
@@ -203,9 +203,9 @@ define(['jquery', 'lodash', 'handlebars', 'core/pluginifier', 'core/dataattrhand
           }
           $elt.removeData(dataNs);
 
-          /**
-           * The plugin have been destroyed.
-           * @event Adder#destroy.adder
+          /**
+           * The plugin have been destroyed.
+           * @event Adder#destroy.adder
            */
           $elt.trigger('destroy.' + ns);
         });
@@ -217,12 +217,12 @@ define(['jquery', 'lodash', 'handlebars', 'core/pluginifier', 'core/dataattrhand
       expose: ['add']
     });
 
-    /**
-     * The only exposed function is used to start listening on data-attr
-     *
-     * @public
-     * @example define(['ui/adder'], function(adder){ adder($('rootContainer')); });
-     * @param {jQueryElement} $container - the root context to listen in
+    /**
+     * The only exposed function is used to start listening on data-attr
+     *
+     * @public
+     * @example define(['ui/adder'], function(adder){ adder($('rootContainer')); });
+     * @param {jQueryElement} $container - the root context to listen in
      */
     function listenDataAttr($container) {
       new DataAttrHandler('add', {