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

package/dist/themeLoader.js

@@ -3,23 +3,23 @@ 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) 2014-2021 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
-     *
+    /*
+     * 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) 2014-2021 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
+     *
      */
 
     //used to differentiate the stylesheets
@@ -29,18 +29,18 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
     const $container = $('head').length ? $('head') : $('body');
     const ns = 'themeloader';
 
-    /**
-     * @typedef {Object} Theme
-     * @property {String} id - theme identifier (unique)
-     * @property {String} path  - theme location
-     * @property {String} [name] - name to display
+    /**
+     * @typedef {Object} Theme
+     * @property {String} id - theme identifier (unique)
+     * @property {String} path  - theme location
+     * @property {String} [name] - name to display
      */
 
-    /**
-     * Trigger a theme change that is slightly delayed to be
-     * reasonably sure all styles have been applied.
-     *
-     * @param themeId
+    /**
+     * Trigger a theme change that is slightly delayed to be
+     * reasonably sure all styles have been applied.
+     *
+     * @param themeId
      */
     function triggerThemeChange(themeId) {
       _.delay(() => {
@@ -48,10 +48,10 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
       }, 200);
     }
 
-    /**
-     * Create a stylesheet tag
-     * @param {Theme} theme - the theme
-     * @return {jQuery} the link node
+    /**
+     * Create a stylesheet tag
+     * @param {Theme} theme - the theme
+     * @return {jQuery} the link node
      */
     function createStyleSheet(theme) {
       const suffix = theme.id === 'base' ? 'base' : 'theme';
@@ -66,54 +66,54 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
       });
     }
 
-    /**
-     * Get the stylesheet
-     * @param {String} id - the theme identifier
-     * @returns {jQuery} the link
+    /**
+     * Get the stylesheet
+     * @param {String} id - the theme identifier
+     * @returns {jQuery} the link
      */
     function getLink(id) {
       return $(`link[data-id="${id}"][data-type^="${prefix}"]`, $container);
     }
 
-    /**
-     * Is the stylesheet attached to the container ?
-     * @param {String} id - the theme identifier
+    /**
+     * Is the stylesheet attached to the container ?
+     * @param {String} id - the theme identifier
      */
     function isAttached(id) {
       return getLink(id).length > 0;
     }
 
-    /**
-     * Enable some nodes
-     * @param {jQuery} $nodes - the nodes to enable
-     * @returns {jQuery}
+    /**
+     * Enable some nodes
+     * @param {jQuery} $nodes - the nodes to enable
+     * @returns {jQuery}
      */
     function enable($nodes) {
       $nodes.prop('disabled', false).removeProp('disabled').removeAttr('disabled');
     }
 
-    /**
-     * Disable some nodes
-     * @param {jQuery} $nodes - the nodes to disable
-     * @returns {jQuery}
+    /**
+     * Disable some nodes
+     * @param {jQuery} $nodes - the nodes to disable
+     * @returns {jQuery}
      */
     function disable($nodes) {
       return $nodes.prop('disabled', true).attr('disabled', true); //add attr only for easiest inspection
     }
 
-    /**
-     * The themeLoader is a factory that returns a loader. Configured to load the given styles.
-     *
-     * @param {Object} config - the themes configuration
-     * @param {String} config.base - the location of the base style
-     * @param {String} [config.default] - the name of the default theme (one of the key of the available list )
-     * @param {Theme[]} config.available - the list of available themes
-     * @returns {Object} the loader
-     * @throws TypeError if the config hasn't the correct form
+    /**
+     * The themeLoader is a factory that returns a loader. Configured to load the given styles.
+     *
+     * @param {Object} config - the themes configuration
+     * @param {String} config.base - the location of the base style
+     * @param {String} [config.default] - the name of the default theme (one of the key of the available list )
+     * @param {Theme[]} config.available - the list of available themes
+     * @returns {Object} the loader
+     * @throws TypeError if the config hasn't the correct form
      */
     function themeLoader(config) {
-      /*
-       * validate config
+      /*
+       * validate config
        */
       if (!_.isPlainObject(config)) {
         throw new TypeError('Theme loader configuration is required');
@@ -130,8 +130,8 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
         }
       }
 
-      /*
-       * Extract data from config
+      /*
+       * Extract data from config
        */
       const defaultTheme = config.default || _.first(_.pluck(config.available, 'id'));
       let activeTheme = defaultTheme;
@@ -149,14 +149,14 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
         }
       });
 
-      /**
-       * The loader instance
+      /**
+       * The loader instance
        */
       return {
-        /**
-         * Load the themes
-         * @param {Boolean} [preload=false] - Only preload the themes without activating them
-         * @returns {Object} chains
+        /**
+         * Load the themes
+         * @param {Boolean} [preload=false] - Only preload the themes without activating them
+         * @returns {Object} chains
          */
         load(preload) {
           _.forEach(styles, ($link, id) => {
@@ -179,18 +179,18 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
           });
           return this;
         },
-        /**
-         * Unload the stylesheets (disable them)
-         * @returns {Object} chains
+        /**
+         * Unload the stylesheets (disable them)
+         * @returns {Object} chains
          */
         unload() {
           disable($(`link[data-type^="${prefix}"]`, $container));
           return this;
         },
-        /**
-         * Change the current theme
-         * @param {String} id - the theme id to use
-         * @returns {Object} chains
+        /**
+         * Change the current theme
+         * @param {String} id - the theme id to use
+         * @returns {Object} chains
          */
         change(id) {
           //support to change to the "default" theme regardless it's id
@@ -208,9 +208,9 @@ define(['jquery', 'lodash'], function ($, _) { 'use strict';
           }
           return this;
         },
-        /**
-         * Return the current theme
-         * @returns {String} activeTheme
+        /**
+         * Return the current theme
+         * @returns {String} activeTheme
          */
         getActiveTheme() {
           return activeTheme;

package/dist/themes.js

@@ -3,37 +3,37 @@ define(['lodash', 'module'], function (_, module) { 'use strict';
     _ = _ && Object.prototype.hasOwnProperty.call(_, 'default') ? _['default'] : _;
     module = module && Object.prototype.hasOwnProperty.call(module, 'default') ? module['default'] : module;
 
-    /*
-     * 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 themesConfig;
     var defaultNamespacePrefix = 'items';
 
-    /**
-     * Let you access to platform themes
-     * @exports ui/themes
+    /**
+     * Let you access to platform themes
+     * @exports ui/themes
      */
     var themes = {
-      /**
-       * Gets module config clone. Checks if there are differences between actual module config and a clone. If needed -
-       * clones it again.
-       *
-       * @returns {Object}
+      /**
+       * Gets module config clone. Checks if there are differences between actual module config and a clone. If needed -
+       * clones it again.
+       *
+       * @returns {Object}
        */
       getConfig: function getConfig() {
         // set theme config from module.config() if it is not defined
@@ -42,35 +42,35 @@ define(['lodash', 'module'], function (_, module) { 'use strict';
         }
         return themesConfig;
       },
-      /**
-       * Set themes config
-       * @param {Object} config Themes config
+      /**
+       * Set themes config
+       * @param {Object} config Themes config
        */
       setConfig(config) {
         themesConfig = _.cloneDeep(config);
       },
-      /**
-       * Gets default namespace prefix - currently 'items'
-       *
-       * @returns {string}
+      /**
+       * Gets default namespace prefix - currently 'items'
+       *
+       * @returns {string}
        */
       getDefaultNamespacePrefix: function getDefaultNamespacePrefix() {
         return defaultNamespacePrefix;
       },
-      /**
-       * Get the themes config.
-       * @example themes().get('items');
-       *
-       * If the config contains a activeNamespace property (for example, 'ns1'), then it will appended to the requested key
-       * For example, this will actually returns entries registered in 'items_ns1'
-       * @example themes().get('items');
-       *
-       * Namespace can by manually specified by a parameter. In that case, activeNamespace property is ignored.
-       * @example themes().get('items', 'ns2');
-       *
-       * @param {String} what - themes are classified, what is the theme for ?
-       * @param {String} [ns] - namespace of the 'what'
-       * @returns {Object?} the themes config
+      /**
+       * Get the themes config.
+       * @example themes().get('items');
+       *
+       * If the config contains a activeNamespace property (for example, 'ns1'), then it will appended to the requested key
+       * For example, this will actually returns entries registered in 'items_ns1'
+       * @example themes().get('items');
+       *
+       * Namespace can by manually specified by a parameter. In that case, activeNamespace property is ignored.
+       * @example themes().get('items', 'ns2');
+       *
+       * @param {String} what - themes are classified, what is the theme for ?
+       * @param {String} [ns] - namespace of the 'what'
+       * @returns {Object?} the themes config
        */
       get: function get(what, ns) {
         var config = this.getConfig();
@@ -83,21 +83,21 @@ define(['lodash', 'module'], function (_, module) { 'use strict';
           return config[what];
         }
       },
-      /**
-       * Get the list of available themes.
-       *
-       * @example themes().getAvailable('items');
-       *
-       * If the config contains a activeNamespace property (for example, 'ns1'), then it will appended to the requested key
-       * For example, this will actually returns entries registered in 'items_ns1'
-       * @example themes().getAvailable('items');
-       *
-       * Namespace can by manually specified by a parameter. In that case, activeNamespace property is ignored.
-       * @example themes().getAvailable('items', 'ns2');
-       * *
-       * @param {String} what - themes are classified, what is the theme for ?
-       * @param {String} [ns] - namespace of the 'what'
-       * @returns {Array} the themes
+      /**
+       * Get the list of available themes.
+       *
+       * @example themes().getAvailable('items');
+       *
+       * If the config contains a activeNamespace property (for example, 'ns1'), then it will appended to the requested key
+       * For example, this will actually returns entries registered in 'items_ns1'
+       * @example themes().getAvailable('items');
+       *
+       * Namespace can by manually specified by a parameter. In that case, activeNamespace property is ignored.
+       * @example themes().getAvailable('items', 'ns2');
+       * *
+       * @param {String} what - themes are classified, what is the theme for ?
+       * @param {String} [ns] - namespace of the 'what'
+       * @returns {Array} the themes
        */
       getAvailable: function getAvailable(what, ns) {
         var available = [];
@@ -107,37 +107,37 @@ define(['lodash', 'module'], function (_, module) { 'use strict';
         }
         return available;
       },
-      /**
-       * Get active namespace for themes
-       *
-       * Get activeNamespace property value from the config
-       *
-       * @returns {String} activeNamespace
+      /**
+       * Get active namespace for themes
+       *
+       * Get activeNamespace property value from the config
+       *
+       * @returns {String} activeNamespace
        */
       getActiveNamespace: function getActiveNamespace() {
         return this.getConfig().activeNamespace;
       },
-      /**
-       * Set active namespace for themes
-       *
-       * Explicitly sets activeNamespace property into config.
-       *
-       * @param {String} ns - activeNamespace value to be set into config
+      /**
+       * Set active namespace for themes
+       *
+       * Explicitly sets activeNamespace property into config.
+       *
+       * @param {String} ns - activeNamespace value to be set into config
        */
       setActiveNamespace: function setActiveNamespace(ns) {
         this.getConfig().activeNamespace = ns;
       },
-      /**
-       * Gets the current theme data from config
-       *
-       * @param {String} what - if provided themes data is loaded for provided argument. If not - will return "default" data - for `items`
-       *
-       * @example themes().getCurrentThemeData('items');
-       * @example themes().getCurrentThemeData();
-       * Both examples will return same data. Next example will load the theme data for 'platform' (if it exists):
-       * @example themes().getCurrentThemeData('platform');
-       *
-       * @returns {Object} the current theme data
+      /**
+       * Gets the current theme data from config
+       *
+       * @param {String} what - if provided themes data is loaded for provided argument. If not - will return "default" data - for `items`
+       *
+       * @example themes().getCurrentThemeData('items');
+       * @example themes().getCurrentThemeData();
+       * Both examples will return same data. Next example will load the theme data for 'platform' (if it exists):
+       * @example themes().getCurrentThemeData('platform');
+       *
+       * @returns {Object} the current theme data
        */
       getCurrentThemeData: function getCurrentThemeData(what) {
         var themeNamespace = this.getActiveNamespace();

package/dist/toggler.js

@@ -4,11 +4,11 @@ define(['jquery', 'core/pluginifier', 'core/dataattrhandler'], function ($, Plug
     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 core/pluginifier
-     * @requires core/dataattrhandler
+    /**
+     * @author Bertrand Chevrier <bertrand@taotesting.com>
+     * @requires jquery
+     * @requires core/pluginifier
+     * @requires core/dataattrhandler
      */
     var ns = 'toggler';
     var dataNs = 'ui.' + ns;
@@ -19,27 +19,27 @@ define(['jquery', 'core/pluginifier', 'core/dataattrhandler'], function ($, Plug
       closedClass: 'closed'
     };
 
-    /**
-     * The Toggler component, that helps you to show/hide an element
-     * @exports ui/toggler
+    /**
+     * The Toggler component, that helps you to show/hide an element
+     * @exports ui/toggler
      */
     var Toggler = {
-      /**
-       * Initialize the plugin.
-       *
-       * Called the jQuery way once registered by the Pluginifier.
-       * @example $('selector').toggler({target : $('target') });
-       * @public
-       *
-       * @constructor
-       * @param {Object} options - the plugin options
-       * @param {jQueryElement} options.target - the element to be toggled
-       * @param {string|boolean} [options.bindEvent = 'click'] - the event that triggers the toggling
-       * @param {string} [options.openedClass = 'opened'] - the css added to element (not the target) for the opened state
-       * @param {string} [options.closedClass = 'closed'] - the css added to element (not the target) for the closed state
-       * @param {string} [options.hideText] - the text to replace the toggler with when the element is toggled (ie. Show -> Hide)
-       * @fires Toggler#create.toggler
-       * @returns {jQueryElement} for chaining
+      /**
+       * Initialize the plugin.
+       *
+       * Called the jQuery way once registered by the Pluginifier.
+       * @example $('selector').toggler({target : $('target') });
+       * @public
+       *
+       * @constructor
+       * @param {Object} options - the plugin options
+       * @param {jQueryElement} options.target - the element to be toggled
+       * @param {string|boolean} [options.bindEvent = 'click'] - the event that triggers the toggling
+       * @param {string} [options.openedClass = 'opened'] - the css added to element (not the target) for the opened state
+       * @param {string} [options.closedClass = 'closed'] - the css added to element (not the target) for the closed state
+       * @param {string} [options.hideText] - the text to replace the toggler with when the element is toggled (ie. Show -> Hide)
+       * @fires Toggler#create.toggler
+       * @returns {jQueryElement} for chaining
        */
       init: function (options) {
         //get options using default
@@ -82,35 +82,35 @@ define(['jquery', 'core/pluginifier', 'core/dataattrhandler'], function ($, Plug
               });
             }
 
-            /**
-             * The plugin have been created.
-             * @event Toggler#create.toggler
+            /**
+             * The plugin have been created.
+             * @event Toggler#create.toggler
              */
             $elt.trigger('create.' + ns);
           }
         });
       },
-      /**
-       * Toggle the target.
-       *
-       * Called the jQuery way once registered by the Pluginifier.
-       * @example $('selector').toggler('toggle');
-       * @param {jQueryElement} $elt - plugin's element
-       * @fires Toggler#toggle.toggler
-       * @fires Toggler#open.toggler
-       * @fires Toggler#close.toggler
+      /**
+       * Toggle the target.
+       *
+       * Called the jQuery way once registered by the Pluginifier.
+       * @example $('selector').toggler('toggle');
+       * @param {jQueryElement} $elt - plugin's element
+       * @fires Toggler#toggle.toggler
+       * @fires Toggler#open.toggler
+       * @fires Toggler#close.toggler
        */
       _toggle: function ($elt) {
         const options = $elt.data(dataNs);
         const $target = options.target;
         let action;
         var triggerEvents = function triggerEvents() {
-          /**
-           * The target has been toggled.
-           * Trigger 2 events : toggle and open or close.
-           * @event Toggler#toggle.toggler
-           * @event Toggler#open.toggler
-           * @event Toggler#close.toggler
+          /**
+           * The target has been toggled.
+           * Trigger 2 events : toggle and open or close.
+           * @event Toggler#toggle.toggler
+           * @event Toggler#open.toggler
+           * @event Toggler#close.toggler
            */
           $elt.trigger('toggle.' + ns, [$target]).trigger(`${action}.${ns}`, [$target]);
 
@@ -135,12 +135,12 @@ define(['jquery', 'core/pluginifier', 'core/dataattrhandler'], function ($, Plug
           }
         }
       },
-      /**
-       * Destroy completely the plugin.
-       *
-       * Called the jQuery way once registered by the Pluginifier.
-       * @example $('selector').toggler('destroy');
-       * @public
+      /**
+       * Destroy completely the plugin.
+       *
+       * Called the jQuery way once registered by the Pluginifier.
+       * @example $('selector').toggler('destroy');
+       * @public
        */
       destroy: function () {
         this.each(function () {
@@ -150,9 +150,9 @@ define(['jquery', 'core/pluginifier', 'core/dataattrhandler'], function ($, Plug
             $elt.off(options.bindEvent);
           }
 
-          /**
-           * The plugin have been destroyed.
-           * @event Toggler#destroy.toggler
+          /**
+           * The plugin have been destroyed.
+           * @event Toggler#destroy.toggler
            */
           $elt.trigger('destroy.' + ns);
         });
@@ -164,12 +164,12 @@ define(['jquery', 'core/pluginifier', 'core/dataattrhandler'], function ($, Plug
       expose: ['toggle']
     });
 
-    /**
-     * The only exposed function is used to start listening on data-attr
-     *
-     * @public
-     * @example define(['ui/toggler'], function(toggler){ toggler($('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/toggler'], function(toggler){ toggler($('rootContainer')); });
+     * @param {jQueryElement} $container - the root context to listen in
      */
     function listenDataAttr($container) {
       new DataAttrHandler('toggle', {