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

package/dist/form/dropdownForm.js

@@ -17,46 +17,46 @@ 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}
      */
     const defaults = {
       triggerIcon: null,
@@ -65,64 +65,64 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
       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) {
       let form = null;
       let button = null;
       let controls = null;
       const api = {
-        /**
-         * Gets access to the form
-         * @returns {form}
+        /**
+         * Gets access to the form
+         * @returns {form}
          */
         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(widgets) {
           if (!this.is('rendered') || !form) {
@@ -130,9 +130,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() {
           if (this.is('rendered')) {
@@ -140,10 +140,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(values) {
           if (this.is('rendered')) {
@@ -151,10 +151,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() {
           this.setState('open', true);
@@ -169,17 +169,17 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
               this.setState('open-on-right', false);
             }
 
-            /**
-             * @event open
+            /**
+             * @event open
              */
             this.trigger('open');
           }
           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() {
           this.setState('open', false);
@@ -188,8 +188,8 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
 
           // the event is emitted only if the component is rendered.
           if (this.is('rendered')) {
-            /**
-             * @event open
+            /**
+             * @event open
              */
             this.trigger('close');
           }
@@ -232,8 +232,8 @@ define(['lodash', 'i18n', 'ui/component', 'ui/button', 'ui/form/simpleForm', 'ha
           }
         }).render(controls.$trigger);
 
-        /**
-         * @event ready
+        /**
+         * @event ready
          */
         form = formFactory(controls.$form, formConfig).spread(this, 'ready change submit invalid error');
       }).on('ready', function onDropdownFormReady() {