powerpagestoolkit 1.3.1041 → 1.3.3001

package/README.md

@@ -30,6 +30,8 @@ The `DOMNodeReference` module simplifies DOM element management. It provides fun
 
 - **`createMultipleDOMNodeReferences(selector)`**: Creates multiple `DOMNodeReference` instances for all elements matching the specified CSS selector. Returns an array of `DOMNodeReference` instances.
 
+`selector` uses standard ED6 `document.querySelector()` syntax. For more information, read [here](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector)
+
 ```javascript
 // single instance of DOMNodeReference
 const node = await createDOMNodeReference("#my-element");
@@ -48,22 +50,34 @@ nodeArray.forEach((node) => {
 })
 ```
 
-##### Properties
+##### Available Properties
+
+These properties are public and can be used in any custom logic/configurations
 
 ```typescript
-target: string;
-element: HTMLElement | null;
+target: HTMLElement | string;
+element: HTMLElement;
 isLoaded: boolean;
-visibilityController: HTMLElement | null;
-defaultDisplay: string;
-value: string | null;
+value: any;
+/**
+ * If the element targeted is the main input for a yes/no radio control,
+ * yesRadio and noRadio will be available as properties of 'this'
+ */
+yesRadio: DOMNodeReference;
+noRadio: DOMNodeReference;
+// and if 'this' is the instance of a yesRadio or noRadio
+// checked will represent wether the radio has been checked or not
+checked: boolean
 ```
 
 ##### Methods
 
 Here are the key methods you can use with a DOMNodeReference instance:
 
-```typescript
+```javascript
+
+/********/
+// VISIBILITY / ACCESSIBILITY
 
 // Hides the associated DOM element.
 hide()
@@ -71,8 +85,120 @@ hide()
 // Shows the associated DOM element.
 show()
 
+/**
+ * advanced visibility control in the case you need to apply
+ * custom logic to the visibility of an element
+ */
+toggleVisibility(shouldShow: boolean | () => boolean)
+
+/**
+  * Configures conditional rendering for the target element
+  * based on a condition and the visibility of one or more trigger elements.
+  *
+  * @param {(this: DOMNodeReference) => boolean} condition -
+  * A function that returns a boolean to determine the visibility
+  * of the target element. If `condition()` returns true, the
+  * element is shown; otherwise, it is hidden.
+  * @param {Array<DOMNodeReference>} dependencies - An array
+  * of `DOMNodeReference` instances. Event listeners are
+  * registered on each to toggle the visibility of the
+  * target element based on the `condition` and the
+  *  visibility of the target node.
+  */
+configureConditionalRendering(
+  condition: (this: DOMNodeReference) => boolean,
+  dependencies: Array<DOMNodeReference>
+  )
+
+
+    // EXAMPLE:
+    const your_node = await createDOMNodeReference("#element_id")
+    const other_node = await createDOMNodeReference(".element_class")
+
+    your_node.configureConditionalRendering(() =>
+        other_node.value == "3",
+        /* your_node will only be
+        visible when the value of other_node is "3"
+        */
+        [other_node]
+        /* and we have to include any DOMNodeReferences used
+        in the evaluation logic, so that changes to them can
+        be watched and the condition evaluated again
+        */
+      );
+
+
+/**
+ * Sets up validation and requirement rules for the field.
+ * This function dynamically updates the field's required status
+ * and validates its input based on the specified conditions.
+ *
+ * @param {function(this: DOMNodeReference): boolean} isRequired
+ * A function that determines whether the field should be required.
+ * Return `true` if required, `false` to not be required.
+ * @param {function(this: DOMNodeReference): boolean} isValid
+ * A function that checks if the field's input is valid.
+ * Return `true` if validation satisfied, `false` if not.
+ * @param {string} fieldDisplayName - The name of the field, used
+ * in error messages if validation fails.
+ * @param {Array<DOMNodeReference>} [dependencies]
+ * Other fields that this field’s requirement depends on. When
+ * these Nodes or their values change, the required status
+ * of this field is re-evaluated. Make sure any DOMNodeReference
+ * used in `isRequired` or `isValid` is included in this array.
+ */
+configureValidationAndRequirements(
+  isRequired: (this: this) => boolean,
+  isValid: (this: this) => boolean,
+  fieldDisplayName: string,
+  dependencies: Array<DOMNodeReference>
+)
+
+    // EXAMPLE:
+    const your_node = await createDOMNodeReference("#element_id")
+    const other_node = await createDOMNodeReference(".element_class")
+
+    your_node.configureValidationAndRequirements(
+        () => other_node.yesRadio.checked,
+        /* if 'yes' is checked for this other node,
+          this function will evaluate to true,
+          meaning that 'your_node' will be required */
+
+        function () {
+          /* important to use standard 'function' declaration,
+            instead of arrow function when needing to
+            access 'this' (the instance of 'your_node') */
+
+          if (other_node.yesRadio.checked) {
+            // when other_node radio is checked 'yes'
+            return this.value; // this is only 'valid' if it has a value
+          } else return true;
+        },
+        "Your Field Name",
+        [other_node]
+        /* since our conditions depend on
+          'other_node' it must be included in the dependency
+          array so that the requirement conditions can be
+          re-evaluated when the value of 'other_node' changes */
+      );
+
+
+/* sets the elements 'disabled' to true - useful for inputs
+that need to be enabled/disabled conditionally */
+disable()
+
+// Sets the element 'disabled' to false
+enable()
+```
+
+```javascript
+// OTHER METHODS
+
 // Sets the value of the associated HTML element.
-setValue(value: string)
+setValue(value: any)
+
+// Sets the inner HTML content of the associated HTML element.
+setTextContent(text: string)
 
 // Appends child elements to the associated HTML element.
 append(...elements: HTMLElement[])
@@ -86,33 +212,18 @@ getLabel(): HTMLElement | null
 // Appends child elements to the label associated with the HTML element.
 appendToLabel(...elements: HTMLElement[])
 
-// Adds a click event listener to the associated HTML element.
-addClickListener(eventHandler: () => void)
-
-// Adds a change event listener to the associated HTML element.
-addChangeListener(eventHandler: () => void)
+// Create an event listener on the target element. Provide access to 'this'
+// in the event handler function
+on(eventType: string, eventHandler: (this: DOMNodeReference) => void)
 
 // Unchecks both yes and no radio buttons if they exist.
 uncheckRadios()
 
-//Creates a validation instance for the field.
-createValidation(evaluationFunction: () => boolean, fieldDisplayName: string)
-
 // Adds a tooltip to the label associated with the HTML element.
 addLabelTooltip(text: string)
 
-// Adds a tooltip to the associated HTML element.
-
-addToolTip(text: string)
-
-// Sets the inner HTML content of the associated HTML element.
-setTextContent(text: string)
-
-// Toggles visibility based on the provided boolean value.
-toggleVisibility(shouldShow: boolean)
-
-// Sets the visibility of the element based on a condition and binds it to another DOMNodeReference.
-configureConditionalRendering(condition: () => boolean, triggerNode?: DOMNodeReference)
+// Adds a tooltip with the specified text to the element
+addTooltip(text: string)
 
 // Executes a callback function once the element is fully loaded.
 onceLoaded(callback: (instance: DOMNodeReference) => void)

package/dist/index.bundle.js

@@ -815,7 +815,7 @@ var DOMNodeReference = /*#__PURE__*/function () {
             case 10:
               this._initValueSync();
               this._attachVisibilityController();
-              this.defaultDisplay = this.visibilityController.style.display;
+              this.defaultDisplay = this.visibilityController.style.display || "inline-block";
               this.isLoaded = true;
               _context.next = 19;
               break;
@@ -983,17 +983,65 @@ var DOMNodeReference = /*#__PURE__*/function () {
         throw new Error("There was an error trying to disable the target: ".concat(this.target));
       }
     }
+  }, {
+    key: "prepend",
+    value: function prepend() {
+      var _this = this;
+      for (var _len = arguments.length, nodes = new Array(_len), _key = 0; _key < _len; _key++) {
+        nodes[_key] = arguments[_key];
+      }
+      nodes.forEach(function (node) {
+        if (node instanceof DOMNodeReference) {
+          _this.element.prepend(node.element);
+        } else {
+          _this.element.prepend(node);
+        }
+      });
+    }
   }, {
     key: "append",
     value: function append() {
-      var _this$element;
-      (_this$element = this.element).append.apply(_this$element, arguments);
+      var _this2 = this;
+      for (var _len2 = arguments.length, nodes = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+        nodes[_key2] = arguments[_key2];
+      }
+      nodes.forEach(function (node) {
+        if (node instanceof DOMNodeReference) {
+          _this2.element.append(node.element);
+        } else {
+          _this2.element.append(node);
+        }
+      });
+    }
+  }, {
+    key: "before",
+    value: function before() {
+      var _this3 = this;
+      for (var _len3 = arguments.length, nodes = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
+        nodes[_key3] = arguments[_key3];
+      }
+      nodes.forEach(function (node) {
+        if (node instanceof DOMNodeReference) {
+          _this3.element.before(node.element);
+        } else {
+          _this3.element.before(node);
+        }
+      });
     }
   }, {
     key: "after",
     value: function after() {
-      var _this$element2;
-      (_this$element2 = this.element).after.apply(_this$element2, arguments);
+      var _this4 = this;
+      for (var _len4 = arguments.length, nodes = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
+        nodes[_key4] = arguments[_key4];
+      }
+      nodes.forEach(function (node) {
+        if (node instanceof DOMNodeReference) {
+          _this4.element.after(node.element);
+        } else {
+          _this4.element.after(node);
+        }
+      });
     }
   }, {
     key: "getLabel",
@@ -1005,8 +1053,8 @@ var DOMNodeReference = /*#__PURE__*/function () {
     value: function appendToLabel() {
       var label = this.getLabel();
       if (label) {
-        for (var _len = arguments.length, elements = new Array(_len), _key = 0; _key < _len; _key++) {
-          elements[_key] = arguments[_key];
+        for (var _len5 = arguments.length, elements = new Array(_len5), _key5 = 0; _key5 < _len5; _key5++) {
+          elements[_key5] = arguments[_key5];
         }
         label.append.apply(label, [" "].concat(elements));
       }
@@ -1017,8 +1065,8 @@ var DOMNodeReference = /*#__PURE__*/function () {
       this.appendToLabel(CreateInfoEl(text));
     }
   }, {
-    key: "addToolTip",
-    value: function addToolTip(text) {
+    key: "addTooltip",
+    value: function addTooltip(text) {
       this.append(CreateInfoEl(text));
     }
   }, {
@@ -1026,6 +1074,17 @@ var DOMNodeReference = /*#__PURE__*/function () {
     value: function setTextContent(text) {
       this.element.innerHTML = text;
     }
+  }, {
+    key: "setStyle",
+    value: function setStyle(options) {
+      var _this5 = this;
+      if (!Object.prototype.toString.call(options) !== "[object Object]") {
+        throw new Error("powerpagestoolkit: 'DOMNodeReference.setStyle' required options to be in the form of an object. Argument passed was of type: ".concat(DOMNodeReferences_typeof(options)));
+      }
+      Object.keys(options).forEach(function (key) {
+        _this5.element.style[key] = options[key];
+      });
+    }
   }, {
     key: "uncheckRadios",
     value: function uncheckRadios() {
@@ -1039,18 +1098,18 @@ var DOMNodeReference = /*#__PURE__*/function () {
   }, {
     key: "configureConditionalRendering",
     value: function configureConditionalRendering(condition, triggerNodes) {
-      var _this = this;
+      var _this6 = this;
       try {
-        this.toggleVisibility(condition());
+        this.toggleVisibility(condition(this));
         if (triggerNodes) {
           var nodes = Array.isArray(triggerNodes) ? triggerNodes : [triggerNodes];
           nodes.forEach(function (node) {
             node.on("change", function () {
-              return _this.toggleVisibility(condition());
+              return _this6.toggleVisibility(condition(_this6));
             });
             var observer = new MutationObserver(function () {
               var display = window.getComputedStyle(node.visibilityController).display;
-              _this.toggleVisibility(display !== "none" && condition());
+              _this6.toggleVisibility(display !== "none" && condition(_this6));
             });
             observer.observe(node.visibilityController, {
               attributes: true,
@@ -1065,7 +1124,7 @@ var DOMNodeReference = /*#__PURE__*/function () {
   }, {
     key: "configureValidationAndRequirements",
     value: function configureValidationAndRequirements(isRequired, isValid, fieldDisplayName) {
-      var _this2 = this;
+      var _this7 = this;
       var dependencies = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : [];
       if (typeof Page_Validators !== "undefined") {
         var newValidator = document.createElement("span");
@@ -1084,7 +1143,7 @@ var DOMNodeReference = /*#__PURE__*/function () {
       dependencies = Array.isArray(dependencies) ? dependencies : [dependencies];
       dependencies.forEach(function (dep) {
         dep.element.addEventListener("change", function () {
-          return _this2.setRequiredLevel(isRequired(_this2));
+          return _this7.setRequiredLevel(isRequired(_this7));
         });
       });
     }
@@ -1100,15 +1159,15 @@ var DOMNodeReference = /*#__PURE__*/function () {
   }, {
     key: "onceLoaded",
     value: function onceLoaded(callback) {
-      var _this3 = this;
+      var _this8 = this;
       if (this.isLoaded) {
         callback(this);
       } else {
         var observer = new MutationObserver(function () {
-          if (document.querySelector(_this3.target)) {
+          if (document.querySelector(_this8.target)) {
             observer.disconnect(); // Stop observing once loaded
-            _this3.isLoaded = true;
-            callback(_this3); // Call the provided callback
+            _this8.isLoaded = true;
+            callback(_this8); // Call the provided callback
           }
         });
         observer.observe(document.body, {
@@ -1159,8 +1218,8 @@ function _createDOMNodeReference() {
               var value = target[prop];
               if (typeof value === "function" && prop !== "onceLoaded") {
                 return function () {
-                  for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-                    args[_key2] = arguments[_key2];
+                  for (var _len6 = arguments.length, args = new Array(_len6), _key6 = 0; _key6 < _len6; _key6++) {
+                    args[_key6] = arguments[_key6];
                   }
                   return target.onceLoaded(function () {
                     return value.apply(target, args);

package/index.d.ts

@@ -8,7 +8,6 @@ class DOMNodeReference {
    */
   constructor(target: string): DOMNodeReference;
 
-  target: string;
   /**
    * The element targeted when instantiating DOMNodeReference.
    * Made available in order to perform normal DOM traversal,
@@ -17,8 +16,6 @@ class DOMNodeReference {
    */
   element: HTMLElement | null;
   isLoaded: boolean;
-  visibilityController: HTMLElement | null;
-  defaultDisplay: string;
   /**
    * The value of the element that this node represents
    * stays in syncs with the live DOM elements via event handler
@@ -78,27 +75,27 @@ class DOMNodeReference {
 
   /**
    * Prepends elements to the target
-   * @param {...HTMLElement} elements - The elements to prepend to the HTML element
+   * @param {HTMLElement[] | DOMNodeReference[]} nodes - The elements to prepend to the HTML element
    */
-  prepend(...elements: HTMLElement[]): void;
+  prepend(...nodes: HTMLElement[] | DOMNodeReference[]): void;
 
   /**
    * Appends child elements to the HTML element.
-   * @param {...HTMLElement} elements - The elements to append to the HTML element.
+   * @param {HTMLElement[] | DOMNodeReference[]} nodes - The elements to append to the HTML element.
    */
-  append(...elements: HTMLElement[]): void;
+  append(...nodes: HTMLElement[] | DOMNodeReference[]): void;
 
   /**
    * Inserts elements before the HTML element.
-   * @param {...HTMLElement} elements - The elements to insert before the HTML element.
+   * @param {HTMLElement[] | DOMNodeReference[]} nodes - The elements to insert before the HTML element.
    */
-  before(...elements: HTMLElement[]): void;
+  before(...nodes: HTMLElement[] | DOMNodeReference[]): void;
 
   /**
    * Inserts elements after the HTML element.
-   * @param {...HTMLElement} elements - The elements to insert after the HTML element.
+   * @param {HTMLElement[] | DOMNodeReference[]} nodes - The elements to insert after the HTML element.
    */
-  after(...elements: HTMLElement[]): void;
+  after(...nodes: HTMLElement[] | DOMNodeReference[]): void;
 
   /**
    * Retrieves the label associated with the HTML element.
@@ -127,18 +124,18 @@ class DOMNodeReference {
   uncheckRadios(): void;
 
   /**
-   * Configures validation and requirement conditions for the field based on the provided logic functions and dependencies.
-   * Creates a validator and sets a required level dynamically based on dependency changes.
-   * @param {(this: DOMNodeReference) => boolean} isRequired - Function to determine if the field is required.
-   * @param {(this: DOMNodeReference) => boolean} isValid - Function to evaluate the field's validity.
-   * @param {string} fieldDisplayName - Display name used in error messages if validation fails.
-   * @param {Array<DOMNodeReference>} [dependencies] - Optional dependencies for setting requirement conditions dynamically.
+   * Sets up validation and requirement rules for the field. This function dynamically updates the field's required status and validates its input based on the specified conditions.
+   *
+   * @param {function(this: DOMNodeReference): boolean} isRequired - A function that determines whether the field should be required. Returns `true` if required, `false` otherwise.
+   * @param {function(this: DOMNodeReference): boolean} isValid - A function that checks if the field's input is valid. Returns `true` if valid, `false` otherwise.
+   * @param {string} fieldDisplayName - The name of the field, used in error messages if validation fails.
+   * @param {Array<DOMNodeReference>} [dependencies] Other fields that this field’s requirement depends on. When these fields change, the required status of this field is re-evaluated. Make sure any DOMNodeReference used in `isRequired` or `isValid` is included in this array.
    */
   configureValidationAndRequirements(
     isRequired: (this: this) => boolean,
     isValid: (this: this) => boolean,
     fieldDisplayName: string,
-    dependencies?: DOMNodeReference[]
+    dependencies: Array<DOMNodeReference>
   ): void;
 
   /**
@@ -155,12 +152,25 @@ class DOMNodeReference {
    */
   addLabelTooltip(text: string): void;
 
+  /**
+   * Adds a tooltip with the specified text to the element
+   * @param {string} text - The text to display in the tooltip
+   */
+  addTooltip(text: string): void;
+
   /**
    * Sets the inner HTML content of the HTML element.
    * @param {string} text - The text to set as the inner HTML of the element.
    */
   setTextContent(text: string): void;
 
+  /**
+   *
+   * @param {Partial<CSSStyleDeclaration>} options - An object with the style properties (keys) and updated styles (values)
+   * to apply to the this. {"key": "value"}
+   */
+  setStyle(options: Partial<CSSStyleDeclaration>): void;
+
   /**
    *
    * @param {boolean} shouldShow shows or hides the target
@@ -172,16 +182,16 @@ class DOMNodeReference {
    * Configures conditional rendering for the target element based on a condition
    * and the visibility of one or more trigger elements.
    *
-   * @param {Function} condition - A function that returns a boolean to determine
+   * @param {(this: DOMNodeReference) => boolean} condition - A function that returns a boolean to determine
    * the visibility of the target element. If `condition()` returns true, the element is shown;
    * otherwise, it is hidden.
-   * @param {DOMNodeReference | DOMNodeReference[]} triggerNodes - A single `DOMNodeReference`
-   * or an array of `DOMNodeReference` instances. Event listeners are registered on each
-   * `triggerNode` to toggle the visibility of the target element based on the `condition`.
+   * @param {Array<DOMNodeReference>} dependencies - An array of `DOMNodeReference` instances. Event listeners are
+   * registered on each to toggle the visibility of the target element based on the `condition` and the visibility of
+   * the target node.
    */
   configureConditionalRendering(
-    condition: () => boolean,
-    triggerNodes?: DOMNodeReference | DOMNodeReference[]
+    condition: (this: DOMNodeReference) => boolean,
+    dependencies: DOMNodeReference[]
   ): void;
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "powerpagestoolkit",
-  "version": "1.3.1041",
+  "version": "1.3.3001",
   "description": "Reference, manipulate, and engage with Power Pages sites through the nodes in the DOM; use a variety of custom methods that allow customizing your power pages site quicker and easier.  ",
   "main": "./dist/index.bundle.js",
   "types": "index.d.ts",