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

package/dist/button.js

@@ -21,24 +21,24 @@ define(['ui/component', 'handlebars', 'i18n', 'lodash', 'lib/dompurify/purify'],
     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) {
@@ -178,14 +178,14 @@ define(['ui/component', 'handlebars', 'i18n', 'lodash', 'lib/dompurify/purify'],
       + "\"";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.title), {hash:{},inverse:self.noop,fn:self.program(7, program7, 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(9, program9, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n    <span class=\"label\">";
+    buffer += "\n    <span class=\"label\">";
     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)
-      + "</span>\r\n</button>\r\n";
+      + "</span>\n</button>\n";
     return buffer;
     });
   function buttonTpl(data, options, asString) {
@@ -193,99 +193,99 @@ define(['ui/component', 'handlebars', 'i18n', 'lodash', 'lib/dompurify/purify'],
     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) 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 ;
    */
-  /**
-   * Some default config
-   * @type {Object}
+  /**
+   * Some default config
+   * @type {Object}
    */
 
   var defaults = {
     small: true
   };
-  /**
-   * @typedef {Object} buttonConfig Defines the config entries available to setup a button
-   * @property {String} id - The identifier of the button
-   * @property {String} label - The caption of the button
-   * @property {String} [title] - An optional tooltip for the button
-   * @property {String} [icon] - An optional icon for the button
-   * @property {String} [type] - The type of button to build
-   * @property {Boolean} [small] - Whether build a small button (default: true)
-   * @property {String} [cls] - An additional CSS class name
+  /**
+   * @typedef {Object} buttonConfig Defines the config entries available to setup a button
+   * @property {String} id - The identifier of the button
+   * @property {String} label - The caption of the button
+   * @property {String} [title] - An optional tooltip for the button
+   * @property {String} [icon] - An optional icon for the button
+   * @property {String} [type] - The type of button to build
+   * @property {Boolean} [small] - Whether build a small button (default: true)
+   * @property {String} [cls] - An additional CSS class name
    */
 
-  /**
-   * Builds a simple button component.
-   *
-   * @example
-   *  // button with simple action
-   *  const button = buttonFactory({
-   *      id: 'foo',
-   *      label: 'Foo',
-   *      title: 'Foo Bar',
-   *      icon: 'globe',
-   *      type: 'info'
-   *  })
-   *      .on('click', function() {
-   *          // do something
-   *      })
-   *      .render(container);
-   *
-   *  // button with handling of async action
-   *  const button = buttonFactory({
-   *      id: 'foo',
-   *      label: 'Foo',
-   *      title: 'Foo Bar',
-   *      icon: 'globe',
-   *      type: 'info'
-   *  })
-   *      .before('click', function(){
-   *          this.disable();
-   *      })
-   *      .on('click', function() {
-   *          return new Promise(resolve => {
-   *              // do something
-   *              resolve();
-   *          });
-   *      })
-   *      .after('click', function(){
-   *          this.enable();
-   *      })
-   *      .render(container);
-   *
-   * @param {buttonConfig} config
-   * @param {String} config.id - The identifier of the button
-   * @param {String} config.label - The caption of the button
-   * @param {String} [config.title] - An optional tooltip for the button
-   * @param {String} [config.icon] - An optional icon for the button
-   * @param {String} [config.type] - The type of button to build
-   * @param {Boolean} [config.small] - Whether build a small button (default: true)
-   * @param {String} [config.cls] - An additional CSS class name
-   * @returns {button}
-   * @fires click - When the button is clicked
-   * @fires ready - When the button is ready to work
+  /**
+   * Builds a simple button component.
+   *
+   * @example
+   *  // button with simple action
+   *  const button = buttonFactory({
+   *      id: 'foo',
+   *      label: 'Foo',
+   *      title: 'Foo Bar',
+   *      icon: 'globe',
+   *      type: 'info'
+   *  })
+   *      .on('click', function() {
+   *          // do something
+   *      })
+   *      .render(container);
+   *
+   *  // button with handling of async action
+   *  const button = buttonFactory({
+   *      id: 'foo',
+   *      label: 'Foo',
+   *      title: 'Foo Bar',
+   *      icon: 'globe',
+   *      type: 'info'
+   *  })
+   *      .before('click', function(){
+   *          this.disable();
+   *      })
+   *      .on('click', function() {
+   *          return new Promise(resolve => {
+   *              // do something
+   *              resolve();
+   *          });
+   *      })
+   *      .after('click', function(){
+   *          this.enable();
+   *      })
+   *      .render(container);
+   *
+   * @param {buttonConfig} config
+   * @param {String} config.id - The identifier of the button
+   * @param {String} config.label - The caption of the button
+   * @param {String} [config.title] - An optional tooltip for the button
+   * @param {String} [config.icon] - An optional icon for the button
+   * @param {String} [config.type] - The type of button to build
+   * @param {Boolean} [config.small] - Whether build a small button (default: true)
+   * @param {String} [config.cls] - An additional CSS class name
+   * @returns {button}
+   * @fires click - When the button is clicked
+   * @fires ready - When the button is ready to work
    */
 
   function buttonFactory(config) {
     return componentFactory({
-      /**
-       * Gets the identifier of the button
-       * @returns {String}
+      /**
+       * Gets the identifier of the button
+       * @returns {String}
        */
       getId: function getId() {
         return this.getConfig().id;
@@ -296,15 +296,15 @@ define(['ui/component', 'handlebars', 'i18n', 'lodash', 'lib/dompurify/purify'],
 
       this.getElement().on('click', function (e) {
         e.preventDefault();
-        /**
-         * @event click
-         * @param {String} buttonId
+        /**
+         * @event click
+         * @param {String} buttonId
          */
 
         _this.trigger('click', _this.getId());
       });
-      /**
-       * @event ready
+      /**
+       * @event ready
        */
 
       this.trigger('ready');

package/dist/calculator/css/calculator.css

@@ -1,9 +1,9 @@
-/*
-Usage:
-- linear-gradient((color1, color2, color3)) - returns linear-gradient with evenly distributed colors,
-   if 3 colors used then the position of each will be 33,33%
-- linear-gradient((color1 0%, color2 30%, color3 80%)) - returns linear-gradient with manually distributed colors,
-   first param - color, second - position. Also you can use px or other valid units for set position.
+/*
+Usage:
+- linear-gradient((color1, color2, color3)) - returns linear-gradient with evenly distributed colors,
+   if 3 colors used then the position of each will be 33,33%
+- linear-gradient((color1 0%, color2 30%, color3 80%)) - returns linear-gradient with manually distributed colors,
+   first param - color, second - position. Also you can use px or other valid units for set position.
 */
 /* based on "visually-hidden" mixin in LDS for accessibility goals */
 /* Do not edit */
@@ -49,9 +49,9 @@ Usage:
     height: 100%;
     padding: 0 20px 20px;
     width: 100%;
-    /*
-            * the font-size of the parent element of the calculator will serve as the reference for the children.
-            * the children must use em unit for font-sizing to ensure proportional increase when resized.
+    /*
+            * the font-size of the parent element of the calculator will serve as the reference for the children.
+            * the children must use em unit for font-sizing to ensure proportional increase when resized.
             */
     font-size: 10px;
 }
@@ -158,5 +158,5 @@ Usage:
 .dynamic-component-container .calcContainer form input.triggered, .dynamic-component-container .calcContainer form button.triggered {
     background: #6597b9;
 }
-
+
 /*# sourceMappingURL=calculator.css.map */

package/dist/calculator.js

@@ -6,22 +6,22 @@ define(['jquery', 'lodash', 'i18n', 'ui/dynamicComponent', 'lib/calculator/index
     dynamicComponent = dynamicComponent && Object.prototype.hasOwnProperty.call(dynamicComponent, 'default') ? dynamicComponent['default'] : dynamicComponent;
     calculatorBuild = calculatorBuild && Object.prototype.hasOwnProperty.call(calculatorBuild, 'default') ? calculatorBuild['default'] : calculatorBuild;
 
-    /**
-     * 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 _defaults = {
       title: __('Calculator'),
@@ -32,12 +32,12 @@ define(['jquery', 'lodash', 'i18n', 'ui/dynamicComponent', 'lib/calculator/index
       minHeight: 220,
       alternativeTemplate: null
     };
-    /**
-     * Calculate the new font size according to the width and height ratio during component resizing.
-     * It has been calculated to match a reference font-size of 10px when the calculator content is 240px wide and 330 height.
-     * @param {Number} width
-     * @param {Number} height
-     * @returns {Number}
+    /**
+     * Calculate the new font size according to the width and height ratio during component resizing.
+     * It has been calculated to match a reference font-size of 10px when the calculator content is 240px wide and 330 height.
+     * @param {Number} width
+     * @param {Number} height
+     * @returns {Number}
      */
 
     var computeFontSize = function computeFontSize(width, height) {
@@ -54,10 +54,10 @@ define(['jquery', 'lodash', 'i18n', 'ui/dynamicComponent', 'lib/calculator/index
         return this;
       }
     };
-    /**
-     * Computes the ratio between width and height of the applied font family.
-     * @param {jQuery} $element
-     * @returns {Number}
+    /**
+     * Computes the ratio between width and height of the applied font family.
+     * @param {jQuery} $element
+     * @returns {Number}
      */
 
     function getFontRatio($element) {
@@ -74,11 +74,11 @@ define(['jquery', 'lodash', 'i18n', 'ui/dynamicComponent', 'lib/calculator/index
       $sample.remove();
       return fontRatio;
     }
-    /**
-     * Adjust the font size of the parent element will automatically scale the font-size of the children proportionally
-     * @param {jQuery} $text
-     * @param {Number} fontRatio
-     * @param {Number} fontSize
+    /**
+     * Adjust the font size of the parent element will automatically scale the font-size of the children proportionally
+     * @param {jQuery} $text
+     * @param {Number} fontRatio
+     * @param {Number} fontSize
      */
 
 
@@ -100,26 +100,26 @@ define(['jquery', 'lodash', 'i18n', 'ui/dynamicComponent', 'lib/calculator/index
 
       $text.css('fontSize', fontSize);
     }
-    /**
-     * Builds an instance of the calculator 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 {String} [config.title] - title to be displayed in the title bar
-     * @param {Boolean} [config.resizable] - allow the component to be resizable
-     * @param {Boolean} [config.draggable] - allow the component to be draggable
-     * @param {Number} [config.width] - the initial width of the component content
-     * @param {Number} [config.height] - the intial height of the component content
-     * @param {Number} [config.minWidth] - the min width for resize
-     * @param {Number} [config.maxWidth] - the max width for resize
-     * @param {Number} [config.largeWidthThreshold] - the width below which the container will get the class "small"
-     * @param {Number} [config.smallWidthThreshold] - the width above which the container will get the class "large"
-     * @param {jQuery|HTMLElement|String} [config.draggableContainer] - the DOMElement the draggable component will be constraint in
-     * @param {Number} [config.top] - the initial position top absolute to the windows
-     * @param {Number} [config.left] - the initial position left absolute to the windows
-     * @param {Function} [config.alternativeTemplate] - allow defining an alternative template (a handlebar cimpiled template function)
-     * @param {String} [config.stackingScope] - The scope in which to stack the component
-     * @returns {calculator}
+    /**
+     * Builds an instance of the calculator 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 {String} [config.title] - title to be displayed in the title bar
+     * @param {Boolean} [config.resizable] - allow the component to be resizable
+     * @param {Boolean} [config.draggable] - allow the component to be draggable
+     * @param {Number} [config.width] - the initial width of the component content
+     * @param {Number} [config.height] - the intial height of the component content
+     * @param {Number} [config.minWidth] - the min width for resize
+     * @param {Number} [config.maxWidth] - the max width for resize
+     * @param {Number} [config.largeWidthThreshold] - the width below which the container will get the class "small"
+     * @param {Number} [config.smallWidthThreshold] - the width above which the container will get the class "large"
+     * @param {jQuery|HTMLElement|String} [config.draggableContainer] - the DOMElement the draggable component will be constraint in
+     * @param {Number} [config.top] - the initial position top absolute to the windows
+     * @param {Number} [config.left] - the initial position left absolute to the windows
+     * @param {Function} [config.alternativeTemplate] - allow defining an alternative template (a handlebar cimpiled template function)
+     * @param {String} [config.stackingScope] - The scope in which to stack the component
+     * @returns {calculator}
      */
 
 

package/dist/cascadingComboBox.js

@@ -22,24 +22,24 @@ define(['jquery', 'lodash', 'i18n', 'ui/component', 'handlebars', '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) {
@@ -131,7 +131,7 @@ define(['jquery', 'lodash', 'i18n', 'ui/component', 'handlebars', 'lib/dompurify
   function program3(depth0,data) {
     
     var buffer = "", stack1, helper;
-    buffer += "\r\n        <option value=\"";
+    buffer += "\n        <option value=\"";
     if (helper = helpers.id) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.id); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
@@ -143,21 +143,21 @@ define(['jquery', 'lodash', 'i18n', 'ui/component', 'handlebars', 'lib/dompurify
     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)
-      + "</option>\r\n        ";
+      + "</option>\n        ";
     return buffer;
     }
 
-    buffer += "<span class=\"cascading-combo-box\">\r\n    ";
+    buffer += "<span class=\"cascading-combo-box\">\n    ";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.comboboxLabel), {hash:{},inverse:self.noop,fn:self.program(1, program1, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n    <select class=\"\" data-id=\"";
+    buffer += "\n    <select class=\"\" data-id=\"";
     if (helper = helpers.comboboxId) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.comboboxId); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\" data-has-search=\"false\">\r\n        <option></option>\r\n        ";
+      + "\" data-has-search=\"false\">\n        <option></option>\n        ";
     stack1 = helpers.each.call(depth0, (depth0 && depth0.options), {hash:{},inverse:self.noop,fn:self.program(3, program3, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n    </select>\r\n</span>";
+    buffer += "\n    </select>\n</span>";
     return buffer;
     });
   function selectTpl(data, options, asString) {
@@ -165,31 +165,31 @@ define(['jquery', 'lodash', 'i18n', 'ui/component', 'handlebars', '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) 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 selectedValues = {};
-  /**
-   * Create a combobox and initialize it with select2
-   *
-   * @param {Number} level
-   * @param {array} categoriesDefinitions - the array that defines the number and config for each level of combobox cascade
-   * @param {array} categories - the array that contains nested array of categories
-   * @returns {jQuery}
+  /**
+   * Create a combobox and initialize it with select2
+   *
+   * @param {Number} level
+   * @param {array} categoriesDefinitions - the array that defines the number and config for each level of combobox cascade
+   * @param {array} categories - the array that contains nested array of categories
+   * @returns {jQuery}
    */
 
   function createCombobox(level, categoriesDefinitions, categories) {
@@ -265,11 +265,11 @@ define(['jquery', 'lodash', 'i18n', 'ui/component', 'handlebars', 'lib/dompurify
       throw 'missing category definition on level : ' + level;
     }
   }
-  /**
-   * @param {object} options
-   * @param {Array} [options.categoriesDefinitions] - the array that defines the number and config for each level of combobox cascade
-   * @param {Array} [options.categories] - the array that contains nested array of categories
-   * @returns {function}
+  /**
+   * @param {object} options
+   * @param {Array} [options.categoriesDefinitions] - the array that defines the number and config for each level of combobox cascade
+   * @param {Array} [options.categories] - the array that contains nested array of categories
+   * @returns {function}
    */