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

package/dist/component.js

@@ -22,27 +22,27 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
       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() {
       let width = this.config.width;
@@ -73,11 +73,11 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
       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}
      */
     function component(specs, defaults) {
       // the template is a private property
@@ -90,19 +90,19 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
       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) {
@@ -110,9 +110,9 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
           }).defaults(defaults || {}).value();
           componentState = {};
 
-          /**
-           * Executes extra init tasks
-           * @event component#init
+          /**
+           * Executes extra init tasks
+           * @event component#init
            */
           this.trigger('init');
           if (this.config.renderTo) {
@@ -121,15 +121,15 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
           }
           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');
           if (this.$component) {
@@ -139,11 +139,11 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
           componentState = {};
           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) {
@@ -159,20 +159,20 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
           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;
@@ -181,19 +181,19 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
             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
            */
           this.trigger('setsize', width, height);
           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')) {
@@ -203,10 +203,10 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
             };
           }
         },
-        /**
-         * 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;
@@ -219,76 +219,76 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
             };
           }
         },
-        /**
-         * 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;
@@ -297,42 +297,42 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
             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
            */
           this.trigger('state', state, flag, this);
           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;
@@ -345,16 +345,16 @@ define(['jquery', 'lodash', 'core/eventifier', 'handlebars', 'lib/handlebars/hel
             };
           }
 
-          /**
-           * Executes extra tasks on template change
-           * @event component#template
-           * @param {function} componentTpl
+          /**
+           * Executes extra tasks on template change
+           * @event component#template
+           * @param {function} componentTpl
            */
           this.trigger('template', componentTpl);
           return this;
         },
-        /**
-         * Get the component's configuration
+        /**
+         * Get the component's configuration
          */
         getConfig: function getConfig() {
           return this.config || defaults || {};

package/dist/container.js

@@ -3,28 +3,28 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
     $ = $ && Object.prototype.hasOwnProperty.call($, 'default') ? $['default'] : $;
     _ = _ && Object.prototype.hasOwnProperty.call(_, 'default') ? _['default'] : _;
 
-    /**
-     * 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) 2017 (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) 2017 (original work) Open Assessment Technologies SA ;
      */
 
-    /**
-     * Extract CSS class names from a selector
-     * @param {String} selector
-     * @returns {String}
+    /**
+     * Extract CSS class names from a selector
+     * @param {String} selector
+     * @returns {String}
      */
     function getCssClass(selector) {
       var parts;
@@ -37,22 +37,22 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
       return parts.join(' ');
     }
 
-    /**
-     * Defines a container manager
-     * @param {String} [containerSelector] - The CSS selector of the container (default: .container)
-     * @returns {containerManager}
+    /**
+     * Defines a container manager
+     * @param {String} [containerSelector] - The CSS selector of the container (default: .container)
+     * @returns {containerManager}
      */
     function containerFactory(containerSelector) {
       var $container;
       var containerCls;
 
-      /**
-       * @typedef {containerManager}
+      /**
+       * @typedef {containerManager}
        */
       var containerManager = {
-        /**
-         * Initializes the component.
-         * @param {String} cssScope
+        /**
+         * Initializes the component.
+         * @param {String} cssScope
          */
         init: function init(cssScope) {
           if (!cssScope || !_.isString(cssScope)) {
@@ -63,25 +63,25 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
           $container = $(containerSelector);
           return this;
         },
-        /**
-         * Cleans up component and release resources
+        /**
+         * Cleans up component and release resources
          */
         destroy: function destroy() {
           $container = null;
           return this;
         },
-        /**
-         * Checks if the container has the wanted scope
-         * @param {String} scope
-         * @returns {Boolean}
+        /**
+         * Checks if the container has the wanted scope
+         * @param {String} scope
+         * @returns {Boolean}
          */
         hasScope: function hasScope(scope) {
           return !!($container && $container.is(scope));
         },
-        /**
-         * Changes the scope of the container
-         * @param {String} scope
-         * @returns {containerManager}
+        /**
+         * Changes the scope of the container
+         * @param {String} scope
+         * @returns {containerManager}
          */
         changeScope: function changeScope(scope) {
           if ($container) {
@@ -92,85 +92,85 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
           }
           return this;
         },
-        /**
-         * Find an element that belongs to the container.
-         * @param {String} selector
-         * @returns {jQuery}
+        /**
+         * Find an element that belongs to the container.
+         * @param {String} selector
+         * @returns {jQuery}
          */
         find: function find(selector) {
           return $container.find(selector);
         },
-        /**
-         * Writes content into the container.
-         * @param content
-         * @returns {containerManager}
+        /**
+         * Writes content into the container.
+         * @param content
+         * @returns {containerManager}
          */
         write: function write(content) {
           $container.html(content);
           return this;
         },
-        /**
-         * Gets the data encoded into the DOM.
-         * @returns {Object}
+        /**
+         * Gets the data encoded into the DOM.
+         * @returns {Object}
          */
         getData: function getData() {
           return $container.data();
         },
-        /**
-         * Sets the data encoded into the DOM.
-         * @param {Object} data
-         * @returns {containerManager}
+        /**
+         * Sets the data encoded into the DOM.
+         * @param {Object} data
+         * @returns {containerManager}
          */
         setData: function setData(data) {
           $container.removeData().data(data);
           return this;
         },
-        /**
-         * Remove the data encoded into the DOM.
-         * @returns {containerManager}
+        /**
+         * Remove the data encoded into the DOM.
+         * @returns {containerManager}
          */
         removeData: function removeData() {
           $container.removeData();
           return this;
         },
-        /**
-         * Checks whether a value has been encoded into the DOM.
-         * @param {String} name
-         * @returns {Boolean}
+        /**
+         * Checks whether a value has been encoded into the DOM.
+         * @param {String} name
+         * @returns {Boolean}
          */
         hasValue: function hasValue(name) {
           var data = this.getData();
           return 'undefined' !== typeof (data && data[name]);
         },
-        /**
-         * Gets a value encoded into the DOM.
-         * @param {String} name
-         * @returns {*}
+        /**
+         * Gets a value encoded into the DOM.
+         * @param {String} name
+         * @returns {*}
          */
         getValue: function getValue(name) {
           var data = this.getData();
           return data && data[name];
         },
-        /**
-         * Encodes into the DOM.
-         * @param {String} name
-         * @param {Object} value
-         * @returns {containerManager}
+        /**
+         * Encodes into the DOM.
+         * @param {String} name
+         * @param {Object} value
+         * @returns {containerManager}
          */
         setValue: function setValue(name, value) {
           $container.data(name, value);
           return this;
         },
-        /**
-         * Gets access to the container element
-         * @returns {jQuery}
+        /**
+         * Gets access to the container element
+         * @returns {jQuery}
          */
         getElement: function getElement() {
           return $container;
         },
-        /**
-         * Gets the container's selector
-         * @returns {String}
+        /**
+         * Gets the container's selector
+         * @returns {String}
          */
         getSelector: function getSelector() {
           return containerSelector;