index.api.md

API Report File for "@angular/material_autocomplete"

Do not edit this file. It is a report generated by API Extractor.

import { ActiveDescendantKeyManager } from '@angular/cdk/a11y';
import { AfterContentInit } from '@angular/core';
import { AfterViewChecked } from '@angular/core';
import { AfterViewInit } from '@angular/core';
import { ChangeDetectorRef } from '@angular/core';
import { ControlValueAccessor } from '@angular/forms';
import { ElementRef } from '@angular/core';
import { EventEmitter } from '@angular/core';
import { FocusableOption } from '@angular/cdk/a11y';
import { FocusOrigin } from '@angular/cdk/a11y';
import * as i0 from '@angular/core';
import * as i1 from '@angular/cdk/scrolling';
import * as i2$1 from '@angular/cdk/bidi';
import * as i2 from '@angular/cdk/overlay';
import { InjectionToken } from '@angular/core';
import { Observable } from 'rxjs';
import { OnChanges } from '@angular/core';
import { OnDestroy } from '@angular/core';
import { OnInit } from '@angular/core';
import { QueryList } from '@angular/core';
import { ScrollStrategy } from '@angular/cdk/overlay';
import { SimpleChanges } from '@angular/core';
import { Subject } from 'rxjs';
import { TemplateRef } from '@angular/core';

// @public
export function getMatAutocompleteMissingPanelError(): Error;

// @public
export const MAT_AUTOCOMPLETE_DEFAULT_OPTIONS: InjectionToken<MatAutocompleteDefaultOptions>;

// @public
export const MAT_AUTOCOMPLETE_SCROLL_STRATEGY: InjectionToken<() => ScrollStrategy>;

// @public
export const MAT_AUTOCOMPLETE_SELECTED_TRIGGER: InjectionToken<MatAutocompleteSelectedTrigger>;

// @public
export const MAT_AUTOCOMPLETE_VALUE_ACCESSOR: any;

// @public
export class MatAutocomplete implements AfterContentInit, OnDestroy {
    constructor(...args: unknown[]);
    // (undocumented)
    protected _animationsDisabled: boolean;
    ariaLabel: string;
    ariaLabelledby: string;
    autoActiveFirstOption: boolean;
    autoSelectActiveOption: boolean;
    set classList(value: string | string[]);
    // (undocumented)
    _classList: string | string[];
    readonly closed: EventEmitter<void>;
    protected _color: ThemePalette;
    customTrigger: MatAutocompleteSelectedTrigger | undefined;
    // (undocumented)
    protected _defaults: MatAutocompleteDefaultOptions;
    disableRipple: boolean;
    displayWith: ((value: any) => string) | null;
    _emitSelectEvent(option: MatOption): void;
    _getPanelAriaLabelledby(labelId: string | null): string | null;
    _getScrollTop(): number;
    get hideSingleSelectionIndicator(): boolean;
    set hideSingleSelectionIndicator(value: boolean);
    id: string;
    readonly inertGroups: boolean;
    get isOpen(): boolean;
    // (undocumented)
    _isOpen: boolean;
    _keyManager: ActiveDescendantKeyManager<MatOption>;
    _latestOpeningTrigger: unknown;
    // (undocumented)
    static ngAcceptInputType_autoActiveFirstOption: unknown;
    // (undocumented)
    static ngAcceptInputType_autoSelectActiveOption: unknown;
    // (undocumented)
    static ngAcceptInputType_disableRipple: unknown;
    // (undocumented)
    static ngAcceptInputType_hideSingleSelectionIndicator: unknown;
    // (undocumented)
    static ngAcceptInputType_requireSelection: unknown;
    // (undocumented)
    ngAfterContentInit(): void;
    // (undocumented)
    ngOnDestroy(): void;
    readonly opened: EventEmitter<void>;
    readonly optionActivated: EventEmitter<MatAutocompleteActivatedEvent>;
    optionGroups: QueryList<MatOptgroup>;
    options: QueryList<MatOption>;
    readonly optionSelected: EventEmitter<MatAutocompleteSelectedEvent>;
    panel: ElementRef;
    panelWidth: string | number;
    requireSelection: boolean;
    _setColor(value: ThemePalette): void;
    _setScrollTop(scrollTop: number): void;
    _setVisibility(): void;
    showPanel: boolean;
    // (undocumented)
    protected _skipPredicate(): boolean;
    _syncParentProperties(): void;
    template: TemplateRef<any>;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatAutocomplete, "mat-autocomplete", ["matAutocomplete"], { "ariaLabel": { "alias": "aria-label"; "required": false; }; "ariaLabelledby": { "alias": "aria-labelledby"; "required": false; }; "displayWith": { "alias": "displayWith"; "required": false; }; "autoActiveFirstOption": { "alias": "autoActiveFirstOption"; "required": false; }; "autoSelectActiveOption": { "alias": "autoSelectActiveOption"; "required": false; }; "requireSelection": { "alias": "requireSelection"; "required": false; }; "panelWidth": { "alias": "panelWidth"; "required": false; }; "disableRipple": { "alias": "disableRipple"; "required": false; }; "classList": { "alias": "class"; "required": false; }; "hideSingleSelectionIndicator": { "alias": "hideSingleSelectionIndicator"; "required": false; }; }, { "optionSelected": "optionSelected"; "opened": "opened"; "closed": "closed"; "optionActivated": "optionActivated"; }, ["customTrigger", "options", "optionGroups"], ["*"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatAutocomplete, never>;
}

// @public
export interface MatAutocompleteActivatedEvent {
    option: MatOption | null;
    source: MatAutocomplete;
}

// @public
export interface MatAutocompleteDefaultOptions {
    autoActiveFirstOption?: boolean;
    autoSelectActiveOption?: boolean;
    backdropClass?: string;
    hasBackdrop?: boolean;
    hideSingleSelectionIndicator?: boolean;
    overlayPanelClass?: string | string[];
    requireSelection?: boolean;
}

// @public (undocumented)
export class MatAutocompleteModule {
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatAutocompleteModule, never>;
    // (undocumented)
    static ɵinj: i0.ɵɵInjectorDeclaration<MatAutocompleteModule>;
    // (undocumented)
    static ɵmod: i0.ɵɵNgModuleDeclaration<MatAutocompleteModule, never, [typeof i2.OverlayModule, typeof MatOptionModule, typeof MatAutocomplete, typeof MatAutocompleteTrigger, typeof MatAutocompleteOrigin, typeof MatAutocompleteSelectedTrigger], [typeof i1.CdkScrollableModule, typeof MatAutocomplete, typeof MatOptionModule, typeof i2$1.BidiModule, typeof MatAutocompleteTrigger, typeof MatAutocompleteOrigin, typeof MatAutocompleteSelectedTrigger]>;
}

// @public
export class MatAutocompleteOrigin {
    constructor(...args: unknown[]);
    // (undocumented)
    elementRef: ElementRef<HTMLElement>;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatAutocompleteOrigin, "[matAutocompleteOrigin]", ["matAutocompleteOrigin"], {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatAutocompleteOrigin, never>;
}

// @public
export class MatAutocompleteSelectedEvent {
    constructor(
    source: MatAutocomplete,
    option: MatOption);
    option: MatOption;
    source: MatAutocomplete;
}

// @public
export class MatAutocompleteSelectedTrigger {
    // (undocumented)
    readonly templateRef: TemplateRef<any>;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatAutocompleteSelectedTrigger, "ng-template[matAutocompleteSelectedTrigger]", never, {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatAutocompleteSelectedTrigger, never>;
}

// @public
export class MatAutocompleteTrigger implements ControlValueAccessor, AfterViewInit, OnChanges, OnDestroy {
    constructor(...args: unknown[]);
    get activeOption(): MatOption | null;
    autocomplete: MatAutocomplete;
    autocompleteAttribute: string;
    autocompleteDisabled: boolean;
    closePanel(): void;
    connectedTo: MatAutocompleteOrigin;
    // (undocumented)
    _handleBlur(): void;
    // (undocumented)
    _handleClick(): void;
    // (undocumented)
    _handleFocus(): void;
    // (undocumented)
    _handleInput(event: Event): void;
    // (undocumented)
    _handleKeydown(e: Event): void;
    // (undocumented)
    static ngAcceptInputType_autocompleteDisabled: unknown;
    // (undocumented)
    ngAfterViewInit(): void;
    // (undocumented)
    ngOnChanges(changes: SimpleChanges<this>): void;
    // (undocumented)
    ngOnDestroy(): void;
    _onChange: (value: any) => void;
    _onTouched: () => void;
    openPanel(): void;
    readonly optionSelections: Observable<MatOptionSelectionChange>;
    readonly _overlayPanelClass: string[];
    get panelClosingActions(): Observable<MatOptionSelectionChange | null>;
    get panelOpen(): boolean;
    position: 'auto' | 'above' | 'below';
    // (undocumented)
    registerOnChange(fn: (value: any) => {}): void;
    // (undocumented)
    registerOnTouched(fn: () => {}): void;
    // (undocumented)
    setDisabledState(isDisabled: boolean): void;
    updatePosition(): void;
    // (undocumented)
    writeValue(value: any): void;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatAutocompleteTrigger, "input[matAutocomplete], textarea[matAutocomplete]", ["matAutocompleteTrigger"], { "autocomplete": { "alias": "matAutocomplete"; "required": false; }; "position": { "alias": "matAutocompletePosition"; "required": false; }; "connectedTo": { "alias": "matAutocompleteConnectedTo"; "required": false; }; "autocompleteAttribute": { "alias": "autocomplete"; "required": false; }; "autocompleteDisabled": { "alias": "matAutocompleteDisabled"; "required": false; }; }, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatAutocompleteTrigger, never>;
}

// @public
export class MatOptgroup {
    constructor(...args: unknown[]);
    disabled: boolean;
    _inert: boolean;
    label: string;
    _labelId: string;
    // (undocumented)
    static ngAcceptInputType_disabled: unknown;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatOptgroup, "mat-optgroup", ["matOptgroup"], { "label": { "alias": "label"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, {}, never, ["*", "mat-option, ng-container"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatOptgroup, never>;
}

// @public
export class MatOption<T = any> implements FocusableOption, AfterViewChecked, OnDestroy {
    constructor(...args: unknown[]);
    get active(): boolean;
    // (undocumented)
    _changeDetectorRef: ChangeDetectorRef;
    deselect(emitEvent?: boolean): void;
    get disabled(): boolean;
    set disabled(value: boolean);
    get disableRipple(): boolean;
    focus(_origin?: FocusOrigin, options?: FocusOptions): void;
    _getHostElement(): HTMLElement;
    getLabel(): string;
    _getTabIndex(): string;
    // (undocumented)
    group: MatOptgroup | null;
    _handleKeydown(event: KeyboardEvent): void;
    get hideSingleSelectionIndicator(): boolean;
    id: string;
    get multiple(): boolean | null | undefined;
    // (undocumented)
    static ngAcceptInputType_disabled: unknown;
    // (undocumented)
    ngAfterViewChecked(): void;
    // (undocumented)
    ngOnDestroy(): void;
    readonly onSelectionChange: EventEmitter<MatOptionSelectionChange<T>>;
    select(emitEvent?: boolean): void;
    get selected(): boolean;
    _selectViaInteraction(): void;
    setActiveStyles(): void;
    setInactiveStyles(): void;
    readonly _stateChanges: Subject<void>;
    _text: ElementRef<HTMLElement> | undefined;
    value: T;
    get viewValue(): string;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatOption<any>, "mat-option", ["matOption"], { "value": { "alias": "value"; "required": false; }; "id": { "alias": "id"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, { "onSelectionChange": "onSelectionChange"; }, never, ["mat-icon", "*"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatOption<any>, never>;
}

// (No @packageDocumentation comment for this package)