@oat-sa/tao-core-ui 1.60.2 → 1.61.0

package/dist/form/dropdownForm.js

@@ -23,24 +23,24 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
     hb.registerHelper('__', function (key) {
       return __(key);
     });
-    /**
-     * Register dompurify helper
-     *
-     * https://github.com/cure53/DOMPurify
-     * with config SAFE_FOR_TEMPLATES: true
-     * to make output safe for template systems
+    /**
+     * Register dompurify helper
+     *
+     * https://github.com/cure53/DOMPurify
+     * with config SAFE_FOR_TEMPLATES: true
+     * to make output safe for template systems
      */
 
     hb.registerHelper('dompurify', function (context) {
       return DOMPurify.sanitize(context);
     });
-    /**
-     * Register join helper
-     *
-     * Example :
-     * var values = {a:v1, b:v2, c:v3};
-     * Using {{{join attributes '=' ' ' '"'}}} will return : a="v1" b="v2" c="v3"
-     * Using {{{join values null ' or ' '*'}}} will return : *v1* or *v2* or *v3*
+    /**
+     * Register join helper
+     *
+     * Example :
+     * var values = {a:v1, b:v2, c:v3};
+     * Using {{{join attributes '=' ' ' '"'}}} will return : a="v1" b="v2" c="v3"
+     * Using {{{join values null ' or ' '*'}}} will return : *v1* or *v2* or *v3*
      */
 
     hb.registerHelper('join', function (arr, keyValueGlue, fragmentGlue, wrapper) {
@@ -118,45 +118,45 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
   helpers = this.merge(helpers, Handlebars.helpers);  
 
 
-    return "<div class=\"dropdown-form\">\r\n    <div class=\"trigger-button\"></div>\r\n    <div class=\"form-panel\"></div>\r\n</div>\r\n";
+    return "<div class=\"dropdown-form\">\n    <div class=\"trigger-button\"></div>\n    <div class=\"form-panel\"></div>\n</div>\n";
     });
   function dropdownFormTpl(data, options, asString) {
     var html = Template(data, options);
     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} dropdownFormConfig Defines the config entries available to setup a dropdown form
-   * @property {String} [triggerText] - The caption of the trigger button
-   * @property {String} [triggerIcon] - The icon of the trigger button
-   * @property {String} [submitText] - The caption of the submit button
-   * @property {String} [submitIcon] - The icon of the submit button
-   * @property {widgetConfig[]} [widgets] - The list of widgets to set in the form (default none)
-   * @property {buttonConfig[]} [buttons] - The list of buttons to set in the form (default none)
-   * @property {Object} [values] - Initial values for the widgets
-   * @property {Object} [ranges] - An optional list of ranges for the widgets (@see widgetConfig.range)
+  /**
+   * @typedef {Object} dropdownFormConfig Defines the config entries available to setup a dropdown form
+   * @property {String} [triggerText] - The caption of the trigger button
+   * @property {String} [triggerIcon] - The icon of the trigger button
+   * @property {String} [submitText] - The caption of the submit button
+   * @property {String} [submitIcon] - The icon of the submit button
+   * @property {widgetConfig[]} [widgets] - The list of widgets to set in the form (default none)
+   * @property {buttonConfig[]} [buttons] - The list of buttons to set in the form (default none)
+   * @property {Object} [values] - Initial values for the widgets
+   * @property {Object} [ranges] - An optional list of ranges for the widgets (@see widgetConfig.range)
    */
 
-  /**
-   * Some default config
-   * @type {Object}
+  /**
+   * Some default config
+   * @type {Object}
    */
 
   var defaults = {
@@ -165,46 +165,46 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
     submitIcon: null,
     submitText: __('Submit')
   };
-  /**
-   * Builds a dropdown form component.
-   *
-   * @example
-   *  const container = $('.my-container', $container);
-   *
-   *  const config = {
-   *      title: 'My fancy form',
-   *      triggerText: 'Comment',
-   *      submitText: 'Publish',
-   *      widgets: [{
-   *          widget: widgetDefinitions.TEXTBOX
-   *          uri: 'nickname',
-   *          label: 'Name',
-   *          required: true
-   *      }, {
-   *          widget: widgetDefinitions.TEXTAREA
-   *          uri: 'comment',
-   *          label: 'Comment',
-   *          required: true
-   *      }]
-   *  };
-   *
-   *  const form = dropdownFormFactory(container, config)
-   *      .on('submit', function(values) {
-   *          // ...
-   *      });
-   *
-   * @param {HTMLElement|String} container
-   * @param {dropdownFormConfig} config
-   * @param {String} [config.triggerText] - The caption of the trigger button
-   * @param {String} [config.triggerIcon] - The icon of the trigger button
-   * @param {String} [config.submitText] - The caption of the submit button
-   * @param {String} [config.submitIcon] - The icon of the submit button
-   * @param {widgetConfig[]} [config.widgets] - The list of widgets to set in the form (default none)
-   * @param {buttonConfig[]} [config.buttons] - The list of buttons to set in the form (default none)
-   * @param {Object} [config.values] - Initial values for the widgets
-   * @param {Object} [config.ranges] - An optional list of ranges for the widgets (@see widgetConfig.range)
-   * @returns {dropdownForm}
-   * @fires ready - When the component is ready to work
+  /**
+   * Builds a dropdown form component.
+   *
+   * @example
+   *  const container = $('.my-container', $container);
+   *
+   *  const config = {
+   *      title: 'My fancy form',
+   *      triggerText: 'Comment',
+   *      submitText: 'Publish',
+   *      widgets: [{
+   *          widget: widgetDefinitions.TEXTBOX
+   *          uri: 'nickname',
+   *          label: 'Name',
+   *          required: true
+   *      }, {
+   *          widget: widgetDefinitions.TEXTAREA
+   *          uri: 'comment',
+   *          label: 'Comment',
+   *          required: true
+   *      }]
+   *  };
+   *
+   *  const form = dropdownFormFactory(container, config)
+   *      .on('submit', function(values) {
+   *          // ...
+   *      });
+   *
+   * @param {HTMLElement|String} container
+   * @param {dropdownFormConfig} config
+   * @param {String} [config.triggerText] - The caption of the trigger button
+   * @param {String} [config.triggerIcon] - The icon of the trigger button
+   * @param {String} [config.submitText] - The caption of the submit button
+   * @param {String} [config.submitIcon] - The icon of the submit button
+   * @param {widgetConfig[]} [config.widgets] - The list of widgets to set in the form (default none)
+   * @param {buttonConfig[]} [config.buttons] - The list of buttons to set in the form (default none)
+   * @param {Object} [config.values] - Initial values for the widgets
+   * @param {Object} [config.ranges] - An optional list of ranges for the widgets (@see widgetConfig.range)
+   * @returns {dropdownForm}
+   * @fires ready - When the component is ready to work
    */
 
   function dropdownFormFactory(container, config) {
@@ -212,19 +212,19 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
     var button = null;
     var controls = null;
     var api = {
-      /**
-       * Gets access to the form
-       * @returns {form}
+      /**
+       * Gets access to the form
+       * @returns {form}
        */
       getForm: function getForm() {
         return form;
       },
 
-      /**
-       * Update the form with a new list of widgets
-       * @param {widgetConfig[]} widgets
-       * @returns {Promise}
-       * @throws {Error} if the form is not yet rendered
+      /**
+       * Update the form with a new list of widgets
+       * @param {widgetConfig[]} widgets
+       * @returns {Promise}
+       * @throws {Error} if the form is not yet rendered
        */
       setFormWidgets: function setFormWidgets(widgets) {
         if (!this.is('rendered') || !form) {
@@ -234,9 +234,9 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
         return form.setWidgets(widgets);
       },
 
-      /**
-       * Gets the values from the form widgets
-       * @returns {Object}
+      /**
+       * Gets the values from the form widgets
+       * @returns {Object}
        */
       getFormValues: function getFormValues() {
         if (this.is('rendered')) {
@@ -246,10 +246,10 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
         return {};
       },
 
-      /**
-       * Sets the values to the form widgets
-       * @param {Object} values
-       * @returns {dropdownForm}
+      /**
+       * Sets the values to the form widgets
+       * @param {Object} values
+       * @returns {dropdownForm}
        */
       setFormValues: function setFormValues(values) {
         if (this.is('rendered')) {
@@ -259,10 +259,10 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
         return this;
       },
 
-      /**
-       * Opens the form attached to the dropdown
-       * @returns {dropdownForm}
-       * @fires open - When the form is open
+      /**
+       * Opens the form attached to the dropdown
+       * @returns {dropdownForm}
+       * @fires open - When the form is open
        */
       openForm: function openForm() {
         this.setState('open', true); // the event is emitted only if the component is rendered.
@@ -275,8 +275,8 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
             this.setState('open-on-left', true);
             this.setState('open-on-right', false);
           }
-          /**
-           * @event open
+          /**
+           * @event open
            */
 
 
@@ -286,10 +286,10 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
         return this;
       },
 
-      /**
-       * Closes the form attached to the dropdown
-       * @returns {dropdownForm}
-       * @fires close - When the form is closed
+      /**
+       * Closes the form attached to the dropdown
+       * @returns {dropdownForm}
+       * @fires close - When the form is closed
        */
       closeForm: function closeForm() {
         this.setState('open', false);
@@ -297,8 +297,8 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
         this.setState('open-on-right', false); // the event is emitted only if the component is rendered.
 
         if (this.is('rendered')) {
-          /**
-           * @event open
+          /**
+           * @event open
            */
           this.trigger('close');
         }
@@ -343,8 +343,8 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
           _this2.openForm();
         }
       }).render(controls.$trigger);
-      /**
-       * @event ready
+      /**
+       * @event ready
        */
 
       form = formFactory(controls.$form, formConfig).spread(this, 'ready change submit invalid error');