@formio/js 5.1.0-dev.6068.e295b11 → 5.1.0-dev.6068.fbce2f7

package/lib/cjs/components/_classes/component/Component.d.ts

@@ -163,9 +163,22 @@ declare class Component extends Element {
      */
     info: any;
     get componentsMap(): object;
+    /**
+     * Returns if the parent should conditionally clear.
+     * This method does not need to walk up the parent tree since the variables
+     * _conditionallyClear and _conditionallyHidden are set on the parent component
+     * before the child component is determined, and the parent component also references
+     * its parent component.
+     *
+     * @returns {boolean} - If the parent should conditionally clear.
+     */
     parentShouldConditionallyClear(): boolean;
     parentConditionallyHidden(): boolean;
-    parentDefaultHidden(): boolean;
+    /**
+     * Returns true if any of the parents default their component "hidden" property to true.
+     * @returns {boolean} - If any parent defaults the hidden property to true.
+     */
+    anyParentDefaultsHidden(): boolean;
     set data(value: any);
     get data(): any;
     mergeSchema(component?: {}): any;
@@ -229,9 +242,21 @@ declare class Component extends Element {
     get visible(): boolean;
     get logicallyHidden(): any;
     _logicallyHidden: any;
+    /**
+     * Determines if the component should clear its value when the root form is pristine.
+     * @returns {boolean} - If the component should clear its value when the root form is pristine.
+     */
     shouldConditionallyClearOnPristine(): boolean;
+    /**
+     * Returns if the component should clear its value when conditionally hidden.
+     * @returns {boolean} - If the component should clear its value when conditionally hidden.
+     */
     shouldConditionallyClear(): boolean;
     _conditionallyClear: boolean | undefined;
+    /**
+     * Returns if the component is conditionally hidden.
+     * @returns {boolean} - If the component is conditionally hidden.
+     */
     conditionallyHidden(): boolean;
     _conditionallyHidden: boolean | undefined;
     set currentForm(instance: any);

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

@@ -458,6 +458,15 @@ class Component extends Element_1.default {
         var _a;
         return ((_a = this.root) === null || _a === void 0 ? void 0 : _a.childComponentsMap) || {};
     }
+    /**
+     * Returns if the parent should conditionally clear.
+     * This method does not need to walk up the parent tree since the variables
+     * _conditionallyClear and _conditionallyHidden are set on the parent component
+     * before the child component is determined, and the parent component also references
+     * its parent component.
+     *
+     * @returns {boolean} - If the parent should conditionally clear.
+     */
     parentShouldConditionallyClear() {
         let currentParent = this.parent;
         while (currentParent) {
@@ -479,7 +488,11 @@ class Component extends Element_1.default {
         }
         return false;
     }
-    parentDefaultHidden() {
+    /**
+     * Returns true if any of the parents default their component "hidden" property to true.
+     * @returns {boolean} - If any parent defaults the hidden property to true.
+     */
+    anyParentDefaultsHidden() {
         let currentParent = this.parent;
         while (currentParent) {
             if (currentParent.component.hidden) {
@@ -700,11 +713,19 @@ class Component extends Element_1.default {
         }
         return this._logicallyHidden;
     }
+    /**
+     * Determines if the component should clear its value when the root form is pristine.
+     * @returns {boolean} - If the component should clear its value when the root form is pristine.
+     */
     shouldConditionallyClearOnPristine() {
         // If the form is pristine, we should NOT clear the value of a conditionally hidden child component
-        // of a conditionally hidden layout component that defaults to hidden using the "hidden" property.
-        return !this.parentDefaultHidden();
+        // of a layout component that defaults to hidden using the "hidden" component property.
+        return !this.anyParentDefaultsHidden();
     }
+    /**
+     * Returns if the component should clear its value when conditionally hidden.
+     * @returns {boolean} - If the component should clear its value when conditionally hidden.
+     */
     shouldConditionallyClear() {
         // Skip if this component has clearOnHide set to false.
         if (this.component.clearOnHide === false) {
@@ -726,6 +747,10 @@ class Component extends Element_1.default {
         this._conditionallyClear = this.hasSetValue ? false : this.parentShouldConditionallyClear();
         return this._conditionallyClear;
     }
+    /**
+     * Returns if the component is conditionally hidden.
+     * @returns {boolean} - If the component is conditionally hidden.
+     */
     conditionallyHidden() {
         // If it is logically hidden, then it is conditionally hidden.
         if (this.logicallyHidden) {

package/lib/mjs/components/_classes/component/Component.d.ts

@@ -163,9 +163,22 @@ declare class Component extends Element {
      */
     info: any;
     get componentsMap(): object;
+    /**
+     * Returns if the parent should conditionally clear.
+     * This method does not need to walk up the parent tree since the variables
+     * _conditionallyClear and _conditionallyHidden are set on the parent component
+     * before the child component is determined, and the parent component also references
+     * its parent component.
+     *
+     * @returns {boolean} - If the parent should conditionally clear.
+     */
     parentShouldConditionallyClear(): boolean;
     parentConditionallyHidden(): boolean;
-    parentDefaultHidden(): boolean;
+    /**
+     * Returns true if any of the parents default their component "hidden" property to true.
+     * @returns {boolean} - If any parent defaults the hidden property to true.
+     */
+    anyParentDefaultsHidden(): boolean;
     set data(value: any);
     get data(): any;
     mergeSchema(component?: {}): any;
@@ -229,9 +242,21 @@ declare class Component extends Element {
     get visible(): boolean;
     get logicallyHidden(): any;
     _logicallyHidden: any;
+    /**
+     * Determines if the component should clear its value when the root form is pristine.
+     * @returns {boolean} - If the component should clear its value when the root form is pristine.
+     */
     shouldConditionallyClearOnPristine(): boolean;
+    /**
+     * Returns if the component should clear its value when conditionally hidden.
+     * @returns {boolean} - If the component should clear its value when conditionally hidden.
+     */
     shouldConditionallyClear(): boolean;
     _conditionallyClear: boolean | undefined;
+    /**
+     * Returns if the component is conditionally hidden.
+     * @returns {boolean} - If the component is conditionally hidden.
+     */
     conditionallyHidden(): boolean;
     _conditionallyHidden: boolean | undefined;
     set currentForm(instance: any);

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

@@ -422,6 +422,15 @@ export default class Component extends Element {
     get componentsMap() {
         return this.root?.childComponentsMap || {};
     }
+    /**
+     * Returns if the parent should conditionally clear.
+     * This method does not need to walk up the parent tree since the variables
+     * _conditionallyClear and _conditionallyHidden are set on the parent component
+     * before the child component is determined, and the parent component also references
+     * its parent component.
+     *
+     * @returns {boolean} - If the parent should conditionally clear.
+     */
     parentShouldConditionallyClear() {
         let currentParent = this.parent;
         while (currentParent) {
@@ -443,7 +452,11 @@ export default class Component extends Element {
         }
         return false;
     }
-    parentDefaultHidden() {
+    /**
+     * Returns true if any of the parents default their component "hidden" property to true.
+     * @returns {boolean} - If any parent defaults the hidden property to true.
+     */
+    anyParentDefaultsHidden() {
         let currentParent = this.parent;
         while (currentParent) {
             if (currentParent.component.hidden) {
@@ -664,11 +677,19 @@ export default class Component extends Element {
         }
         return this._logicallyHidden;
     }
+    /**
+     * Determines if the component should clear its value when the root form is pristine.
+     * @returns {boolean} - If the component should clear its value when the root form is pristine.
+     */
     shouldConditionallyClearOnPristine() {
         // If the form is pristine, we should NOT clear the value of a conditionally hidden child component
-        // of a conditionally hidden layout component that defaults to hidden using the "hidden" property.
-        return !this.parentDefaultHidden();
+        // of a layout component that defaults to hidden using the "hidden" component property.
+        return !this.anyParentDefaultsHidden();
     }
+    /**
+     * Returns if the component should clear its value when conditionally hidden.
+     * @returns {boolean} - If the component should clear its value when conditionally hidden.
+     */
     shouldConditionallyClear() {
         // Skip if this component has clearOnHide set to false.
         if (this.component.clearOnHide === false) {
@@ -690,6 +711,10 @@ export default class Component extends Element {
         this._conditionallyClear = this.hasSetValue ? false : this.parentShouldConditionallyClear();
         return this._conditionallyClear;
     }
+    /**
+     * Returns if the component is conditionally hidden.
+     * @returns {boolean} - If the component is conditionally hidden.
+     */
     conditionallyHidden() {
         // If it is logically hidden, then it is conditionally hidden.
         if (this.logicallyHidden) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/js",
-  "version": "5.1.0-dev.6068.e295b11",
+  "version": "5.1.0-dev.6068.fbce2f7",
   "description": "JavaScript powered Forms with JSON Form Builder",
   "main": "lib/cjs/index.js",
   "exports": {