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

package/dist/form/widget/widget.js

@@ -25,24 +25,24 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
     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) {
@@ -135,10 +135,10 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
     if (helper = helpers.widgetType) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.widgetType); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\">\r\n    <div class=\"widget-label\">\r\n        ";
+      + "\">\n    <div class=\"widget-label\">\n        ";
     stack1 = self.invokePartial(partials['ui-form-widget-label'], 'ui-form-widget-label', depth0, helpers, partials, data);
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n    </div>\r\n    <div class=\"widget-field\">\r\n        <input class=\"widget-input-inline\" ";
+    buffer += "\n    </div>\n    <div class=\"widget-field\">\n        <input class=\"widget-input-inline\" ";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.type), {hash:{},inverse:self.noop,fn:self.program(1, program1, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
     buffer += "name=\"";
@@ -149,7 +149,7 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
     if (helper = helpers.value) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.value); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\" />\r\n    </div>\r\n</div>\r\n";
+      + "\" />\n    </div>\n</div>\n";
     return buffer;
     });
   function widgetTpl(data, options, asString) {
@@ -169,9 +169,9 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
   function program1(depth0,data) {
     
     var buffer = "", helper, options;
-    buffer += "\r\n    <abbr title=\""
+    buffer += "\n    <abbr title=\""
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "This field is required", options) : helperMissing.call(depth0, "__", "This field is required", options)))
-      + "\">*</abbr>\r\n    ";
+      + "\">*</abbr>\n    ";
     return buffer;
     }
 
@@ -179,14 +179,14 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
     if (helper = helpers.uri) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.uri); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\">\r\n    ";
+      + "\">\n    ";
     if (helper = helpers.label) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.label); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\r\n    ";
+      + "\n    ";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.required), {hash:{},inverse:self.noop,fn:self.program(1, program1, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n</label>\r\n";
+    buffer += "\n</label>\n";
     return buffer;
     });
   function labelTpl(data, options, asString) {
@@ -194,47 +194,47 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
     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) 2019 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) 2019 Open Assessment Technologies SA ;
    */
-  /**
-   * @typedef {Object} widgetConfig Defines the config entries available to setup a form widget
-   * @property {String} widget - The type of widget.
-   *                             It will be used by the main factory to retrieve
-   *                             the implementation from the internal registry.
-   * @property {String} widgetType - The internal type of widget
-   * @property {String} uri - The identifier of the widget
-   * @property {String} [label] - The label of the widget
-   * @property {String|String[]} [value] - The value of the widget. Depending on the widget's type,
-   *                                       it can be a single or a multiple value
-   * @property {widgetRangeValue[]} [range] - Array of values used in multi-elements widgets (like combo or checkbox)
-   * @property {Boolean} [required] - Tells if the value is required
-   * @property {validationRule|validationRule[]|validator} [validation] - Optional validators to add
+  /**
+   * @typedef {Object} widgetConfig Defines the config entries available to setup a form widget
+   * @property {String} widget - The type of widget.
+   *                             It will be used by the main factory to retrieve
+   *                             the implementation from the internal registry.
+   * @property {String} widgetType - The internal type of widget
+   * @property {String} uri - The identifier of the widget
+   * @property {String} [label] - The label of the widget
+   * @property {String|String[]} [value] - The value of the widget. Depending on the widget's type,
+   *                                       it can be a single or a multiple value
+   * @property {widgetRangeValue[]} [range] - Array of values used in multi-elements widgets (like combo or checkbox)
+   * @property {Boolean} [required] - Tells if the value is required
+   * @property {validationRule|validationRule[]|validator} [validation] - Optional validators to add
    */
 
-  /**
-   * @typedef {Object} widgetRangeValue Defines a value to use in a widget range
-   * @property {String} uri - The identifier of the value
-   * @property {String} label - The label for the value
+  /**
+   * @typedef {Object} widgetRangeValue Defines a value to use in a widget range
+   * @property {String} uri - The identifier of the value
+   * @property {String} label - The label for the value
    */
 
-  /**
-   * Some default config
-   * @type {widgetConfig}
+  /**
+   * Some default config
+   * @type {widgetConfig}
    */
 
   var defaults = {
@@ -244,11 +244,11 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
     value: '',
     range: []
   };
-  /**
-   * Gets the provider with respect to the provided config
-   * @param {widgetConfig} config
-   * @returns {Object}
-   * @throws {TypeError} if the config is not valid or if the provider does not exist
+  /**
+   * Gets the provider with respect to the provided config
+   * @param {widgetConfig} config
+   * @returns {Object}
+   * @throws {TypeError} if the config is not valid or if the provider does not exist
    */
 
   function getWidgetProvider(config) {
@@ -266,10 +266,10 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
 
     return widgetFactory.getProvider(config.widget);
   }
-  /**
-   * Makes sure a value is an array
-   * @param {*} value
-   * @returns {Array}
+  /**
+   * Makes sure a value is an array
+   * @param {*} value
+   * @returns {Array}
    */
 
 
@@ -282,40 +282,40 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
 
     return value;
   }
-  /**
-   * Factory that builds a form element based on its config.
-   *
-   * * @example
-   *  const container = $('.my-container', $container);
-   *
-   *  widgetFactory.registerProvider('textinput', widgetTextInputProvider);
-   *
-   *  const config = {
-   *          widget: 'textinput'
-   *          uri: 'text',
-   *          label: 'Text',
-   *          required: true
-   *  };
-   *
-   *  const widget = widgetFactory(container, config)
-   *      .on('change', function(value) {
-   *          // ...
-   *      });
-   *
-   * @param {HTMLElement|String} container
-   * @param {widgetConfig} config
-   * @param {String} config.widget - The type of widget.
-   *                                 It will be used by the main factory to retrieve
-   *                                 the implementation from the internal registry.
-   * @param {String} config.uri - The identifier of the widget
-   * @param {String} [config.label] - The label of the widget
-   * @param {String|String[]} [config.value] - The value of the widget. Depending on the widget's type,
-   *                                           it can be a single or a multiple value
-   * @param {widgetRangeValue[]} [config.range] - Array of values used in multi-elements widgets (like combo or checkbox)
-   * @param {Boolean} [config.required] - Tells if the value is required
-   * @param {validationRule|validationRule[]|validator} [config.validation] - Optional validators to add
-   * @returns {widgetForm}
-   * @fires ready - When the component is ready to work
+  /**
+   * Factory that builds a form element based on its config.
+   *
+   * * @example
+   *  const container = $('.my-container', $container);
+   *
+   *  widgetFactory.registerProvider('textinput', widgetTextInputProvider);
+   *
+   *  const config = {
+   *          widget: 'textinput'
+   *          uri: 'text',
+   *          label: 'Text',
+   *          required: true
+   *  };
+   *
+   *  const widget = widgetFactory(container, config)
+   *      .on('change', function(value) {
+   *          // ...
+   *      });
+   *
+   * @param {HTMLElement|String} container
+   * @param {widgetConfig} config
+   * @param {String} config.widget - The type of widget.
+   *                                 It will be used by the main factory to retrieve
+   *                                 the implementation from the internal registry.
+   * @param {String} config.uri - The identifier of the widget
+   * @param {String} [config.label] - The label of the widget
+   * @param {String|String[]} [config.value] - The value of the widget. Depending on the widget's type,
+   *                                           it can be a single or a multiple value
+   * @param {widgetRangeValue[]} [config.range] - Array of values used in multi-elements widgets (like combo or checkbox)
+   * @param {Boolean} [config.required] - Tells if the value is required
+   * @param {validationRule|validationRule[]|validator} [config.validation] - Optional validators to add
+   * @returns {widgetForm}
+   * @fires ready - When the component is ready to work
    */
 
 
@@ -324,10 +324,10 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
     var validator;
     var validatorRenderer;
     var provider = getWidgetProvider(config);
-    /**
-     * Reflects the invalid state to the component
-     * @param {Boolean} invalid
-     * @param {String[]} [messages]
+    /**
+     * Reflects the invalid state to the component
+     * @param {Boolean} invalid
+     * @param {String[]} [messages]
      */
 
     var setInvalidState = function setInvalidState(invalid, messages) {
@@ -341,11 +341,11 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
         }
       }
     };
-    /**
-     * Delegate a call to the provider, or fallback to the default implementation
-     * @param {String} method - The name of the method to call.
-     * @param {...} args - Extra parameters
-     * @returns {*}
+    /**
+     * Delegate a call to the provider, or fallback to the default implementation
+     * @param {String} method - The name of the method to call.
+     * @param {...} args - Extra parameters
+     * @returns {*}
      */
 
 
@@ -360,56 +360,56 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
 
       return defaultProvider[method].apply(widget, args);
     };
-    /**
-     * Triggers the change event
-     * @returns {widgetForm}
-     * @fires change
+    /**
+     * Triggers the change event
+     * @returns {widgetForm}
+     * @fires change
      */
 
 
     var notifyChange = function notifyChange() {
-      /**
-       * @event change
-       * @param {String|String[]} value
-       * @param {String} uri
+      /**
+       * @event change
+       * @param {String|String[]} value
+       * @param {String} uri
        */
       widget.trigger('change', widget.getValue(), widget.getUri());
     };
-    /**
-     * @typedef {component} widgetForm
+    /**
+     * @typedef {component} widgetForm
      */
 
 
     var widgetApi = {
-      /**
-       * Gets the widget's URI
-       * @returns {String}
+      /**
+       * Gets the widget's URI
+       * @returns {String}
        */
       getUri: function getUri() {
         return this.getConfig().uri;
       },
 
-      /**
-       * Gets the value of the widget
-       * @returns {String|String[]}
+      /**
+       * Gets the value of the widget
+       * @returns {String|String[]}
        */
       getValue: function getValue() {
         return delegate('getValue');
       },
 
-      /**
-       * Gets the raw value of the widget
-       * @returns {*}
+      /**
+       * Gets the raw value of the widget
+       * @returns {*}
        */
       getRawValue: function getRawValue() {
         return delegate('getRawValue');
       },
 
-      /**
-       * Sets the value of the widget
-       * @param {String|String[]} value
-       * @returns {widgetForm}
-       * @fires change after the value has been changed
+      /**
+       * Sets the value of the widget
+       * @param {String|String[]} value
+       * @returns {widgetForm}
+       * @fires change after the value has been changed
        */
       setValue: function setValue(value) {
         this.getConfig().value = value;
@@ -418,18 +418,18 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
         return this;
       },
 
-      /**
-       * Gets access to the validation engine
-       * @returns {validator}
+      /**
+       * Gets access to the validation engine
+       * @returns {validator}
        */
       getValidator: function getValidator() {
         return validator;
       },
 
-      /**
-       * Sets the validation engine
-       * @param {validationRule|validationRule[]|validator} validation
-       * @returns {widgetForm}
+      /**
+       * Sets the validation engine
+       * @param {validationRule|validationRule[]|validator} validation
+       * @returns {widgetForm}
        */
       setValidator: function setValidator(validation) {
         if (validation && _.isFunction(validation.validate)) {
@@ -451,9 +451,9 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
         return this;
       },
 
-      /**
-       * Resets the widget to the default validators
-       * @returns {widgetForm}
+      /**
+       * Resets the widget to the default validators
+       * @returns {widgetForm}
        */
       setDefaultValidators: function setDefaultValidators() {
         // restore factory default validators
@@ -463,9 +463,9 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
         return this;
       },
 
-      /**
-       * Resets the widget to its default value
-       * @returns {widgetForm}
+      /**
+       * Resets the widget to its default value
+       * @returns {widgetForm}
        */
       reset: function reset() {
         delegate('reset');
@@ -473,9 +473,9 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
         return this;
       },
 
-      /**
-       * Validates the widget
-       * @returns {Promise}
+      /**
+       * Validates the widget
+       * @returns {Promise}
        */
       validate: function validate() {
         return this.getValidator().validate(this.getRawValue()).then(function (res) {
@@ -487,9 +487,9 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
         });
       },
 
-      /**
-       * Gets access to the actual form element
-       * @returns {jQuery|null}
+      /**
+       * Gets access to the actual form element
+       * @returns {jQuery|null}
        */
       getWidgetElement: function getWidgetElement() {
         if (this.is('rendered')) {
@@ -521,8 +521,8 @@ define(['lodash', 'i18n', 'handlebars', 'core/providerRegistry', 'ui/component',
           notifyChange();
         }
       });
-      /**
-       * @event ready
+      /**
+       * @event ready
        */
 
       validatorRenderer = validatorRendererFactory(this.getElement()).spread(this, 'error ready');

package/dist/form.js

@@ -2,9 +2,9 @@ define(['jquery'], function ($) { 'use strict';
 
     $ = $ && Object.prototype.hasOwnProperty.call($, 'default') ? $['default'] : $;
 
-    /**
-     * Toggle radios and checkboxes wrapped into a pseudo label element to simulate the behavior of a label
-     * @param {String} selector - to scope the listening
+    /**
+     * Toggle radios and checkboxes wrapped into a pseudo label element to simulate the behavior of a label
+     * @param {String} selector - to scope the listening
      */
 
     var pseudoLabel = function pseudoLabel(selector) {
@@ -25,9 +25,9 @@ define(['jquery'], function ($) { 'use strict';
         }
       });
     };
-    /**
-     * Prevent clicks and focus on disbled elements
-     * @param {String} selector - to scope the listening
+    /**
+     * Prevent clicks and focus on disbled elements
+     * @param {String} selector - to scope the listening
      */
 
 
@@ -37,10 +37,10 @@ define(['jquery'], function ($) { 'use strict';
         return false;
       });
     };
-    /**
-     * Manages general behavior on form elements
-     *
-     * @param {jQueryElement} $container - the root context to lookup inside
+    /**
+     * Manages general behavior on form elements
+     *
+     * @param {jQueryElement} $container - the root context to lookup inside
      */