@messaia/cdk 18.2.3 → 19.0.0-rc02

package/lib/forms/helpers/abstract-mat-form-field.d.ts

@@ -1,196 +1,252 @@
 import { FocusMonitor } from "@angular/cdk/a11y";
 import { ChangeDetectorRef, DoCheck, ElementRef, OnDestroy } from "@angular/core";
-import { ControlValueAccessor, FormGroupDirective, NgControl, NgForm } from "@angular/forms";
-import { ErrorStateMatcher } from "@angular/material/core";
+import { ControlValueAccessor, NgControl } from "@angular/forms";
+import { _ErrorStateTracker, ErrorStateMatcher } from "@angular/material/core";
 import { MatFormFieldControl } from "@angular/material/form-field";
 import { Subject } from "rxjs";
 import * as i0 from "@angular/core";
-declare const _AbstractMatFormFieldBase: import("@angular/material/core")._Constructor<import("@angular/material/core").CanUpdateErrorState> & import("@angular/material/core")._AbstractConstructor<import("@angular/material/core").CanUpdateErrorState> & {
-    new (_defaultErrorStateMatcher: ErrorStateMatcher, _parentForm: NgForm, _parentFormGroup: FormGroupDirective, ngControl: NgControl): {
-        /**
-         * Emits whenever the component state changes and should cause the parent
-         * form-field to update. Implemented as part of `MatFormFieldControl`.
-         * @docs-private
-         */
-        readonly stateChanges: Subject<void>;
-        _defaultErrorStateMatcher: ErrorStateMatcher;
-        _parentForm: NgForm;
-        _parentFormGroup: FormGroupDirective;
-        /**
-         * Form control bound to the component.
-         * Implemented as part of `MatFormFieldControl`.
-         * @docs-private
-         */
-        ngControl: NgControl;
-    };
-};
 /**
- * AbstractMatFormField class
+ * Abstract class for custom form field controls.
  */
-export declare abstract class AbstractMatFormField<T> extends _AbstractMatFormFieldBase implements DoCheck, OnDestroy, ControlValueAccessor, MatFormFieldControl<T> {
+export declare abstract class AbstractMatFormField<T> implements DoCheck, OnDestroy, ControlValueAccessor, MatFormFieldControl<T> {
     controlType: string;
-    readonly ngControl: NgControl;
-    readonly _parentForm: NgForm;
-    readonly _parentFormGroup: FormGroupDirective;
-    readonly _defaultErrorStateMatcher: ErrorStateMatcher;
-    protected readonly _focusMonitor: FocusMonitor;
-    protected readonly _elementRef: ElementRef;
-    protected readonly changeDetectorRef: ChangeDetectorRef;
     /**
-     * The value of the control.
+     * @property ngControl
+     * @description Gets the Angular control directive for this control.
+     * @type {NgControl}
+     */
+    ngControl: NgControl;
+    /**
+     * @property changeDetectorRef
+     * @description Change detector reference.
+     * @type {ChangeDetectorRef}
+     */
+    protected changeDetectorRef: ChangeDetectorRef;
+    /**
+     * @property elementRef
+     * @description Element reference.
+     * @type {ElementRef}
+     */
+    readonly elementRef: ElementRef<any>;
+    /**
+     * @property focusMonitor
+     * @description Focus monitor.
+     * @type {FocusMonitor}
+     */
+    readonly focusMonitor: FocusMonitor;
+    /**
+     * @property errorStateTracker
+     * @description Error state tracker.
+     * @type {_ErrorStateTracker}
+     */
+    protected errorStateTracker?: _ErrorStateTracker;
+    /**
+     * @property errorStateMatcher
+     * @description Error state matcher.
+     * @type {ErrorStateMatcher}
+     */
+    get errorStateMatcher(): ErrorStateMatcher;
+    set errorStateMatcher(value: ErrorStateMatcher);
+    /**
+     * @property errorState
+     * @description Error state.
+     * @type {boolean}
+     */
+    get errorState(): boolean;
+    set errorState(value: boolean);
+    /**
+     * @property stateChanges
+     * @description Emits when the component state changes.
+     * @type {Subject<void>}
+     */
+    readonly stateChanges: Subject<void>;
+    /**
+     * @property _value
+     * @description Control value.
+     * @type {T | null}
      */
     protected _value: T | null;
     /**
-     * Sets the value
+     * @property value
+     * @description Sets the control value.
+     * @type {T}
      */
     set value(value: T);
     /**
-     * Gets the value
+     * @property value
+     * @description Gets the control value.
+     * @type {T | null}
      */
     get value(): T | null;
     /**
-     * The placeholder for this control.
+     * @property _placeholder
+     * @description Placeholder text.
+     * @type {string}
      */
     _placeholder: string;
     /**
-     * Sets the placeholder
+     * @property placeholder
+     * @description Sets the placeholder text.
+     * @type {string}
      */
     set placeholder(placeholder: string);
     /**
-     * Gets the placeholder
+     * @property placeholder
+     * @description Gets the placeholder text.
+     * @type {string}
      */
     get placeholder(): string;
     /**
-     * Whether the control is required.
+     * @property _required
+     * @description Required state.
+     * @type {boolean}
      */
     _required: boolean;
     /**
-     * Sets the required
-     * @param required
+     * @property required
+     * @description Sets the required state.
+     * @type {boolean}
      */
     set required(required: any);
     /**
-     * Gets the required
+     * @property required
+     * @description Gets the required state.
+     * @type {boolean}
      */
     get required(): any;
     /**
-     * Readonly
+     * @property _readonly
+     * @description Readonly state.
+     * @type {boolean}
      */
     _readonly?: boolean;
     /**
-     * Multiple select option
+     * @property readonly
+     * @description Sets the readonly state.
+     * @type {boolean}
      */
     get readonly(): boolean | undefined;
     set readonly(readonly: boolean | undefined);
     /**
-     * Whether the control is disabled.
+     * @property _disabled
+     * @description Disabled state.
+     * @type {boolean}
      */
     _disabled: boolean;
     /**
-     * Gets the control is disabled.
-     * @param disabled
+     * @property disabled
+     * @description Sets the disabled state.
+     * @type {boolean}
      */
     set disabled(disabled: any);
     /**
-     * Sets the disabled.
-     * @param disabled
+     * @property disabled
+     * @description Gets the disabled state.
+     * @type {boolean}
      */
     get disabled(): any;
     /**
-     * Gets the empty value
+     * @property empty
+     * @description Checks if the control is empty.
+     * @type {boolean}
      */
     get empty(): boolean;
     /**
-     * Whether the `MatFormField` label should try to float.
+     * @property shouldLabelFloat
+     * @description Checks if the label should float.
+     * @type {boolean}
      */
     get shouldLabelFloat(): boolean;
     /**
-     * The element ID
+     * @property focused
+     * @description Focused state.
+     * @type {boolean}
+     */
+    focused: boolean;
+    /**
+     * @property touched
+     * @description Touched state.
+     * @type {boolean}
+     */
+    touched: boolean;
+    /**
+     * @property nextId
+     * @description Element ID.
+     * @type {number}
      */
     private static nextId;
     /**
-     * The element ID
+     * @property id
+     * @description Element ID.
+     * @type {string}
      */
     id: string;
     /**
-     * Used to indicate the IDs of the elements that describe the object.
+     * @property describedBy
+     * @description ARIA described by attribute.
+     * @type {string}
      */
     describedBy: string;
     /**
-     * Constructor
-     * @param controlType
-     * @param ngControl
-     * @param _parentForm
-     * @param _parentFormGroup
-     * @param _defaultErrorStateMatcher
-     * @param _focusMonitor
-     * @param _elementRef
+     * @description Constructor.
      */
-    constructor(controlType: string, ngControl: NgControl, _parentForm: NgForm, _parentFormGroup: FormGroupDirective, _defaultErrorStateMatcher: ErrorStateMatcher, _focusMonitor: FocusMonitor, _elementRef: ElementRef, changeDetectorRef: ChangeDetectorRef);
+    constructor(controlType: string);
     /**
-     * Registers a function called when the control value changes.
+     * @description Registers a function called when the control value changes.
+     * @param {function} fn - Change callback function.
      */
     registerOnChange(fn: (_: T) => void): void;
     /**
-     * Registers a callback function that is called by the forms API on initialization
-     * to update the form model on blur.
-     * @param fn
+     * @description Registers a function called when the control is touched.
+     * @param {function} fn - Touched callback function.
      */
     registerOnTouched(fn: () => void): void;
     /**
-     * Writes a new value to the element.
-     * @param value
+     * @description Writes a new value to the control.
+     * @param {T} value - New value.
      */
     writeValue(value: T): void;
     /**
-     * Sets the list of element IDs that currently describe this control.
-     * @param ids
+     * @description Sets the described by IDs.
+     * @param {string[]} ids - Array of IDs.
      */
     setDescribedByIds(ids: string[]): void;
     /**
-     * Whether the control is focused.
-     */
-    focused: boolean;
-    /**
-     * Whether the control is touched.
+     * @description Updates the error state.
      */
-    touched: boolean;
+    updateErrorState(): void;
     /**
-     * Whether the control is focused.
+     * @description Handles blur event.
      */
     onBlur(): void;
     /**
-     * Sets focus of the control
+     * @description Focuses the control.
      */
     abstract focus(): void;
     /**
-     * Handles a click on the control's container.
+     * @description Handles container click.
      */
     onContainerClick(): void;
     /**
-     * The registered callback function called when an input
-     * event occurs on the input element.
+     * @property onChange
+     * @description Change callback.
+     * @type {function}
      */
     protected onChange?: (value: T) => void;
     /**
-     * The registered callback function called when a blur
-     * event occurs on the input element.
+     * @property onTouched
+     * @description Touched callback.
+     * @type {function}
      */
     protected onTouched?: () => void;
     /**
-     * A callback method that performs change-detection, invoked
-     * after the default change-detector runs.
-     * See `KeyValueDiffers` and `IterableDiffers` for implementing
-     * custom change checking for collections.
-     *
+     * @description Lifecycle hook for change detection.
      */
     ngDoCheck(): void;
     /**
-     * A lifecycle method called before the directive's instance
-     * is destroyed. For internal use only.
+     * @description Lifecycle hook for cleanup.
      */
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AbstractMatFormField<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractMatFormField<any>, never, never, { "placeholder": { "alias": "placeholder"; "required": false; }; "required": { "alias": "required"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, {}, never, never, false, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractMatFormField<any>, never, never, { "errorStateMatcher": { "alias": "errorStateMatcher"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "required": { "alias": "required"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, {}, never, never, true, never>;
 }
-export {};