@oat-sa/tao-core-ui 1.54.2 → 1.55.0

package/dist/component/windowed.js

@@ -22,24 +22,24 @@ define(['lodash', 'i18n', 'jquery', 'ui/component/placeable', 'handlebars', 'lib
     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) {
@@ -118,11 +118,11 @@ define(['lodash', 'i18n', 'jquery', 'ui/component/placeable', 'handlebars', 'lib
     var buffer = "", stack1, helper, functionType="function", escapeExpression=this.escapeExpression;
 
 
-    buffer += "<div class=\"window-component\">\r\n    <div class=\"window-component-title-bar\">\r\n        <div class=\"window-component-title\">";
+    buffer += "<div class=\"window-component\">\n    <div class=\"window-component-title-bar\">\n        <div class=\"window-component-title\">";
     if (helper = helpers.windowTitle) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.windowTitle); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "</div>\r\n        <div class=\"window-component-controls\"> </div>\r\n    </div>\r\n    <div class=\"window-component-body\"></div>\r\n</div>\r\n";
+      + "</div>\n        <div class=\"window-component-controls\"> </div>\n    </div>\n    <div class=\"window-component-body\"></div>\n</div>\n";
     return buffer;
     });
   function windowTpl(data, options, asString) {
@@ -130,22 +130,22 @@ define(['lodash', 'i18n', 'jquery', 'ui/component/placeable', 'handlebars', 'lib
     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;
    */
   var eventNs = '.windowed',
       cssNs = '.window-component',
@@ -173,39 +173,39 @@ define(['lodash', 'i18n', 'jquery', 'ui/component/placeable', 'handlebars', 'lib
     }
   };
   var windowedComponentAPI = {
-    /**
-     * @returns {jQuery} - the container where the title bar controls are rendered
+    /**
+     * @returns {jQuery} - the container where the title bar controls are rendered
      */
     getControls: function getControls() {
       var $component = this.getElement();
       return $component.find(cssNs + '-controls');
     },
 
-    /**
-     * @returns {jQuery} - the container where the title is rendered
+    /**
+     * @returns {jQuery} - the container where the title is rendered
      */
     getTitle: function getTitle() {
       var $component = this.getElement();
       return $component.find(cssNs + '-title');
     },
 
-    /**
-     * @returns {jQuery} - the content area of the window
+    /**
+     * @returns {jQuery} - the content area of the window
      */
     getBody: function getBody() {
       var $component = this.getElement();
       return $component.find(cssNs + '-body');
     },
 
-    /**
-     * Adds a control to the control area
-     * @param {String} controlOptions.id
-     * @param {String} controlOptions.icon
-     * @param {Number} [controlOptions.order] - position relative to the other controls
-     * @param {String} [controlOptions.description] - link description on mouse over
-     * @param {Function} [controlOptions.onclick] - what to do when the control is clicked. Optional if event is specified.
-     * @param {Function} [controlOptions.event] - event to trigger when the control is clicked. Optional if onclick is specified
-     * @returns {component}
+    /**
+     * Adds a control to the control area
+     * @param {String} controlOptions.id
+     * @param {String} controlOptions.icon
+     * @param {Number} [controlOptions.order] - position relative to the other controls
+     * @param {String} [controlOptions.description] - link description on mouse over
+     * @param {Function} [controlOptions.onclick] - what to do when the control is clicked. Optional if event is specified.
+     * @param {Function} [controlOptions.event] - event to trigger when the control is clicked. Optional if onclick is specified
+     * @returns {component}
      */
     addControl: function addControl(controlOptions) {
       if (!_.isString(controlOptions.id) || _.isEmpty(controlOptions.id)) {
@@ -229,9 +229,9 @@ define(['lodash', 'i18n', 'jquery', 'ui/component/placeable', 'handlebars', 'lib
       return this;
     },
 
-    /**
-     * Add pre-configured controls to the title bar
-     * @returns {component}
+    /**
+     * Add pre-configured controls to the title bar
+     * @returns {component}
      */
     addPresets: function addPresets() {
       if (this.config.hasCloser) {
@@ -245,10 +245,10 @@ define(['lodash', 'i18n', 'jquery', 'ui/component/placeable', 'handlebars', 'lib
       return this;
     },
 
-    /**
-     * Render the controls buttons in the title bar
-     * @returns {component}
-     * @private
+    /**
+     * Render the controls buttons in the title bar
+     * @returns {component}
+     * @private
      */
     _renderControls: function _renderControls() {
       var self = this,
@@ -293,12 +293,12 @@ define(['lodash', 'i18n', 'jquery', 'ui/component/placeable', 'handlebars', 'lib
       return this;
     }
   };
-  /**
-   * @param {Component} component - an instance of ui/component
-   * @param {Object} config
-   * @param {Boolean} hasCloser - auto-add the closer control to the title bar
-   * @param {Boolean} hasBin - auto-add the delete control to the title bar
-   * @param {String} windowTitle - to be rendered in the title bar
+  /**
+   * @param {Component} component - an instance of ui/component
+   * @param {Object} config
+   * @param {Boolean} hasCloser - auto-add the closer control to the title bar
+   * @param {Boolean} hasBin - auto-add the delete control to the title bar
+   * @param {String} windowTitle - to be rendered in the title bar
    */
 
   function makeWindowed(component, config) {

package/dist/component.js

@@ -22,24 +22,24 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
     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) {
@@ -124,26 +124,26 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
     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) 2015 (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) 2015 (original work) Open Assessment Technologies SA ;
    */
   var _slice = [].slice;
-  /**
-   * Handles the resize of the component regarding the config set
+  /**
+   * Handles the resize of the component regarding the config set
    */
 
   function delegatedResize() {
@@ -179,11 +179,11 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
     this._width = width;
     this._height = height;
   }
-  /**
-   * Builds a component from a base skeleton
-   * @param {Object} [specs] - Some extra methods to assign to the component instance
-   * @param {Object} [defaults] - Some default config entries
-   * @returns {component}
+  /**
+   * Builds a component from a base skeleton
+   * @param {Object} [specs] - Some extra methods to assign to the component instance
+   * @param {Object} [defaults] - Some default config entries
+   * @returns {component}
    */
 
 
@@ -195,29 +195,29 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
 
     var $container; // base skeleton
 
-    /**
-     * @typedef {Object} Component
+    /**
+     * @typedef {Object} Component
      */
 
     var componentApi = {
-      /**
-       * Initializes the component
-       * @param {Object} config
-       * @param {jQuery|HTMLElement|String} [config.renderTo] - An optional container in which renders the component
-       * @param {Boolean} [config.replace] - When the component is appended to its container, clears the place before
-       * @param {Number|String} [config.width] - The width in pixels, or 'auto' to use the container's width
-       * @param {Number|String} [config.height] - The height in pixels, or 'auto' to use the container's height
-       * @returns {component}
-       * @fires component#init
+      /**
+       * Initializes the component
+       * @param {Object} config
+       * @param {jQuery|HTMLElement|String} [config.renderTo] - An optional container in which renders the component
+       * @param {Boolean} [config.replace] - When the component is appended to its container, clears the place before
+       * @param {Number|String} [config.width] - The width in pixels, or 'auto' to use the container's width
+       * @param {Number|String} [config.height] - The height in pixels, or 'auto' to use the container's height
+       * @returns {component}
+       * @fires component#init
        */
       init: function init(config) {
         this.config = _(config || {}).omit(function (value) {
           return value === null || typeof value === 'undefined';
         }).defaults(defaults || {}).value();
         componentState = {};
-        /**
-         * Executes extra init tasks
-         * @event component#init
+        /**
+         * Executes extra init tasks
+         * @event component#init
          */
 
         this.trigger('init');
@@ -230,15 +230,15 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
         return this;
       },
 
-      /**
-       * Uninstalls the component
-       * @returns {component}
-       * @fires component#destroy
+      /**
+       * Uninstalls the component
+       * @returns {component}
+       * @fires component#destroy
        */
       destroy: function destroy() {
-        /**
-         * Executes extra destroy tasks
-         * @event component#destroy
+        /**
+         * Executes extra destroy tasks
+         * @event component#destroy
          */
         this.trigger('destroy');
 
@@ -251,11 +251,11 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
         return this;
       },
 
-      /**
-       * Renders the component
-       * @param {jQuery|HTMLElement|String} [container] - where the component is rendered
-       * @returns {component}
-       * @fires component#render
+      /**
+       * Renders the component
+       * @param {jQuery|HTMLElement|String} [container] - where the component is rendered
+       * @returns {component}
+       * @fires component#render
        */
       render: function render(container) {
         if (container) {
@@ -274,22 +274,22 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
 
         this.setState('rendered', true);
         delegatedResize.call(this);
-        /**
-         * Executes extra render tasks
-         * @event component#render
-         * @param {jQuery} $component
+        /**
+         * Executes extra render tasks
+         * @event component#render
+         * @param {jQuery} $component
          */
 
         this.trigger('render', this.$component);
         return this;
       },
 
-      /**
-       * Sets the component's size
-       * @param {Number|String} width - The width in pixels, or 'auto' to use the container's width
-       * @param {Number|String} height - The height in pixels, or 'auto' to use the container's height
-       * @returns {component}
-       * @fires component#setsize
+      /**
+       * Sets the component's size
+       * @param {Number|String} width - The width in pixels, or 'auto' to use the container's width
+       * @param {Number|String} height - The height in pixels, or 'auto' to use the container's height
+       * @returns {component}
+       * @fires component#setsize
        */
       setSize: function setSize(width, height) {
         this.config.width = width;
@@ -298,11 +298,11 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
         if (this.is('rendered')) {
           delegatedResize.call(this);
         }
-        /**
-         * Executes extra resize tasks
-         * @event component#setsize
-         * @param {Number|String} width
-         * @param {Number|String} height
+        /**
+         * Executes extra resize tasks
+         * @event component#setsize
+         * @param {Number|String} width
+         * @param {Number|String} height
          */
 
 
@@ -310,10 +310,10 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
         return this;
       },
 
-      /**
-       * Get the component's size
-       * @returns {Object}
-       * @fires component#setsize
+      /**
+       * Get the component's size
+       * @returns {Object}
+       * @fires component#setsize
        */
       getSize: function getSize() {
         if (this.is('rendered')) {
@@ -324,10 +324,10 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
         }
       },
 
-      /**
-       * Get the component rendered size
-       * @param {Boolean} includeMargin - include the margins in the returned size
-       * @returns {{width: number, height: number}}
+      /**
+       * Get the component rendered size
+       * @param {Boolean} includeMargin - include the margins in the returned size
+       * @returns {{width: number, height: number}}
        */
       getOuterSize: function getOuterSize(includeMargin) {
         var $component;
@@ -342,81 +342,81 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
         }
       },
 
-      /**
-       * Shows the component
-       * @returns {component}
-       * @fires component#show
+      /**
+       * Shows the component
+       * @returns {component}
+       * @fires component#show
        */
       show: function show() {
-        /**
-         * Executes extra tasks on show
-         * @event component#show
-         * @param {component} component
+        /**
+         * Executes extra tasks on show
+         * @event component#show
+         * @param {component} component
          */
         this.trigger('show', this);
         return this.setState('hidden', false);
       },
 
-      /**
-       * Hides the component
-       * @returns {component}
-       * @fires component#hide
+      /**
+       * Hides the component
+       * @returns {component}
+       * @fires component#hide
        */
       hide: function hide() {
-        /**
-         * Executes extra tasks on hide
-         * @event component#hide
-         * @param {component} component
+        /**
+         * Executes extra tasks on hide
+         * @event component#hide
+         * @param {component} component
          */
         this.trigger('hide', this);
         return this.setState('hidden', true);
       },
 
-      /**
-       * Enables the component
-       * @returns {component}
-       * @fires component#enable
+      /**
+       * Enables the component
+       * @returns {component}
+       * @fires component#enable
        */
       enable: function enable() {
-        /**
-         * Executes extra tasks on enable
-         * @event component#enable
-         * @param {component} component
+        /**
+         * Executes extra tasks on enable
+         * @event component#enable
+         * @param {component} component
          */
         this.trigger('enable', this);
         return this.setState('disabled', false);
       },
 
-      /**
-       * Disables the component
-       * @returns {component}
-       * @fires component#disable
+      /**
+       * Disables the component
+       * @returns {component}
+       * @fires component#disable
        */
       disable: function disable() {
-        /**
-         * Executes extra tasks on disable
-         * @event component#disable
-         * @param {component} component
+        /**
+         * Executes extra tasks on disable
+         * @event component#disable
+         * @param {component} component
          */
         this.trigger('disable', this);
         return this.setState('disabled', true);
       },
 
-      /**
-       * Checks if the component has a particular state
-       * @param {String} state
-       * @returns {Boolean}
+      /**
+       * Checks if the component has a particular state
+       * @param {String} state
+       * @returns {Boolean}
        */
       is: function is(state) {
         return !!componentState[state];
       },
 
-      /**
-       * Sets the component to a particular state
-       * @param {String} state
-       * @param {Boolean} flag
-       * @returns {component}
-       * @fires component#state
+      /**
+       * Sets the component to a particular state
+       * @param {String} state
+       * @param {Boolean} flag
+       * @returns {component}
+       * @fires component#state
        */
       setState: function setState(state, flag) {
         flag = !!flag;
@@ -425,12 +425,12 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
         if (this.$component) {
           this.$component.toggleClass(state, flag);
         }
-        /**
-         * Executes extra tasks on state change
-         * @event component#state
-         * @param {String} state
-         * @param {Boolean} flag
-         * @param {component} component
+        /**
+         * Executes extra tasks on state change
+         * @event component#state
+         * @param {String} state
+         * @param {Boolean} flag
+         * @param {component} component
          */
 
 
@@ -438,35 +438,35 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
         return this;
       },
 
-      /**
-       * Gets the underlying DOM element
-       * @returns {jQuery}
+      /**
+       * Gets the underlying DOM element
+       * @returns {jQuery}
        */
       getContainer: function getContainer() {
         return $container;
       },
 
-      /**
-       * Gets the underlying DOM element
-       * @returns {jQuery}
+      /**
+       * Gets the underlying DOM element
+       * @returns {jQuery}
        */
       getElement: function getElement() {
         return this.$component;
       },
 
-      /**
-       * Gets the template used to render this component
-       * @returns {Function}
+      /**
+       * Gets the template used to render this component
+       * @returns {Function}
        */
       getTemplate: function getTemplate() {
         return componentTpl;
       },
 
-      /**
-       * Sets the template used to render this component
-       * @param {Function} template
-       * @returns {componentApi}
-       * @fires component#template
+      /**
+       * Sets the template used to render this component
+       * @param {Function} template
+       * @returns {componentApi}
+       * @fires component#template
        */
       setTemplate: function setTemplate(template) {
         var tpl = template || defaultTpl;
@@ -477,10 +477,10 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
             return tpl;
           };
         }
-        /**
-         * Executes extra tasks on template change
-         * @event component#template
-         * @param {function} componentTpl
+        /**
+         * Executes extra tasks on template change
+         * @event component#template
+         * @param {function} componentTpl
          */
 
 
@@ -488,8 +488,8 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'i18n', 'lib/dompur
         return this;
       },
 
-      /**
-       * Get the component's configuration
+      /**
+       * Get the component's configuration
        */
       getConfig: function getConfig() {
         return this.config || defaults || {};