@acorex/cdk 20.1.25 → 20.1.26

package/common/index.d.ts

@@ -297,7 +297,7 @@ declare class MXInteractiveComponent extends MXBaseComponent {
      */
     protected onTouchedCallback: () => void;
     /**
-     * Registers a callback function to be called when the component is touched.
+     * Registers a touched callback function (ControlValueAccessor method).
      *
      * @param fn - The callback function to register.
      */
@@ -413,15 +413,54 @@ declare class MXValueComponent<T = any> extends MXInteractiveComponent implement
     validationRulesChange: EventEmitter<AXFormValidationRule[]>;
     private validationRules;
     get isRequired(): boolean;
+    /**
+     * Adds a validation rule.
+     *
+     * @param rule - The validation rule to add.
+     */
     addValidationRule(rule: AXFormValidationRule): void;
+    /**
+     * Removes a validation rule.
+     *
+     * @param ruleToRemove - The validation rule to remove.
+     */
     removeValidationRule(ruleToRemove: AXFormValidationRule): void;
+    /**
+     * Validates the component.
+     *
+     * @returns Promise<AXValidationSummary> - Validation result.
+     */
     validate(): Promise<AXValidationSummary>;
     protected setState(state: AXComponentState, ...args: any[]): void;
     protected onChangeCallback: (value: T) => void;
+    /**
+     * Registers a change callback function (ControlValueAccessor method).
+     *
+     * @param fn - The callback function to register.
+     */
     registerOnChange(fn: (value: T) => void): void;
+    /**
+     * Writes a value to the component (ControlValueAccessor method).
+     *
+     * @param value - The value to write.
+     */
     writeValue(value: T): void;
+    /**
+     * Commits a value with optional user interaction flag.
+     *
+     * @param value - The value to commit.
+     * @param u - Optional flag indicating if this is a user interaction.
+     */
     commitValue(value: T, u?: boolean): void;
+    /**
+     * Resets the component value.
+     *
+     * @param e - Optional flag indicating if this is a user interaction.
+     */
     reset(e?: boolean): void;
+    /**
+     * Resets validation errors.
+     */
     resetErrors(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<MXValueComponent<any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<MXValueComponent<any>>;

package/fesm2022/acorex-cdk-common.mjs

@@ -439,7 +439,7 @@ class MXInteractiveComponent extends MXBaseComponent {
         // }
     }
     /**
-     * Registers a callback function to be called when the component is touched.
+     * Registers a touched callback function (ControlValueAccessor method).
      *
      * @param fn - The callback function to register.
      */
@@ -667,10 +667,20 @@ class MXValueComponent extends MXInteractiveComponent {
     get isRequired() {
         return this.validationRules?.some((c) => c.rule == 'required');
     }
+    /**
+     * Adds a validation rule.
+     *
+     * @param rule - The validation rule to add.
+     */
     addValidationRule(rule) {
         this.validationRules.push(rule);
         this.validationRulesChange.emit(this.validationRules);
     }
+    /**
+     * Removes a validation rule.
+     *
+     * @param ruleToRemove - The validation rule to remove.
+     */
     removeValidationRule(ruleToRemove) {
         this.validationRules = this.validationRules.filter((r) => {
             if (r.rule !== ruleToRemove.rule) {
@@ -684,6 +694,11 @@ class MXValueComponent extends MXInteractiveComponent {
         this.validationRulesChange.emit(this.validationRules);
         this.setState('clear');
     }
+    /**
+     * Validates the component.
+     *
+     * @returns Promise<AXValidationSummary> - Validation result.
+     */
     async validate() {
         const container_classes = ['ax-editor-container', 'ax-checkbox', 'ax-radio'];
         const container = container_classes.some((c) => this.getHostElement().classList.contains(c))
@@ -752,12 +767,28 @@ class MXValueComponent extends MXInteractiveComponent {
             this.cdr.markForCheck();
         }
     }
+    /**
+     * Registers a change callback function (ControlValueAccessor method).
+     *
+     * @param fn - The callback function to register.
+     */
     registerOnChange(fn) {
         this.onChangeCallback = fn;
     }
+    /**
+     * Writes a value to the component (ControlValueAccessor method).
+     *
+     * @param value - The value to write.
+     */
     writeValue(value) {
         this.value = value;
     }
+    /**
+     * Commits a value with optional user interaction flag.
+     *
+     * @param value - The value to commit.
+     * @param u - Optional flag indicating if this is a user interaction.
+     */
     commitValue(value, u = false) {
         if (u) {
             this.markAsTouched();
@@ -766,9 +797,17 @@ class MXValueComponent extends MXInteractiveComponent {
         }
         this.writeValue(value);
     }
+    /**
+     * Resets the component value.
+     *
+     * @param e - Optional flag indicating if this is a user interaction.
+     */
     reset(e = false) {
         this.commitValue(null, e);
     }
+    /**
+     * Resets validation errors.
+     */
     resetErrors() {
         this.setState('clear');
     }