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

package/README.md

@@ -1,18 +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: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:watch`: build for production into `dist` directory and watch for changes
-- `npm run build:cov`: build for coverage into `dist` directory
-- `npm run buildScss`: build `scss` files to `css` files
-- `npm run lint`: check syntax of code
+# 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

@@ -22,24 +22,24 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
     hb.registerHelper('__', function (key) {
       return __(key);
     });
-    /**
-     * Register dompurify helper
-     *
-     * https://github.com/cure53/DOMPurify
-     * with config SAFE_FOR_TEMPLATES: true
-     * to make output safe for template systems
+    /**
+     * Register dompurify helper
+     *
+     * https://github.com/cure53/DOMPurify
+     * with config SAFE_FOR_TEMPLATES: true
+     * to make output safe for template systems
      */
 
     hb.registerHelper('dompurify', function (context) {
       return DOMPurify.sanitize(context);
     });
-    /**
-     * Register join helper
-     *
-     * Example :
-     * var values = {a:v1, b:v2, c:v3};
-     * Using {{{join attributes '=' ' ' '"'}}} will return : a="v1" b="v2" c="v3"
-     * Using {{{join values null ' or ' '*'}}} will return : *v1* or *v2* or *v3*
+    /**
+     * Register join helper
+     *
+     * Example :
+     * var values = {a:v1, b:v2, c:v3};
+     * Using {{{join attributes '=' ' ' '"'}}} will return : a="v1" b="v2" c="v3"
+     * Using {{{join values null ' or ' '*'}}} will return : *v1* or *v2* or *v3*
      */
 
     hb.registerHelper('join', function (arr, keyValueGlue, fragmentGlue, wrapper) {
@@ -132,7 +132,7 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
   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=\"";
@@ -142,14 +142,14 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       + "\" ";
     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) {
@@ -183,10 +183,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
     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) {
@@ -194,33 +194,33 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
     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')) {
@@ -228,10 +228,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       }
     },
 
-    /**
-     * 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')) {
@@ -239,10 +239,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       }
     },
 
-    /**
-     * 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);
@@ -254,10 +254,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       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);
@@ -269,11 +269,11 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       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);
@@ -289,9 +289,9 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       return this;
     },
 
-    /**
-     * Shows the conditional buttons
-     * @returns {actionbar}
+    /**
+     * Shows the conditional buttons
+     * @returns {actionbar}
      */
     showConditionals: function showConditionals() {
       if (this.is('rendered')) {
@@ -301,9 +301,9 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       return this;
     },
 
-    /**
-     * Hides the conditional buttons
-     * @returns {actionbar}
+    /**
+     * Hides the conditional buttons
+     * @returns {actionbar}
      */
     hideConditionals: function hideConditionals() {
       if (this.is('rendered')) {
@@ -313,10 +313,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       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')) {
@@ -330,9 +330,9 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       return this;
     },
 
-    /**
-     * Shows all the buttons
-     * @returns {actionbar}
+    /**
+     * Shows all the buttons
+     * @returns {actionbar}
      */
     showAll: function showAll() {
       if (this.is('rendered')) {
@@ -342,9 +342,9 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       return this;
     },
 
-    /**
-     * Hides all the buttons
-     * @returns {actionbar}
+    /**
+     * Hides all the buttons
+     * @returns {actionbar}
      */
     hideAll: function hideAll() {
       if (this.is('rendered')) {
@@ -354,10 +354,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       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')) {
@@ -371,28 +371,28 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
       return this;
     }
   };
-  /**
-   * 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) {
@@ -430,10 +430,10 @@ define(['jquery', 'lodash', 'ui/component', 'handlebars', 'i18n', 'lib/dompurify
         if (button && button.action) {
           button.action.call(self, buttonId, button);
         }
-        /**
-         * @event actionbar#button
-         * @param {String} buttonId
-         * @param {Object} button
+        /**
+         * @event actionbar#button
+         * @param {String} buttonId
+         * @param {Object} button
          */