@ng-matero/extensions 13.2.1 → 13.3.0

package/select/select.component.d.ts

@@ -1,11 +1,12 @@
-import { OnInit, OnDestroy, DoCheck, ElementRef, ChangeDetectorRef, EventEmitter, TemplateRef, QueryList, AfterViewInit } from '@angular/core';
-import { ControlValueAccessor, NgControl } from '@angular/forms';
-import { MatFormFieldControl } from '@angular/material/form-field';
-import { BooleanInput } from '@angular/cdk/coercion';
 import { FocusMonitor } from '@angular/cdk/a11y';
+import { BooleanInput } from '@angular/cdk/coercion';
+import { AfterViewInit, ChangeDetectorRef, DoCheck, ElementRef, EventEmitter, OnDestroy, OnInit, QueryList, TemplateRef } from '@angular/core';
+import { ErrorStateMatcher } from '@angular/material/core';
+import { ControlValueAccessor, FormGroupDirective, NgControl, NgForm } from '@angular/forms';
+import { MatFormField, MatFormFieldControl } from '@angular/material/form-field';
 import { Subject } from 'rxjs';
-import { MtxOptionComponent } from './option.component';
 import { NgSelectComponent } from '@ng-select/ng-select';
+import { MtxOptionComponent } from './option.component';
 import * as i0 from "@angular/core";
 export declare type DropdownPosition = 'bottom' | 'top' | 'auto';
 export declare type AddTagFn = (term: string) => any | Promise<any>;
@@ -13,12 +14,31 @@ export declare type CompareWithFn = (a: any, b: any) => boolean;
 export declare type GroupValueFn = (key: string | Record<string, any>, children: any[]) => string | Record<string, any>;
 export declare type SearchFn = (term: string, item: any) => boolean;
 export declare type TrackByFn = (item: any) => any;
-export declare function isDefined(value: any): boolean;
-export declare class MtxSelectComponent implements OnInit, OnDestroy, DoCheck, AfterViewInit, ControlValueAccessor, MatFormFieldControl<any> {
-    private _focusMonitor;
-    private _elementRef;
-    private _changeDetectorRef;
-    ngControl: NgControl;
+/** @docs-private */
+declare const _MtxSelectMixinBase: 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;
+    };
+};
+export declare class MtxSelectComponent extends _MtxSelectMixinBase implements OnInit, OnDestroy, DoCheck, AfterViewInit, ControlValueAccessor, MatFormFieldControl<any> {
+    protected _changeDetectorRef: ChangeDetectorRef;
+    protected _elementRef: ElementRef;
+    protected _focusMonitor: FocusMonitor;
+    private _parentFormField?;
     ngSelect: NgSelectComponent;
     optionTemplate: TemplateRef<any>;
     optgroupTemplate: TemplateRef<any>;
@@ -32,7 +52,6 @@ export declare class MtxSelectComponent implements OnInit, OnDestroy, DoCheck, A
     tagTemplate: TemplateRef<any>;
     loadingSpinnerTemplate: TemplateRef<any>;
     mtxOptions: QueryList<MtxOptionComponent>;
-    /** MtxSelect options */
     addTag: boolean | AddTagFn;
     addTagText: string;
     appearance: string;
@@ -94,11 +113,12 @@ export declare class MtxSelectComponent implements OnInit, OnDestroy, DoCheck, A
     scrollToEnd: EventEmitter<any>;
     get clearSearchOnAdd(): boolean;
     set clearSearchOnAdd(value: boolean);
-    private _clearSearchOnAdd;
+    private _clearSearchOnAdd?;
     get items(): any[];
     set items(value: any[]);
     private _items;
     private _itemsAreUsed;
+    /** Emits whenever the component is destroyed. */
     private readonly _destroy$;
     /** Value of the select control. */
     get value(): any;
@@ -110,37 +130,55 @@ export declare class MtxSelectComponent implements OnInit, OnDestroy, DoCheck, A
     get id(): string;
     set id(value: string);
     private _id;
-    /** Unique id for this input. */
+    /** Unique id for this select. */
     private _uid;
     /** Placeholder to be shown if value is empty. */
     get placeholder(): string;
     set placeholder(value: string);
     private _placeholder;
-    /** Whether the input is focused. */
+    /** Whether the select is focused. */
     get focused(): boolean;
     private _focused;
+    /** Whether the select has a value. */
     get empty(): boolean;
+    /**
+     * Implemented as part of MatFormFieldControl.
+     * @docs-private
+     */
     get shouldLabelFloat(): boolean;
+    /** Whether the component is required. */
     get required(): boolean;
     set required(value: boolean);
     private _required;
+    /** Whether the select is disabled. */
     get disabled(): boolean;
     set disabled(value: boolean);
     private _disabled;
-    errorState: boolean;
+    /** Object used to control when error messages are shown. */
+    errorStateMatcher: ErrorStateMatcher;
+    /** Aria label of the select. */
+    ariaLabel: string;
+    /** Input that can be used to specify the `aria-labelledby` attribute. */
+    ariaLabelledby: string | null;
+    /** The aria-describedby attribute on the select for improved a11y. */
+    _ariaDescribedby: string | null;
     /** A name for this control that can be used by `mat-form-field`. */
     controlType: string;
-    /** The aria-describedby attribute on the select for improved a11y. */
-    _ariaDescribedby: string;
     /** `View -> model callback called when value changes` */
     _onChange: (value: any) => void;
     /** `View -> model callback called when select has been touched` */
     _onTouched: () => void;
-    constructor(_focusMonitor: FocusMonitor, _elementRef: ElementRef<HTMLElement>, _changeDetectorRef: ChangeDetectorRef, ngControl: NgControl);
+    /** ID for the DOM node containing the select's value. */
+    _valueId: string;
+    /** Whether or not the overlay panel is open. */
+    get panelOpen(): boolean;
+    constructor(_changeDetectorRef: ChangeDetectorRef, _elementRef: ElementRef, _focusMonitor: FocusMonitor, _defaultErrorStateMatcher: ErrorStateMatcher, _parentForm: NgForm, _parentFormGroup: FormGroupDirective, ngControl: NgControl, _parentFormField?: MatFormField | undefined);
     ngOnInit(): void;
     ngAfterViewInit(): void;
     ngDoCheck(): void;
     ngOnDestroy(): void;
+    /** Gets the value for the `aria-labelledby` attribute of the inputs. */
+    _getAriaLabelledby(): string | null;
     /** Implemented as part of MatFormFieldControl. */
     setDescribedByIds(ids: string[]): void;
     /**
@@ -175,7 +213,7 @@ export declare class MtxSelectComponent implements OnInit, OnDestroy, DoCheck, A
      * @param fn Callback to be triggered when the component has been touched.
      */
     registerOnTouched(fn: any): void;
-    /** NgSelect: _setItemsFromNgOptions */
+    /** NgSelect's `_setItemsFromNgOptions` */
     private _setItemsFromMtxOptions;
     open(): void;
     close(): void;
@@ -183,6 +221,7 @@ export declare class MtxSelectComponent implements OnInit, OnDestroy, DoCheck, A
     blur(): void;
     static ngAcceptInputType_required: BooleanInput;
     static ngAcceptInputType_disabled: BooleanInput;
-    static ɵfac: i0.ɵɵFactoryDeclaration<MtxSelectComponent, [null, null, null, { optional: true; self: true; }]>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<MtxSelectComponent, "mtx-select", ["mtxSelect"], { "addTag": "addTag"; "addTagText": "addTagText"; "appearance": "appearance"; "appendTo": "appendTo"; "bindLabel": "bindLabel"; "bindValue": "bindValue"; "closeOnSelect": "closeOnSelect"; "clearAllText": "clearAllText"; "clearable": "clearable"; "clearOnBackspace": "clearOnBackspace"; "compareWith": "compareWith"; "dropdownPosition": "dropdownPosition"; "groupBy": "groupBy"; "groupValue": "groupValue"; "selectableGroup": "selectableGroup"; "selectableGroupAsModel": "selectableGroupAsModel"; "hideSelected": "hideSelected"; "isOpen": "isOpen"; "loading": "loading"; "loadingText": "loadingText"; "labelForId": "labelForId"; "markFirst": "markFirst"; "maxSelectedItems": "maxSelectedItems"; "multiple": "multiple"; "notFoundText": "notFoundText"; "searchable": "searchable"; "readonly": "readonly"; "searchFn": "searchFn"; "searchWhileComposing": "searchWhileComposing"; "selectOnTab": "selectOnTab"; "trackByFn": "trackByFn"; "inputAttrs": "inputAttrs"; "tabIndex": "tabIndex"; "openOnEnter": "openOnEnter"; "minTermLength": "minTermLength"; "editableSearchTerm": "editableSearchTerm"; "keyDownFn": "keyDownFn"; "virtualScroll": "virtualScroll"; "typeToSearchText": "typeToSearchText"; "typeahead": "typeahead"; "clearSearchOnAdd": "clearSearchOnAdd"; "items": "items"; "value": "value"; "id": "id"; "placeholder": "placeholder"; "required": "required"; "disabled": "disabled"; }, { "blurEvent": "blur"; "focusEvent": "focus"; "changeEvent": "change"; "openEvent": "open"; "closeEvent": "close"; "searchEvent": "search"; "clearEvent": "clear"; "addEvent": "add"; "removeEvent": "remove"; "scroll": "scroll"; "scrollToEnd": "scrollToEnd"; }, ["optionTemplate", "optgroupTemplate", "labelTemplate", "multiLabelTemplate", "headerTemplate", "footerTemplate", "notFoundTemplate", "typeToSearchTemplate", "loadingTextTemplate", "tagTemplate", "loadingSpinnerTemplate", "mtxOptions"], never>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MtxSelectComponent, [null, null, null, null, { optional: true; }, { optional: true; }, { optional: true; self: true; }, { optional: true; }]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MtxSelectComponent, "mtx-select", ["mtxSelect"], { "addTag": "addTag"; "addTagText": "addTagText"; "appearance": "appearance"; "appendTo": "appendTo"; "bindLabel": "bindLabel"; "bindValue": "bindValue"; "closeOnSelect": "closeOnSelect"; "clearAllText": "clearAllText"; "clearable": "clearable"; "clearOnBackspace": "clearOnBackspace"; "compareWith": "compareWith"; "dropdownPosition": "dropdownPosition"; "groupBy": "groupBy"; "groupValue": "groupValue"; "selectableGroup": "selectableGroup"; "selectableGroupAsModel": "selectableGroupAsModel"; "hideSelected": "hideSelected"; "isOpen": "isOpen"; "loading": "loading"; "loadingText": "loadingText"; "labelForId": "labelForId"; "markFirst": "markFirst"; "maxSelectedItems": "maxSelectedItems"; "multiple": "multiple"; "notFoundText": "notFoundText"; "searchable": "searchable"; "readonly": "readonly"; "searchFn": "searchFn"; "searchWhileComposing": "searchWhileComposing"; "selectOnTab": "selectOnTab"; "trackByFn": "trackByFn"; "inputAttrs": "inputAttrs"; "tabIndex": "tabIndex"; "openOnEnter": "openOnEnter"; "minTermLength": "minTermLength"; "editableSearchTerm": "editableSearchTerm"; "keyDownFn": "keyDownFn"; "virtualScroll": "virtualScroll"; "typeToSearchText": "typeToSearchText"; "typeahead": "typeahead"; "clearSearchOnAdd": "clearSearchOnAdd"; "items": "items"; "value": "value"; "id": "id"; "placeholder": "placeholder"; "required": "required"; "disabled": "disabled"; "errorStateMatcher": "errorStateMatcher"; "ariaLabel": "aria-label"; "ariaLabelledby": "aria-labelledby"; }, { "blurEvent": "blur"; "focusEvent": "focus"; "changeEvent": "change"; "openEvent": "open"; "closeEvent": "close"; "searchEvent": "search"; "clearEvent": "clear"; "addEvent": "add"; "removeEvent": "remove"; "scroll": "scroll"; "scrollToEnd": "scrollToEnd"; }, ["optionTemplate", "optgroupTemplate", "labelTemplate", "multiLabelTemplate", "headerTemplate", "footerTemplate", "notFoundTemplate", "typeToSearchTemplate", "loadingTextTemplate", "tagTemplate", "loadingSpinnerTemplate", "mtxOptions"], never>;
 }
+export {};