@formio/js 5.0.0-dev.5647.4cf82e8 → 5.0.0-dev.5650.cd53187

package/lib/cjs/components/_classes/component/Component.js

@@ -22,6 +22,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -193,9 +202,7 @@ class Component extends Element_1.default {
     }
     /**
      * Return the simple condition settings as part of the component.
-     *
-     * @return {Object}
-     *
+     * @returns {object} - The simple conditional settings.
      */
     static get conditionOperatorsSettings() {
         return {
@@ -212,10 +219,8 @@ class Component extends Element_1.default {
     }
     /**
      * Return the array of possible types of component value absed on its schema.
-     *
      * @param schema
-     * @return {Array}
-     *
+     * @returns {Array}
      */
     static savedValueTypes(schema) {
         schema = schema || {};
@@ -224,7 +229,6 @@ class Component extends Element_1.default {
     /**
      * Provides a table view for this component. Override if you wish to do something different than using getView
      * method of your instance.
-     *
      * @param value
      * @param options
      */
@@ -233,10 +237,9 @@ class Component extends Element_1.default {
     /* eslint-enable no-unused-vars */
     /**
      * Initialize a new Component.
-     *
-     * @param {Object} component - The component JSON you wish to initialize.
-     * @param {Object} options - The options for this component.
-     * @param {Object} data - The global data submission object this component will belong.
+     * @param {object} component - The component JSON you wish to initialize.
+     * @param {object} options - The options for this component.
+     * @param {object} data - The global data submission object this component will belong.
      */
     /* eslint-disable max-statements */
     constructor(component, options, data) {
@@ -267,7 +270,6 @@ class Component extends Element_1.default {
         }
         /**
          * The data path to this specific component instance.
-         *
          * @type {string}
          */
         this.path = (component === null || component === void 0 ? void 0 : component.key) || '';
@@ -315,32 +317,27 @@ class Component extends Element_1.default {
         this.row = this.options.row;
         /**
          * Points to a flat map of child components (if applicable).
-         *
-         * @type {Object}
+         * @type {object}
          */
         this.childComponentsMap = {};
         /**
          * Determines if this component is disabled, or not.
-         *
          * @type {boolean}
          */
         this._disabled = (0, utils_1.boolValue)(this.component.disabled) ? this.component.disabled : false;
         /**
          * Points to the root component, usually the FormComponent.
-         *
          * @type {Component}
          */
         this.root = this.options.root || this;
         this.localRoot = this.options.localRoot || this;
         /**
          * If this input has been input and provided value.
-         *
          * @type {boolean}
          */
         this.pristine = true;
         /**
          * Points to the parent component.
-         *
          * @type {Component}
          */
         this.parent = this.options.parent;
@@ -360,7 +357,7 @@ class Component extends Element_1.default {
         this._referenceAttributeName = 'ref';
         /**
          * Used to trigger a new change in this component.
-         * @type {function} - Call to trigger a change in this component.
+         * @type {Function} - Call to trigger a change in this component.
          */
         let changes = [];
         let lastChanged = null;
@@ -401,7 +398,6 @@ class Component extends Element_1.default {
         };
         /**
          * Used to trigger a redraw event within this component.
-         *
          * @type {Function}
          */
         this.triggerRedraw = lodash_1.default.debounce(this.redraw.bind(this), 100);
@@ -603,8 +599,8 @@ class Component extends Element_1.default {
         return this.shouldForceVisibility(component, 'show');
     }
     /**
-     *
-     * @param value {boolean}
+     * Sets the component visibility.
+     * @param {boolean} value - Whether the component should be visible or not.
      */
     set visible(value) {
         if (this._visible !== value) {
@@ -622,8 +618,8 @@ class Component extends Element_1.default {
         }
     }
     /**
-     *
-     * @returns {boolean}
+     * Returns the component visibility
+     * @returns {boolean} - Whether the component is visible or not.
      */
     get visible() {
         // Show only if visibility changes or if we are in builder mode or if hidden fields should be shown.
@@ -713,9 +709,10 @@ class Component extends Element_1.default {
     }
     /**
      * Returns only the schema that is different from the default.
-     *
-     * @param schema
-     * @param defaultSchema
+     * @param {object} schema - The "full" json schema for the component.
+     * @param {object} defaultSchema - The "default" json schema for the component.
+     * @param {boolean} recursion - If we are currently in a recursive loop.
+     * @returns {object} - The minified json schema for this component.
      */
     getModifiedSchema(schema, defaultSchema, recursion) {
         const modified = {};
@@ -749,21 +746,24 @@ class Component extends Element_1.default {
     }
     /**
      * Returns the JSON schema for this component.
+     * @returns {object} - The JSON schema for this component.
      */
     get schema() {
         return (0, utils_1.fastCloneDeep)(this.getModifiedSchema(lodash_1.default.omit(this.component, 'id'), this.defaultSchema));
     }
     /**
      * Returns true if component is inside DataGrid
+     * @returns {boolean} - True if component is inside DataGrid
      */
     get isInDataGrid() {
         return this.inDataGrid;
     }
     /**
      * Translate a text using the i18n system.
-     *
      * @param {string} text - The i18n identifier.
-     * @param {Object} params - The i18n parameters to use for translation.
+     * @param {object} params - The i18n parameters to use for translation.
+     * @param {...any} args - Additional arguments to pass to the translation library.
+     * @returns {string} - The translated text.
      */
     t(text, params = {}, ...args) {
         if (!text) {
@@ -853,7 +853,7 @@ class Component extends Element_1.default {
     isHtmlRenderMode() {
         return this.options.renderMode === 'html';
     }
-    renderTemplate(name, data = {}, modeOption) {
+    renderTemplate(name, data = {}, modeOption = '') {
         // Need to make this fall back to form if renderMode is not found similar to how we search templates.
         const mode = modeOption || this.options.renderMode || 'form';
         data.component = this.component;
@@ -893,11 +893,12 @@ class Component extends Element_1.default {
     }
     /**
      * Sanitize an html string.
-     *
-     * @param string
-     * @returns {*}
+     * @param {string} dirty - The dirty html string to sanitize.
+     * @param {boolean} forceSanitize - If we should force the sanitize to occur.
+     * @param {object} options - The options for the sanitize.
+     * @returns {*} - The sanitized html string.
      */
-    sanitize(dirty, forceSanitize, options) {
+    sanitize(dirty, forceSanitize = false, options = {}) {
         var _a;
         if (!this.shouldSanitizeValue && !forceSanitize) {
             return dirty;
@@ -908,12 +909,9 @@ class Component extends Element_1.default {
     }
     /**
      * Render a template string into html.
-     *
-     * @param template
-     * @param data
-     * @param actions
-     *
-     * @return {HTMLElement|String} - The created element or an empty string if template is not specified.
+     * @param {string} template - The template to render.
+     * @param {object} data - The data to provide to the template.
+     * @returns {HTMLElement | string} - The created element or an empty string if template is not specified.
      */
     renderString(template, data) {
         if (!template) {
@@ -922,9 +920,18 @@ class Component extends Element_1.default {
         // Interpolate the template and populate
         return this.interpolate(template, data);
     }
+    /**
+     * Allows for modification of the component value prior to submission.
+     * @param {*} input - The input to be modified.
+     * @returns {*} - The modified input mapping for the extended component.
+     */
     performInputMapping(input) {
         return input;
     }
+    /**
+     * Returns the component "widget" if one is available.
+     * @returns {Widget|null} - The widget instance. null if not available.
+     */
     get widget() {
         var _a;
         const settings = this.component.widget;
@@ -934,6 +941,10 @@ class Component extends Element_1.default {
         const widget = settings && widgets_1.default[settings.type] ? new widgets_1.default[settings.type](settings, this.component, this) : null;
         return widget;
     }
+    /**
+     * Returns the native supported browser language.
+     * @returns {string|null} - The native browser language that is supported.
+     */
     getBrowserLanguage() {
         const nav = window.navigator;
         const browserLanguagePropertyKeys = ['language', 'browserLanguage', 'systemLanguage', 'userLanguage'];
@@ -957,38 +968,46 @@ class Component extends Element_1.default {
         return null;
     }
     /**
-     * Called before a next and previous page is triggered allowing the components
-     * to perform special functions.
-     *
-     * @return {*}
+     * Called before a next and previous page is triggered allowing the components to perform special functions.
+     * @returns {Promise<boolean>} - A promise to resolve when the component is no longer blocking the next/previous page navigation.
      */
     beforePage() {
         return Promise.resolve(true);
     }
+    /**
+     * Called before the next page is triggered allowing the components to hook into the page navigation and perform tasks.
+     * @returns {Promise<boolean>} - A promise to resolve when the component is no longer blocking the next page navigation.
+     */
     beforeNext() {
         return this.beforePage(true);
     }
     /**
-     * Called before a submission is triggered allowing the components
-     * to perform special async functions.
-     *
-     * @return {*}
+     * Called before a submission is triggered allowing the components to perform special async functions.
+     * @returns {Promise<boolean>} - A promise to resolve when the component is no longer blocking the submission.
      */
     beforeSubmit() {
         return Promise.resolve(true);
     }
     /**
      * Return the submission timezone.
-     *
-     * @return {*}
+     * @returns {string} - The submission timezone.
      */
     get submissionTimezone() {
         this.options.submissionTimezone = this.options.submissionTimezone || lodash_1.default.get(this.root, 'options.submissionTimezone');
         return this.options.submissionTimezone;
     }
+    /**
+     * Return the current timezone.
+     * @returns {string} - The current timezone.
+     */
     get timezone() {
         return this.getTimezone(this.component);
     }
+    /**
+     * Return the current timezone.
+     * @param {object} settings - Settings to control how the timezone should be returned.
+     * @returns {string} - The current timezone.
+     */
     getTimezone(settings) {
         if (settings.timezone) {
             return settings.timezone;
@@ -1012,6 +1031,9 @@ class Component extends Element_1.default {
      * @param {string} [referenceAttributeName] - The attribute name to use for the reference.
      */
     loadRefs(element, refs, referenceAttributeName) {
+        if (!element) {
+            return;
+        }
         for (const ref in refs) {
             const refType = refs[ref];
             const isString = typeof refType === 'string';
@@ -1026,9 +1048,25 @@ class Component extends Element_1.default {
             }
         }
     }
-    setOpenModalElement(template) {
+    /**
+     * Opens the modal element.
+     * @param {string} template - The template to use for the modal dialog.
+     */
+    setOpenModalElement(template = null) {
         this.componentModal.setOpenModalElement(template || this.getModalPreviewTemplate());
     }
+    /**
+     * Renders a modal preview template and returns the markup as a string
+     * @param {object|null|undefined} ctx - The rendering context
+     * @returns {string} - The modal preview markup
+     */
+    renderModalPreview(ctx) {
+        return this.renderTemplate('modalPreview', ctx || {});
+    }
+    /**
+     * Returns the modal preview template.
+     * @returns {string} - The modal preview template.
+     */
     getModalPreviewTemplate() {
         var _a;
         const dataValue = this.component.type === 'password' ? this.dataValue.replace(/./g, '•') : this.dataValue;
@@ -1036,12 +1074,17 @@ class Component extends Element_1.default {
         if (this.hasInput && ((_a = this.component.validate) === null || _a === void 0 ? void 0 : _a.required) && !this.isPDFReadOnlyMode) {
             modalLabel = { className: 'field-required' };
         }
-        return this.renderTemplate('modalPreview', {
+        return this.renderModalPreview({
             previewText: this.getValueAsString(dataValue, { modalPreview: true }) || this.t('Click to set value'),
             messages: '',
             labelInfo: modalLabel,
         });
     }
+    /**
+     * Performs a complete build of a component, which empties, renders, sets the content in the DOM, and then finally attaches events.
+     * @param {HTMLElement} element - The element to attach this component to.
+     * @returns {Promise<void>} - A promise that resolves when the component has been built.
+     */
     build(element) {
         element = element || this.element;
         this.empty(element);
@@ -1051,6 +1094,12 @@ class Component extends Element_1.default {
     get hasModalSaveButton() {
         return true;
     }
+    /**
+     * Renders a component as an HTML string.
+     * @param {string} children - The contents of all the children HTML as a string.
+     * @param {boolean} topLevel - If this is the topmost component that is being rendered.
+     * @returns {string} - The rendered HTML string of a component.
+     */
     render(children = `Unknown component: ${this.component.type}`, topLevel = false) {
         const isVisible = this.visible;
         this.rendered = true;
@@ -1074,27 +1123,46 @@ class Component extends Element_1.default {
             }, topLevel);
         }
     }
+    /**
+     * Creates the tooltip instance using tippy.js and returns it
+     * @param {HTMLElement} tooltipEl - HTML element to attach the tooltip
+     * @param {object|null|undefined} settings - tippy.js options
+     * @returns {import('tippy.js').Tippy} - tippy.js instance
+     */
+    createTooltip(tooltipEl, settings = {}) {
+        const tooltipAttribute = tooltipEl.getAttribute('data-tooltip');
+        const tooltipDataTitle = tooltipEl.getAttribute('data-title');
+        const tooltipText = this.interpolate(tooltipDataTitle || tooltipAttribute)
+            .replace(/(?:\r\n|\r|\n)/g, '<br />');
+        return (0, tippy_js_1.default)(tooltipEl, Object.assign(Object.assign({ allowHTML: true, trigger: 'mouseenter click focus', placement: 'right', zIndex: 10000, interactive: true }, settings), { content: this.t(this.sanitize(tooltipText), { _userInput: true }) }));
+    }
+    /**
+     * Attaches all the tooltips provided the refs object.
+     * @param {object} toolTipsRefs - The refs for the tooltips within your template.
+     * @returns {void}
+     */
     attachTooltips(toolTipsRefs) {
         toolTipsRefs === null || toolTipsRefs === void 0 ? void 0 : toolTipsRefs.forEach((tooltip, index) => {
             if (tooltip) {
-                const tooltipAttribute = tooltip.getAttribute('data-tooltip');
-                const tooltipDataTitle = tooltip.getAttribute('data-title');
-                const tooltipText = this.interpolate(tooltipDataTitle || tooltipAttribute)
-                    .replace(/(?:\r\n|\r|\n)/g, '<br />');
-                this.tooltips[index] = (0, tippy_js_1.default)(tooltip, {
-                    allowHTML: true,
-                    trigger: 'mouseenter click focus',
-                    placement: 'right',
-                    zIndex: 10000,
-                    interactive: true,
-                    content: this.t(this.sanitize(tooltipText), { _userInput: true }),
-                });
+                this.tooltips[index] = this.createTooltip(tooltip);
             }
         });
     }
+    /**
+     * Create a new component modal for this component.
+     * @param {HTMLElement} element - The element to attach the modal to.
+     * @param {boolean} modalShouldBeOpened - TRUE if the modal should open immediately.
+     * @param {any} currentValue - The current value of the component.
+     * @returns {ComponentModal} - The created component modal.
+     */
     createComponentModal(element, modalShouldBeOpened, currentValue) {
         return new ComponentModal_1.default(this, element, modalShouldBeOpened, currentValue, this._referenceAttributeName);
     }
+    /**
+     * Attaches all event listensers for this component to the DOM elements that were rendered.
+     * @param {HTMLElement} element - The element to attach the listeners to.
+     * @returns {Promise<void>} - Resolves when the component is done attaching to the DOM.
+     */
     attach(element) {
         if (!this.builderMode && !this.previewMode && this.component.modalEdit) {
             const modalShouldBeOpened = this.componentModal ? this.componentModal.isOpened : false;
@@ -1132,6 +1200,9 @@ class Component extends Element_1.default {
         this.addons.forEach((addon) => addon.attach(element));
         return Promise.resolve();
     }
+    /**
+     * Restors the "focus" on a component after a redraw event has occured.
+     */
     restoreFocus() {
         var _a, _b, _c;
         const isFocused = ((_b = (_a = this.root) === null || _a === void 0 ? void 0 : _a.focusedComponent) === null || _b === void 0 ? void 0 : _b.path) === this.path;
@@ -1141,6 +1212,12 @@ class Component extends Element_1.default {
             this.restoreCaretPosition();
         }
     }
+    /**
+     * Adds a keyboard shortcut to this component.
+     * @param {HTMLElement} element - The element to attach the keyboard shortcut to.
+     * @param {string} shortcut - The keyboard shortcut to add.
+     * @returns {void}
+     */
     addShortcut(element, shortcut) {
         // Avoid infinite recursion.
         if (!element || !this.root || (this.root === this)) {
@@ -1151,6 +1228,12 @@ class Component extends Element_1.default {
         }
         this.root.addShortcut(element, shortcut);
     }
+    /**
+     * Removes a keyboard shortcut from this component.
+     * @param {HTMLElement} element - The element to remove the keyboard shortcut from.
+     * @param {string} shortcut - The keyboard shortcut to remove.
+     * @returns {void}
+     */
     removeShortcut(element, shortcut) {
         // Avoid infinite recursion.
         if (!element || (this.root === this)) {
@@ -1183,6 +1266,13 @@ class Component extends Element_1.default {
             this.tooltip.destroy();
         }
     }
+    /**
+     * Determines if the component should be refreshed based on the path of another component that changed.
+     * @param {string} refreshData - The path of the data that needs to trigger a refresh.
+     * @param {boolean} changed - Flag that is true if the data has been changed.
+     * @param {any} flags - The flags for the checkData procedure.
+     * @returns {void}
+     */
     checkRefresh(refreshData, changed, flags) {
         const changePath = lodash_1.default.get(changed, 'instance.path', false);
         // Don't let components change themselves.
@@ -1199,6 +1289,12 @@ class Component extends Element_1.default {
             this.refresh(changed.value, changed, flags);
         }
     }
+    /**
+     * Iterates over a list of changes, and determines if the component should be refreshed if it is configured to refresh on any of those components.
+     * @param {Array<any>} changes - The list of components that have changed.
+     * @param {any} flags - The checkData flags.
+     * @returns {void}
+     */
     checkRefreshOn(changes, flags = {}) {
         changes = changes || [];
         if (flags.noRefresh) {
@@ -1220,8 +1316,8 @@ class Component extends Element_1.default {
     }
     /**
      * Refreshes the component with a new value.
-     *
-     * @param value
+     * @param {any} value - The latest value of the component to check if it needs to be refreshed.
+     * @returns {void}
      */
     refresh(value) {
         if (this.hasOwnProperty('refreshOnValue')) {
@@ -1244,8 +1340,8 @@ class Component extends Element_1.default {
      * with the components data and returns true if they are in the same context.
      *
      * Different rows of the same EditGrid, for example, are in different contexts.
-     *
-     * @param component
+     * @param {any} component - The component to check if it is in the same context as this component.
+     * @returns {boolean} - TRUE if the component is in the same context as this component.
      */
     inContext(component) {
         if (component.data === this.data) {
@@ -1260,9 +1356,18 @@ class Component extends Element_1.default {
         }
         return false;
     }
+    /**
+     * Determines if we are in "view" only mode.
+     * @returns {boolean} - TRUE if we are in "view" only mode.
+     */
     get viewOnly() {
         return this.options.readOnly && this.options.viewAsHtml;
     }
+    /**
+     * Sets the HTMLElement for this component.
+     * @param {HTMLElement} element - The element that is attached to this component.
+     * @returns {void}
+     */
     setElement(element) {
         if (this.element) {
             delete this.element.component;
@@ -1270,6 +1375,10 @@ class Component extends Element_1.default {
         }
         this.element = element;
     }
+    /**
+     * Creates an element to hold the "view only" version of this component.
+     * @returns {HTMLElement} - The element for this component.
+     */
     createViewOnlyElement() {
         this.setElement(this.ce('dl', {
             id: this.id
@@ -1280,14 +1389,18 @@ class Component extends Element_1.default {
         }
         return this.element;
     }
+    /**
+     * The default value for the "view only" mode of a component if the value is not provided.
+     * @returns {string} - The default value for this component.
+     */
     get defaultViewOnlyValue() {
         return '-';
     }
     /**
      * Uses the widget to determine the output string.
-     *
-     * @param value
-     * @return {*}
+     * @param {any} value - The current value of the component.
+     * @param {any} options - The options for getValueAsString.
+     * @returns {any|Array<any>} - The value as a string.
      */
     getWidgetValueAsString(value, options) {
         const noInputWidget = !this.refs.input || !this.refs.input[0] || !this.refs.input[0].widget;
@@ -1312,6 +1425,12 @@ class Component extends Element_1.default {
         const widget = this.refs.input[0].widget;
         return widget.getValueAsString(value, options);
     }
+    /**
+     * Returns the value of the component as a string.
+     * @param {any} value - The value for this component.
+     * @param {any} options - The options for this component.
+     * @returns {string} - The string representation of the value of this component.
+     */
     getValueAsString(value, options) {
         if (!value) {
             return '';
@@ -1329,20 +1448,32 @@ class Component extends Element_1.default {
         const stringValue = value.toString();
         return this.sanitize(stringValue);
     }
+    /**
+     * Returns the string representation "view" of the component value.
+     * @param {any} value - The value of the component.
+     * @param {any} options - The options for this component.
+     * @returns {string} - The string representation of the value of this component.
+     */
     getView(value, options) {
         if (this.component.protected) {
             return '--- PROTECTED ---';
         }
         return this.getValueAsString(value, options);
     }
+    /**
+     * Updates the items list for this component. Useful for Select and other List component types.
+     * @param {...any} args - The arguments to pass to the onChange event.
+     * @returns {void}
+     */
     updateItems(...args) {
         this.restoreValue();
         this.onChange(...args);
     }
     /**
-     * @param {*} data
-     * @param {boolean} [forceUseValue=false] - if true, return 'value' property of the data
-     * @return {*}
+     * Returns the value for a specific item in a List type component.
+     * @param {any} data - The data for this component.
+     * @param {boolean} [forceUseValue] - if true, return 'value' property of the data
+     * @returns {any} - The value of the item.
      */
     itemValue(data, forceUseValue = false) {
         if (lodash_1.default.isObject(data) && !lodash_1.default.isArray(data)) {
@@ -1355,6 +1486,11 @@ class Component extends Element_1.default {
         }
         return data;
     }
+    /**
+     * Returns the item value for html mode.
+     * @param {any} value - The value for this component.
+     * @returns {any} - The value of the item for html mode.
+     */
     itemValueForHTMLMode(value) {
         if (Array.isArray(value)) {
             const values = value.map(item => Array.isArray(item) ? this.itemValueForHTMLMode(item) : this.itemValue(item));
@@ -1362,6 +1498,13 @@ class Component extends Element_1.default {
         }
         return this.itemValue(value);
     }
+    /**
+     * Creates a modal to input the value of this component.
+     * @param {HTMLElement} element - The element to attach the modal to.
+     * @param {any} attr - A list of attributes to add to the modal.
+     * @param {boolean} confirm - If we should add a confirmation to the modal that keeps it from closing unless confirmed.
+     * @returns {HTMLElement} - The created modal element.
+     */
     createModal(element, attr, confirm) {
         const dialog = this.ce('div', attr || {});
         this.setContent(dialog, this.renderTemplate('dialog'));
@@ -1397,6 +1540,10 @@ class Component extends Element_1.default {
         this.addEventListener(dialog.refs.dialogClose, 'click', handleCloseClick);
         return dialog;
     }
+    /**
+     * Uses CSS classes to show or hide an element.
+     * @returns {boolean} - TRUE if the element has been css removed.
+     */
     get optimizeRedraw() {
         if (this.options.optimizeRedraw && this.element && !this.visible) {
             this.addClass(this.element, 'formio-removed');
@@ -1434,7 +1581,7 @@ class Component extends Element_1.default {
     }
     /**
      * Build the custom style from the layout values
-     * @return {string} - The custom style
+     * @returns {string} - The custom style
      */
     get customStyle() {
         let customCSS = '';
@@ -1445,24 +1592,31 @@ class Component extends Element_1.default {
         });
         return customCSS;
     }
+    /**
+     * Returns the component condition operator settings if available.
+     * @returns {object} - The component condition operator settings.
+     */
     static get serverConditionSettings() {
         return Component.conditionOperatorsSettings;
     }
+    /**
+     * Returns if the application is on a mobile device.
+     * @returns {boolean} - TRUE if the application is on a mobile device.
+     */
     get isMobile() {
         return (0, ismobilejs_1.default)();
     }
     /**
      * Returns the outside wrapping element of this component.
-     * @returns {HTMLElement}
+     * @returns {HTMLElement} - The wrapping element of this component.
      */
     getElement() {
         return this.element;
     }
     /**
      * Create an evaluation context for all script executions and interpolations.
-     *
-     * @param additional
-     * @return {*}
+     * @param {any} additional - Additional context to provide.
+     * @returns {any} - The evaluation context.
      */
     evalContext(additional) {
         return super.evalContext(Object.assign({
@@ -1484,18 +1638,29 @@ class Component extends Element_1.default {
     }
     /**
      * Sets the pristine flag for this component.
-     *
-     * @param pristine {boolean} - TRUE to make pristine, FALSE not pristine.
+     * @param {boolean} pristine - TRUE to make pristine, FALSE not pristine.
      */
     setPristine(pristine) {
         this.pristine = pristine;
     }
+    /**
+     * Returns if the component is pristine.
+     * @returns {boolean} - TRUE if the component is pristine.
+     */
     get isPristine() {
         return this.pristine;
     }
+    /**
+     * Sets the dirty flag for this component.
+     * @param {boolean} dirty - TRUE to make dirty, FALSE not dirty.
+     */
     setDirty(dirty) {
         this.dirty = dirty;
     }
+    /**
+     * Returns if the component is dirty.
+     * @returns {boolean} - TRUE if the component is dirty.
+     */
     get isDirty() {
         return this.dirty;
     }
@@ -1509,12 +1674,23 @@ class Component extends Element_1.default {
         this.restoreValue();
         this.triggerRootChange();
     }
+    /**
+     * Returns the icon class for a given icon name.
+     * @param {string} name - The name of the icon you wish to fetch provided the icon class. This is the "font awesome" version of the name of the icon.
+     * @param {boolean} spinning - If the component should be spinning.
+     * @returns {string} - The icon class for the equivalent icon in the iconset we are using.
+     */
     iconClass(name, spinning) {
         const iconset = this.options.iconset || Templates_1.default.current.defaultIconset || 'fa';
         return Templates_1.default.current.hasOwnProperty('iconClass')
             ? Templates_1.default.current.iconClass(iconset, name, spinning)
             : this.options.iconset === 'fa' ? Templates_1.default.defaultTemplates.iconClass(iconset, name, spinning) : name;
     }
+    /**
+     * Returns the size css class names for our current template.
+     * @param {string} size - The size class name for the default iconset.
+     * @returns {string} - The size class for our component.
+     */
     size(size) {
         return Templates_1.default.current.hasOwnProperty('size')
             ? Templates_1.default.current.size(size)
@@ -1527,15 +1703,23 @@ class Component extends Element_1.default {
     get name() {
         return this.t(this.component.label || this.component.placeholder || this.key, { _userInput: true });
     }
+    /**
+     * Returns the visible errors for this component.
+     * @returns {Array<object>} - The visible errors for this component.
+     */
     get visibleErrors() {
         return this._visibleErrors;
     }
+    /**
+     * Returns all the errors for this component, visible or not.
+     * @returns {Array<object>} - All the errors for this component.
+     */
     get errors() {
         return this._errors;
     }
     /**
      * Returns the error label for this component.
-     * @return {*}
+     * @returns {string} - The error label for this component.
      */
     get errorLabel() {
         return this.t(this.component.errorLabel
@@ -1545,12 +1729,20 @@ class Component extends Element_1.default {
     }
     /**
      * Get the error message provided a certain type of error.
-     * @param type
-     * @return {*}
+     * @param {string} type - The type of error to fetch the message for.
+     * @returns {string} - The error message configured for this component.
      */
     errorMessage(type) {
         return (this.component.errors && this.component.errors[type]) ? this.component.errors[type] : type;
     }
+    /**
+     * Sets the content, innerHTML, of an element to the sanitized content.
+     * @param {HTMLElement} element - The element to set the innerHTML to.
+     * @param {string} content - The HTML string content that we wish to set.
+     * @param {boolean} forceSanitize - If we should force the content to be sanitized.
+     * @param {any} sanitizeOptions - The options for the sanitize function.
+     * @returns {boolean} - TRUE if the content was sanitized and set.
+     */
     setContent(element, content, forceSanitize, sanitizeOptions) {
         if (element instanceof HTMLElement) {
             element.innerHTML = this.sanitize(content, forceSanitize, sanitizeOptions);
@@ -1558,6 +1750,9 @@ class Component extends Element_1.default {
         }
         return false;
     }
+    /**
+     * Restores the caret position in the input element after a refresh occurs.
+     */
     restoreCaretPosition() {
         var _a, _b, _c;
         if ((_a = this.root) === null || _a === void 0 ? void 0 : _a.currentSelection) {
@@ -1580,6 +1775,10 @@ class Component extends Element_1.default {
             }
         }
     }
+    /**
+     * Redraw the component.
+     * @returns {Promise<void>} - A promise that resolves when the component is done redrawing.
+     */
     redraw() {
         // Don't bother if we have not built yet.
         if (!this.element || !this.element.parentNode || this.optimizeRedraw) {
@@ -1595,29 +1794,54 @@ class Component extends Element_1.default {
         this.setElement(parent.children[index]);
         return this.attach(this.element);
     }
+    /**
+     * Rebuild and redraw a component.
+     * @returns {Promise<void>} - A promise that resolves when the component is done rebuilding and redrawing.
+     */
     rebuild() {
         this.destroy();
         this.init();
         this.visible = this.conditionallyVisible(null, null);
         return this.redraw();
     }
+    /**
+     * Removes all event listeners attached to this component.
+     */
     removeEventListeners() {
         super.removeEventListeners();
         this.tooltips.forEach(tooltip => tooltip.destroy());
         this.tooltips = [];
     }
+    /**
+     * Returns if the dom node has the classes provided.
+     * @param {HTMLElement} element - The element to check for the class.
+     * @param {string} className - The name of the class to check.
+     * @returns {boolean|void} - TRUE if the element has the class.
+     */
     hasClass(element, className) {
         if (!element) {
             return;
         }
         return super.hasClass(element, this.transform('class', className));
     }
+    /**
+     * Adds a class to an HTML element.
+     * @param {HTMLElement} element - The dom element to add the class to.
+     * @param {string} className - The class name you wish to add.
+     * @returns {this|void} - The component instance.
+     */
     addClass(element, className) {
         if (!element) {
             return;
         }
         return super.addClass(element, this.transform('class', className));
     }
+    /**
+     * Removes a class from an element.
+     * @param {HTMLElement} element - The element to remove the class from.
+     * @param {string} className - The class name to remove.
+     * @returns {this|void} - The component instance.
+     */
     removeClass(element, className) {
         if (!element) {
             return;
@@ -1626,8 +1850,7 @@ class Component extends Element_1.default {
     }
     /**
      * Determines if this component has a condition defined.
-     *
-     * @return {null}
+     * @returns {boolean} - TRUE if the component has a condition defined.
      */
     hasCondition() {
         if (this._hasCondition !== null) {
@@ -1638,9 +1861,9 @@ class Component extends Element_1.default {
     }
     /**
      * Check if this component is conditionally visible.
-     *
-     * @param data
-     * @return {boolean}
+     * @param {any} data - The data to check against.
+     * @param {any} row - The row data to check against.
+     * @returns {boolean} - TRUE if the component is conditionally visible.
      */
     conditionallyVisible(data, row) {
         data = data || this.rootValue;
@@ -1655,16 +1878,19 @@ class Component extends Element_1.default {
      * Checks the condition of this component.
      *
      * TODO: Switch row and data parameters to be consistent with other methods.
-     *
-     * @param row - The row contextual data.
-     * @param data - The global data object.
-     * @return {boolean} - True if the condition applies to this component.
+     * @param {any} row - The row contextual data.
+     * @param {any} data - The global data object.
+     * @returns {boolean} - True if the condition applies to this component.
      */
     checkCondition(row, data) {
         return FormioUtils.checkCondition(this.component, row || this.data, data || this.rootValue, this.root ? this.root._form : {}, this);
     }
     /**
      * Check for conditionals and hide/show the element based on those conditions.
+     * @param {any} data - The data to check against.
+     * @param {any} flags - The flags passed to checkData function.
+     * @param {any} row - The row data to check against.
+     * @returns {boolean} - TRUE if the component is visible.
      */
     checkComponentConditions(data, flags, row) {
         data = data || this.rootValue;
@@ -1682,8 +1908,10 @@ class Component extends Element_1.default {
     }
     /**
      * Checks conditions for this component and any sub components.
-     * @param args
-     * @return {boolean}
+     * @param {any} data - The data to check against.
+     * @param {any} flags - The flags passed to checkData function.
+     * @param {any} row - The row data to check against.
+     * @returns {boolean} - TRUE if the component is visible.
      */
     checkConditions(data, flags, row) {
         data = data || this.rootValue;
@@ -1691,17 +1919,20 @@ class Component extends Element_1.default {
         row = row || this.data;
         return this.checkComponentConditions(data, flags, row);
     }
+    /**
+     * Returns the component logic if applicable.
+     * @returns {Array<object>} - The component logic.
+     */
     get logic() {
         return this.component.logic || [];
     }
     /**
      * Check all triggers and apply necessary actions.
-     *
-     * @param data
+     * @param {any} data - The data to check against.
+     * @param {any} row - The row data to check against.
+     * @returns {boolean|void} - TRUE if the component was altered.
      */
-    fieldLogic(data, row) {
-        data = data || this.rootValue;
-        row = row || this.data;
+    fieldLogic(data = this.rootValue, row = this.data) {
         const logics = this.logic;
         // If there aren't logic, don't go further.
         if (logics.length === 0) {
@@ -1724,6 +1955,10 @@ class Component extends Element_1.default {
         }
         return changed;
     }
+    /**
+     * Retuns if the browser is Internet Explorer.
+     * @returns {boolean} - TRUE if the browser is IE.
+     */
     isIE() {
         if (typeof window === 'undefined') {
             return false;
@@ -1748,9 +1983,24 @@ class Component extends Element_1.default {
         // other browser
         return false;
     }
+    /**
+     * Defines the logic action value through evaluation.
+     * @param {object} action - The action within the Logic system to perform.
+     * @param {object} argsObject - The arguments to pass to the evaluation.
+     * @returns {any} - The result of the evaluation.
+     */
     defineActionValue(action, argsObject) {
         return this.evaluate(action.value, argsObject, 'value');
     }
+    /**
+     * Apply the actions of Logic for a component once the conditions have been met.
+     * @param {object} newComponent - The new component to apply the actions to.
+     * @param {Array<object>} actions - An array of actions
+     * @param {any} result - The result of the conditional check in order to evaluate the actions.
+     * @param {any} row - The contextual row data for this component.
+     * @param {any} data - The global data object for the submission.
+     * @returns {boolean} - TRUE if the component was altered.
+     */
     applyActions(newComponent, actions, result, row, data) {
         data = data || this.rootValue;
         row = row || this.data;
@@ -1830,8 +2080,8 @@ class Component extends Element_1.default {
     }
     /**
      * Add a new input error to this element.
-     *
-     * @param {{level: string, message: string}[]} messages
+     * @param {Array<object>|string} messages - An array of messages to add to the element.
+     * @returns {void}
      */
     addMessages(messages) {
         if (!messages) {
@@ -1854,6 +2104,15 @@ class Component extends Element_1.default {
             }).join(''));
         }
     }
+    /**
+     * Sets the form input widget error classes.
+     * @param {Array<HTMLElement>} elements - An array of DOM elements to set the error classes on.
+     * @param {boolean} dirty - If the input is dirty.
+     * @param {boolean} hasErrors - If the input has errors.
+     * @param {boolean} hasMessages - If the input has messages.
+     * @param {HTMLElement} element - The wrapper element for all the other elements passed in first argument.
+     * @returns {void}
+     */
     setErrorClasses(elements, dirty, hasErrors, hasMessages, element = this.element) {
         this.clearErrorClasses();
         elements.forEach((element) => {
@@ -1880,6 +2139,12 @@ class Component extends Element_1.default {
             this.addClass(element, 'has-message');
         }
     }
+    /**
+     * Adds the classes necessary to mark an element as invalid.
+     * @param {HTMLElement} element - The element you wish to add the invalid classes to.
+     * @param {boolean} invalid - TRUE if the component is invalid, FALSE otherwise.
+     * @returns {void}
+     */
     setElementInvalid(element, invalid) {
         if (!element)
             return;
@@ -1891,6 +2156,9 @@ class Component extends Element_1.default {
         }
         element.setAttribute('aria-invalid', invalid ? 'true' : 'false');
     }
+    /**
+     * Clears the components data if it is conditionally hidden AND clearOnHide is set to true for this component.
+     */
     clearOnHide() {
         // clearOnHide defaults to true for old forms (without the value set) so only trigger if the value is false.
         if (
@@ -1910,6 +2178,10 @@ class Component extends Element_1.default {
             }
         }
     }
+    /**
+     * Triggers a debounced onChange event for the root component (usually Webform).
+     * @param {...any} args - The arguments to pass to the onChange event.
+     */
     triggerRootChange(...args) {
         if (this.options.onChange) {
             this.options.onChange(...args);
@@ -1918,6 +2190,13 @@ class Component extends Element_1.default {
             this.root.triggerChange(...args);
         }
     }
+    /**
+     * Called when the component value has been changed. This will then trigger the root level onChange handler which
+     * propagates the checkData methods for the full component tree.
+     * @param {any} flags - The flags for the change event propagation.
+     * @param {boolean} fromRoot - If the change event is from the root component.
+     * @returns {boolean} - TRUE if the component has changed.
+     */
     onChange(flags, fromRoot) {
         flags = flags || {};
         if (flags.modified) {
@@ -1927,7 +2206,7 @@ class Component extends Element_1.default {
             this.addClass(this.getElement(), 'formio-modified');
         }
         // If we are supposed to validate on blur, then don't trigger validation yet.
-        if (this.component.validateOn === 'blur') {
+        if (this.component.validateOn === 'blur' || this.component.validateOn === 'submit') {
             flags.noValidate = true;
         }
         if (this.component.onChange) {
@@ -2047,7 +2326,7 @@ class Component extends Element_1.default {
                     return Promise.reject();
                 }
                 this.quill = new Quill(element, isIEBrowser ? Object.assign(Object.assign({}, settings), { modules: {} }) : settings);
-                /** This block of code adds the [source] capabilities.  See https://codepen.io/anon/pen/ZyEjrQ **/
+                /** This block of code adds the [source] capabilities.  See https://codepen.io/anon/pen/ZyEjrQ */
                 const txtArea = document.createElement('textarea');
                 txtArea.setAttribute('class', 'quill-source-code');
                 this.quill.addContainer('ql-custom').appendChild(txtArea);
@@ -2061,7 +2340,7 @@ class Component extends Element_1.default {
                         txtArea.style.display = (txtArea.style.display === 'none') ? 'inherit' : 'none';
                     });
                 }
-                /** END CODEBLOCK **/
+                /** END CODEBLOCK */
                 // Make sure to select cursor when they click on the element.
                 this.addEventListener(element, 'click', () => this.quill.focus());
                 // Allows users to skip toolbar items when tabbing though form
@@ -2104,28 +2383,36 @@ class Component extends Element_1.default {
             return editor;
         });
     }
+    getDragula() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve) => {
+                return Formio_1.Formio.requireLibrary('dragula', 'dragula', `${Formio_1.Formio.cdn.dragula}/dragula.js`, true, (ready) => {
+                    return ready.then(resolve);
+                });
+            });
+        });
+    }
     get tree() {
         return this.component.tree || false;
     }
     /**
      * The empty value for this component.
-     *
-     * @return {null}
+     * @returns {null} - The empty value for this component.
      */
     get emptyValue() {
         return null;
     }
     /**
      * Returns if this component has a value set.
-     *
+     * @param {any} data - The global data object.
+     * @returns {boolean} - TRUE if a value is set.
      */
     hasValue(data) {
         return !lodash_1.default.isUndefined(lodash_1.default.get(data || this.data, this.key));
     }
     /**
      * Get the data value at the root level.
-     *
-     * @return {*}
+     * @returns {*} - The root value for the component, typically the Webform data object.
      */
     get rootValue() {
         return this.root ? this.root.data : this.data;
@@ -2135,7 +2422,7 @@ class Component extends Element_1.default {
     }
     /**
      * Get the static value of this component.
-     * @return {*}
+     * @returns {*} - The value for this component.
      */
     get dataValue() {
         if (!this.key ||
@@ -2153,8 +2440,7 @@ class Component extends Element_1.default {
     }
     /**
      * Sets the static value of this component.
-     *
-     * @param value
+     * @param {*} value - The value to set for this component.
      */
     set dataValue(value) {
         if (!this.allowData ||
@@ -2174,8 +2460,8 @@ class Component extends Element_1.default {
     }
     /**
      * Splice a value from the dataValue.
-     *
-     * @param index
+     * @param {number} index - The index to splice for an array component values.
+     * @param {*} flags - The flags to use when splicing the value.
      */
     splice(index, flags = {}) {
         if (this.hasValue()) {
@@ -2243,8 +2529,7 @@ class Component extends Element_1.default {
     }
     /**
      * Get the input value of this component.
-     *
-     * @return {*}
+     * @returns {*} - The value for the component.
      */
     getValue() {
         if (!this.hasInput || this.viewOnly || !this.refs.input || !this.refs.input.length) {
@@ -2266,9 +2551,8 @@ class Component extends Element_1.default {
     }
     /**
      * Get the value at a specific index.
-     *
-     * @param index
-     * @returns {*}
+     * @param {number} index - For an array component or multiple values, this returns the value at a specific index.
+     * @returns {*} - The value at the specified index.
      */
     getValueAt(index) {
         const input = this.performInputMapping(this.refs.input[index]);
@@ -2276,11 +2560,9 @@ class Component extends Element_1.default {
     }
     /**
      * Set the value of this component.
-     *
-     * @param value
-     * @param flags
-     *
-     * @return {boolean} - If the value changed.
+     * @param {*} value - The value to set for this component.
+     * @param {*} flags - The flags to use when setting the value.
+     * @returns {boolean} - If the value changed.
      */
     setValue(value, flags = {}) {
         const changed = this.updateValue(value, flags);
@@ -2304,16 +2586,23 @@ class Component extends Element_1.default {
         }
         for (const i in this.refs.input) {
             if (this.refs.input.hasOwnProperty(i)) {
-                this.setValueAt(i, isArray ? value[i] : value, flags);
+                this.setValueAt(i, isArray && !this.isSingleInputValue() ? value[i] : value, flags);
             }
         }
         return changed;
     }
+    /**
+     * Returns if the value (e.g. array) should be divided between several inputs
+     * @returns {boolean}
+     */
+    isSingleInputValue() {
+        return false;
+    }
     /**
      * Set the value at a specific index.
-     *
-     * @param index
-     * @param value
+     * @param {number} index - The index to set the value at.
+     * @param {*} value - The value to set at the specified index.
+     * @param {*} flags - The flags to use when setting the value.
      */
     setValueAt(index, value, flags = {}) {
         if (!flags.noDefault && (value === null || value === undefined) && !this.component.multiple) {
@@ -2360,20 +2649,17 @@ class Component extends Element_1.default {
     }
     /**
      * Normalize values coming into updateValue.
-     *
-     * @param value
-     * @return {*}
+     * @param {*} value - The value to normalize before setting.
+     * @returns {*} - The normalized value.
      */
     normalizeValue(value) {
-        if (this.component.multiple && !Array.isArray(value)) {
-            value = value ? [value] : [];
-        }
         return value;
     }
     /**
      * Update a value of this component.
-     *
-     * @param flags
+     * @param {*} value - The value to update.
+     * @param {*} flags - The flags to use when updating the value.
+     * @returns {boolean} - If the value changed.
      */
     updateComponentValue(value, flags = {}) {
         let newValue = (!flags.resetValue && (value === undefined || value === null)) ? this.getValue() : value;
@@ -2392,9 +2678,8 @@ class Component extends Element_1.default {
     }
     /**
      * Updates the value of this component plus all sub-components.
-     *
-     * @param args
-     * @return {boolean}
+     * @param {...any} args - The arguments to pass to updateValue.
+     * @returns {boolean} - If the value changed.
      */
     updateValue(...args) {
         return this.updateComponentValue(...args);
@@ -2412,7 +2697,7 @@ class Component extends Element_1.default {
      */
     resetValue() {
         this.unset();
-        this.setValue(this.emptyValue, {
+        this.setValue(this.defaultValue || this.emptyValue, {
             noUpdateEvent: true,
             noValidate: true,
             resetValue: true
@@ -2420,10 +2705,9 @@ class Component extends Element_1.default {
     }
     /**
      * Determine if the value of this component has changed.
-     *
-     * @param newValue
-     * @param oldValue
-     * @return {boolean}
+     * @param {*} newValue - The new value to check.
+     * @param {*} oldValue - The existing value of the component.
+     * @returns {boolean} - TRUE if the value has changed.
      */
     hasChanged(newValue, oldValue) {
         if (((newValue === undefined) || (newValue === null)) &&
@@ -2441,8 +2725,9 @@ class Component extends Element_1.default {
     }
     /**
      * Update the value on change.
-     *
-     * @param flags
+     * @param {*} flags - The flags to use when triggering the on change event.
+     * @param {boolean} changed - If the value has changed.
+     * @returns {boolean} - If the value changed.
      */
     updateOnChange(flags = {}, changed = false) {
         if (!flags.noUpdateEvent && changed) {
@@ -2455,13 +2740,6 @@ class Component extends Element_1.default {
         }
         return false;
     }
-    /**
-     * Perform a calculated value operation.
-     *
-     * @param data - The global data object.
-     *
-     * @return {boolean} - If the value changed during calculation.
-     */
     convertNumberOrBoolToString(value) {
         if (typeof value === 'number' || typeof value === 'boolean') {
             return value.toString();
@@ -2570,9 +2848,10 @@ class Component extends Element_1.default {
     /* eslint-enable max-statements */
     /**
      * Performs calculations in this component plus any child components.
-     *
-     * @param args
-     * @return {boolean}
+     * @param {*} data - The data to perform the calculation with.
+     * @param {*} flags - The flags to use when calculating the value.
+     * @param {*} row - The contextual row data to use when performing the calculation.
+     * @returns {boolean} - TRUE if the value changed.
      */
     calculateValue(data, flags, row) {
         data = data || this.rootValue;
@@ -2582,15 +2861,14 @@ class Component extends Element_1.default {
     }
     /**
      * Get this component's label text.
-     *
+     * @returns {string} - The label text for this component.
      */
     get label() {
         return this.component.label;
     }
     /**
      * Set this component's label text and render it.
-     *
-     * @param value - The new label text.
+     * @param {string} value - The new label text.
      */
     set label(value) {
         this.component.label = value;
@@ -2600,17 +2878,18 @@ class Component extends Element_1.default {
     }
     /**
      * Get FormioForm element at the root of this component tree.
-     *
+     * @returns {*} root - The root component to search from.
      */
     getRoot() {
         return this.root;
     }
     /**
      * Returns the invalid message, or empty string if the component is valid.
-     *
-     * @param data
-     * @param dirty
-     * @return {*}
+     * @param {*} data - The data to check if the component is valid.
+     * @param {boolean} dirty - If the component is dirty.
+     * @param {boolean} ignoreCondition - If conditions for the component should be ignored when checking validity.
+     * @param {*} row - Contextual row data for this component.
+     * @returns {string} - The message to show when the component is invalid.
      */
     invalidMessage(data, dirty, ignoreCondition, row) {
         if (!ignoreCondition && !this.checkCondition(row, data)) {
@@ -2642,10 +2921,9 @@ class Component extends Element_1.default {
     }
     /**
      * Returns if the component is valid or not.
-     *
-     * @param data
-     * @param dirty
-     * @return {boolean}
+     * @param {*} data - The data to check if the component is valid.
+     * @param {boolean} dirty - If the component is dirty.
+     * @returns {boolean} - TRUE if the component is valid.
      */
     isValid(data, dirty) {
         return !this.invalidMessage(data, dirty);
@@ -2664,8 +2942,8 @@ class Component extends Element_1.default {
     }
     /**
      * Interpolate errors from the validation methods.
-     * @param {*} errors
-     * @returns
+     * @param {Array<any>} errors - An array of errors to interpolate.
+     * @returns {Array<any>} - The interpolated errors.
      */
     interpolateErrors(errors) {
         var _a;
@@ -2678,7 +2956,7 @@ class Component extends Element_1.default {
      * @param {*} data - The root submission data.
      * @param {*} row - The contextual row data.
      * @param {*} flags - The flags to perform validation.
-     * @returns
+     * @returns {boolean} - TRUE if the component is valid.
      */
     showValidationErrors(errors, data, row, flags) {
         if (flags.silentCheck) {
@@ -2688,7 +2966,7 @@ class Component extends Element_1.default {
             flags.dirty = true;
         }
         if (flags.fromSubmission && this.hasValue(data)) {
-            flags.dirty = true;
+            flags.dirty = this.pristine && this.component.protected ? false : true;
         }
         this.setDirty(flags.dirty);
         return this.setComponentValidity(errors, flags.dirty, flags.silentCheck, flags.fromSubmission);
@@ -2698,9 +2976,9 @@ class Component extends Element_1.default {
      * @param {*} data - The root data you wish to use for this component.
      * @param {*} row - The contextual row data you wish to use for this component.
      * @param {*} flags - The flags to control the behavior of the validation.
-     * @returns
+     * @returns {Array<any>} - An array of errors if the component is invalid.
      */
-    validateComponent(data, row, flags = {}) {
+    validateComponent(data = null, row = null, flags = {}) {
         data = data || this.rootValue;
         row = row || this.data;
         const { async = false } = flags;
@@ -2714,6 +2992,7 @@ class Component extends Element_1.default {
             value: this.validationValue,
             path: this.path || this.component.key,
             instance: this,
+            form: this.root ? this.root._form : {},
             scope: { errors: [] },
             processors: [
                 process_1.validateProcessInfo
@@ -2731,13 +3010,14 @@ class Component extends Element_1.default {
     }
     /**
      * Checks the validity of this component and sets the error message if it is invalid.
-     *
-     * @param data
-     * @param dirty
-     * @param row
-     * @return {boolean}
-     */
-    checkComponentValidity(data, dirty, row, flags = {}, allErrors = []) {
+     * @param {*} data - The data to check if the component is valid.
+     * @param {boolean} dirty - If the component is dirty.
+     * @param {*} row - The contextual row data for this component.
+     * @param {*} flags - The flags to use when checking the validity.
+     * @param {Array<any>} allErrors - An array of all errors that have occured so that it can be appended when another one occurs here.
+     * @returns {boolean} - TRUE if the component is valid.
+     */
+    checkComponentValidity(data = null, dirty = false, row = null, flags = {}, allErrors = []) {
         data = data || this.rootValue;
         row = row || this.data;
         flags.dirty = dirty || false;
@@ -2749,7 +3029,7 @@ class Component extends Element_1.default {
                         this.parent.childErrors.push(...errors);
                     }
                     else {
-                        lodash_1.default.remove(this.parent.childErrors, (err) => err.component.key === this.component.key);
+                        lodash_1.default.remove(this.parent.childErrors, (err) => { var _a, _b; return (((_a = err === null || err === void 0 ? void 0 : err.component) === null || _a === void 0 ? void 0 : _a.key) || ((_b = err === null || err === void 0 ? void 0 : err.context) === null || _b === void 0 ? void 0 : _b.key)) === this.component.key; });
                     }
                 }
                 this.showValidationErrors(errors, data, row, flags);
@@ -2765,7 +3045,7 @@ class Component extends Element_1.default {
                     this.parent.childErrors.push(...errors);
                 }
                 else {
-                    lodash_1.default.remove(this.parent.childErrors, (err) => err.component.key === this.component.key);
+                    lodash_1.default.remove(this.parent.childErrors, (err) => { var _a, _b; return (((_a = err === null || err === void 0 ? void 0 : err.component) === null || _a === void 0 ? void 0 : _a.key) || ((_b = err === null || err === void 0 ? void 0 : err.context) === null || _b === void 0 ? void 0 : _b.key)) === this.component.key; });
                 }
             }
             return errors.length === 0;
@@ -2773,32 +3053,30 @@ class Component extends Element_1.default {
     }
     /**
      * Checks the validity of the component.
-     * @param {*} data
-     * @param {*} dirty
-     * @param {*} row
-     * @param {*} silentCheck
-     * @returns
-     */
-    checkValidity(data, dirty, row, silentCheck, errors = []) {
+     * @param {*} data - The data to check if the component is valid.
+     * @param {boolean} dirty - If the component is dirty.
+     * @param {*} row - The contextual row data for this component.
+     * @param {boolean} silentCheck - If the check should be silent and not set the error messages.
+     * @param {Array<any>} errors - An array of all errors that have occured so that it can be appended when another one occurs here.
+     * @returns {boolean} - TRUE if the component is valid.
+     */
+    checkValidity(data = null, dirty = false, row = null, silentCheck = false, errors = []) {
         data = data || this.rootValue;
         row = row || this.data;
-        console.log('Deprecation warning:  Component.checkValidity() will be deprecated in 6.x version of renderer. Use Component.validateComponent instead.');
         return this.checkComponentValidity(data, dirty, row, { silentCheck }, errors);
     }
-    checkAsyncValidity(data, dirty, row, silentCheck, errors = []) {
-        console.log('Deprecation warning:  Component.checkAsyncValidity() will be deprecated in 6.x version of renderer. Use Component.validateComponent instead.');
+    checkAsyncValidity(data = null, dirty = false, row = null, silentCheck = false, errors = []) {
         return this.checkComponentValidity(data, dirty, row, { async: true, silentCheck }, errors);
     }
     /**
      * Check the conditions, calculations, and validity of a single component and triggers an update if
      * something changed.
-     *
-     * @param data - The root data of the change event.
-     * @param flags - The flags from this change event.
-     *
-     * @return boolean - If component is valid or not.
+     * @param {*} data - The root data of the change event.
+     * @param {*} flags - The flags from this change event.
+     * @param {*} row - The contextual row data for this component.
+     * @returns {void|boolean} - TRUE if no check should be performed on the component.
      */
-    checkData(data, flags, row) {
+    checkData(data = null, flags = null, row = null) {
         data = data || this.rootValue;
         flags = flags || {};
         row = row || this.data;
@@ -2841,8 +3119,7 @@ class Component extends Element_1.default {
     }
     /**
      * Check if a component is eligible for multiple validation
-     *
-     * @return {boolean}
+     * @returns {boolean} - TRUE if the component is eligible for multiple validation.
      */
     validateMultiple() {
         return true;
@@ -2962,8 +3239,7 @@ class Component extends Element_1.default {
     /**
      * Determines if the value of this component is hidden from the user as if it is coming from the server, but is
      * protected.
-     *
-     * @return {boolean|*}
+     * @returns {boolean|*} - TRUE if the value is hidden.
      */
     isValueHidden() {
         if (this.component.protected && this.root.editing) {
@@ -3008,6 +3284,8 @@ class Component extends Element_1.default {
     }
     /**
      * Prints out the value of this component as a string value.
+     * @param {*} value - The value to print out.
+     * @returns {string} - The string representation of the value.
      */
     asString(value) {
         value = value || this.getValue();
@@ -3015,15 +3293,14 @@ class Component extends Element_1.default {
     }
     /**
      * Return if the component is disabled.
-     * @return {boolean}
+     * @returns {boolean} - TRUE if the component is disabled.
      */
     get disabled() {
         return this._disabled || this.parentDisabled;
     }
     /**
      * Disable this component.
-     *
-     * @param {boolean} disabled
+     * @param {boolean} disabled - TRUE to disable the component.
      */
     set disabled(disabled) {
         this._disabled = disabled;
@@ -3134,6 +3411,10 @@ class Component extends Element_1.default {
                             const disabled = this.shouldDisabled;
                             // Change states which won't be recalculated during redrawing
                             if (this.visible !== visible) {
+                                // If the logic is triggered by an event and the action sets the hidden state then the original
+                                // component definition must be changed so that the components hidden state does not get flipped back by
+                                // the fieldLogic function
+                                this.originalComponent.hidden = !visible;
                                 this.visible = visible;
                             }
                             if (this.disabled !== disabled) {
@@ -3148,6 +3429,7 @@ class Component extends Element_1.default {
     }
     /**
      * Get the element information.
+     * @returns {*} - The components "input" DOM element information.
      */
     elementInfo() {
         const attributes = {
@@ -3179,23 +3461,24 @@ class Component extends Element_1.default {
             this.on('render', () => this.focus(), true);
         }
     }
-    scrollIntoView(element = this.element) {
+    scrollIntoView(element = this.element, verticalOnly) {
         if (!element) {
             return;
         }
         const { left, top } = element.getBoundingClientRect();
-        window.scrollTo(left + window.scrollX, top + window.scrollY);
+        window.scrollTo(verticalOnly ? window.scrollX : left + window.scrollX, top + window.scrollY);
     }
     focus(index) {
-        var _a, _b;
+        var _a, _b, _c, _d;
         if ('beforeFocus' in this.parent) {
             this.parent.beforeFocus(this);
         }
-        if ((_a = this.refs.input) === null || _a === void 0 ? void 0 : _a.length) {
-            const focusingInput = typeof index === 'number' && this.refs.input[index]
-                ? this.refs.input[index]
-                : this.refs.input[this.refs.input.length - 1];
-            if (((_b = this.component.widget) === null || _b === void 0 ? void 0 : _b.type) === 'calendar') {
+        if (!index && !lodash_1.default.isNumber(index) && ((_b = (_a = this.refs) === null || _a === void 0 ? void 0 : _a.input) === null || _b === void 0 ? void 0 : _b.length)) {
+            index = this.refs.input.length - 1;
+        }
+        if ((_c = this.refs.input) === null || _c === void 0 ? void 0 : _c.length) {
+            const focusingInput = this.refs.input[index];
+            if (((_d = this.component.widget) === null || _d === void 0 ? void 0 : _d.type) === 'calendar') {
                 const sibling = focusingInput.nextSibling;
                 if (sibling) {
                     sibling.focus();
@@ -3214,6 +3497,7 @@ class Component extends Element_1.default {
     }
     /**
      * Get `Formio` instance for working with files
+     * @returns {import('@formio/core').Formio} - The Formio instance file service.
      */
     get fileService() {
         if (this.options.fileService) {