Skip to content

Latest commit

 

History

History
539 lines (508 loc) · 21.2 KB

index.api.md

File metadata and controls

539 lines (508 loc) · 21.2 KB

API Report File for "@angular/material_chips"

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

import { AbstractControl } from '@angular/forms';
import { AbstractControlDirective } from '@angular/forms';
import { AfterContentInit } from '@angular/core';
import { AfterViewInit } from '@angular/core';
import { ChangeDetectorRef } from '@angular/core';
import { ControlValueAccessor } from '@angular/forms';
import { DoCheck } from '@angular/core';
import { ElementRef } from '@angular/core';
import { EventEmitter } from '@angular/core';
import { FocusKeyManager } from '@angular/cdk/a11y';
import { FormGroupDirective } from '@angular/forms';
import * as i0 from '@angular/core';
import * as i1 from '@angular/cdk/bidi';
import { InjectionToken } from '@angular/core';
import { Injector } from '@angular/core';
import { NgControl } from '@angular/forms';
import { NgForm } from '@angular/forms';
import { NgZone } 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 { Subject } from 'rxjs';

// @public
export const MAT_CHIP: InjectionToken<unknown>;

// @public
export const MAT_CHIP_AVATAR: InjectionToken<unknown>;

// @public
export const MAT_CHIP_LISTBOX_CONTROL_VALUE_ACCESSOR: any;

// @public
export const MAT_CHIP_REMOVE: InjectionToken<unknown>;

// @public
export const MAT_CHIP_TRAILING_ICON: InjectionToken<unknown>;

// @public
export const MAT_CHIPS_DEFAULT_OPTIONS: InjectionToken<MatChipsDefaultOptions>;

// @public
export class MatChip implements OnInit, AfterViewInit, AfterContentInit, DoCheck, OnDestroy {
    constructor(...args: unknown[]);
    protected _allLeadingIcons: QueryList<MatChipAvatar>;
    protected _allRemoveIcons: QueryList<MatChipRemove>;
    protected _allTrailingIcons: QueryList<MatChipTrailingIcon>;
    _animationsDisabled: boolean;
    ariaDescription: string | null;
    _ariaDescriptionId: string;
    ariaLabel: string | null;
    protected basicChipAttrName: string;
    // (undocumented)
    _changeDetectorRef: ChangeDetectorRef;
    _chipListDisabled: boolean;
    color?: string | null;
    readonly destroyed: EventEmitter<MatChipEvent>;
    get disabled(): boolean;
    set disabled(value: boolean);
    disableRipple: boolean;
    // (undocumented)
    protected _document: Document;
    // (undocumented)
    _elementRef: ElementRef<HTMLElement>;
    focus(): void;
    _getActions(): MatChipAction[];
    _getSourceAction(target: Node): MatChipAction | undefined;
    _handleKeydown(event: KeyboardEvent): void;
    _handlePrimaryActionInteraction(): void;
    // (undocumented)
    _hasFocus(): boolean;
    _hasTrailingIcon(): boolean;
    highlighted: boolean;
    id: string;
    // (undocumented)
    protected _injector: Injector;
    _isBasicChip: boolean;
    _isRippleDisabled(): boolean;
    leadingIcon: MatChipAvatar;
    // (undocumented)
    static ngAcceptInputType_disabled: unknown;
    // (undocumented)
    static ngAcceptInputType_disableRipple: unknown;
    // (undocumented)
    static ngAcceptInputType_highlighted: unknown;
    // (undocumented)
    static ngAcceptInputType_removable: unknown;
    // (undocumented)
    ngAfterContentInit(): void;
    // (undocumented)
    ngAfterViewInit(): void;
    // (undocumented)
    ngDoCheck(): void;
    // (undocumented)
    ngOnDestroy(): void;
    // (undocumented)
    ngOnInit(): void;
    // (undocumented)
    protected _ngZone: NgZone;
    readonly _onBlur: Subject<MatChipEvent>;
    readonly _onFocus: Subject<MatChipEvent>;
    primaryAction: MatChipAction;
    removable: boolean;
    remove(): void;
    readonly removed: EventEmitter<MatChipEvent>;
    removeIcon: MatChipRemove;
    role: string | null;
    trailingIcon: MatChipTrailingIcon;
    get value(): any;
    set value(value: any);
    // (undocumented)
    protected _value: any;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatChip, "mat-basic-chip, [mat-basic-chip], mat-chip, [mat-chip]", ["matChip"], { "role": { "alias": "role"; "required": false; }; "id": { "alias": "id"; "required": false; }; "ariaLabel": { "alias": "aria-label"; "required": false; }; "ariaDescription": { "alias": "aria-description"; "required": false; }; "value": { "alias": "value"; "required": false; }; "color": { "alias": "color"; "required": false; }; "removable": { "alias": "removable"; "required": false; }; "highlighted": { "alias": "highlighted"; "required": false; }; "disableRipple": { "alias": "disableRipple"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, { "removed": "removed"; "destroyed": "destroyed"; }, ["leadingIcon", "trailingIcon", "removeIcon", "_allLeadingIcons", "_allTrailingIcons", "_allRemoveIcons"], ["mat-chip-avatar, [matChipAvatar]", "*", "mat-chip-trailing-icon,[matChipRemove],[matChipTrailingIcon]"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChip, never>;
}

// @public
export class MatChipAvatar {
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatChipAvatar, "mat-chip-avatar, [matChipAvatar]", never, {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipAvatar, never>;
}

// @public
export interface MatChipEditedEvent extends MatChipEvent {
    value: string;
}

// @public
export class MatChipEditInput {
    constructor(...args: unknown[]);
    // (undocumented)
    getNativeElement(): HTMLElement;
    // (undocumented)
    getValue(): string;
    // (undocumented)
    initialize(initialValue: string): void;
    // (undocumented)
    setValue(value: string): void;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatChipEditInput, "span[matChipEditInput]", never, {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipEditInput, never>;
}

// @public
export interface MatChipEvent {
    chip: MatChip;
}

// @public
export class MatChipGrid extends MatChipSet implements AfterContentInit, AfterViewInit, ControlValueAccessor, DoCheck, MatFormFieldControl<any>, OnDestroy {
    constructor(...args: unknown[]);
    protected _allowFocusEscape(): void;
    _blur(): void;
    readonly change: EventEmitter<MatChipGridChange>;
    _change(): void;
    get chipBlurChanges(): Observable<MatChipEvent>;
    protected _chipInput: MatChipTextControl;
    // (undocumented)
    _chips: QueryList<MatChipRow>;
    readonly controlType: string;
    // (undocumented)
    protected _defaultRole: string;
    get disabled(): boolean;
    set disabled(value: boolean);
    get empty(): boolean;
    get errorState(): boolean;
    set errorState(value: boolean);
    get errorStateMatcher(): ErrorStateMatcher;
    set errorStateMatcher(value: ErrorStateMatcher);
    focus(): void;
    get focused(): boolean;
    // (undocumented)
    _focusLastChip(): void;
    _handleKeydown(event: KeyboardEvent): void;
    get id(): string;
    // (undocumented)
    static ngAcceptInputType_disabled: unknown;
    // (undocumented)
    static ngAcceptInputType_required: unknown;
    // (undocumented)
    ngAfterContentInit(): void;
    // (undocumented)
    ngAfterViewInit(): void;
    // (undocumented)
    ngControl: NgControl;
    // (undocumented)
    ngDoCheck(): void;
    // (undocumented)
    ngOnDestroy(): void;
    _onChange: (value: any) => void;
    onContainerClick(event: MouseEvent): void;
    _onTouched: () => void;
    get placeholder(): string;
    set placeholder(value: string);
    // (undocumented)
    protected _placeholder: string;
    registerInput(inputElement: MatChipTextControl): void;
    registerOnChange(fn: (value: any) => void): void;
    registerOnTouched(fn: () => void): void;
    get required(): boolean;
    set required(value: boolean);
    // (undocumented)
    protected _required: boolean | undefined;
    setDescribedByIds(ids: string[]): void;
    setDisabledState(isDisabled: boolean): void;
    get shouldLabelFloat(): boolean;
    readonly stateChanges: Subject<void>;
    updateErrorState(): void;
    get value(): any;
    set value(value: any);
    // (undocumented)
    protected _value: any[];
    readonly valueChange: EventEmitter<any>;
    writeValue(value: any): void;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatChipGrid, "mat-chip-grid", never, { "disabled": { "alias": "disabled"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "required": { "alias": "required"; "required": false; }; "value": { "alias": "value"; "required": false; }; "errorStateMatcher": { "alias": "errorStateMatcher"; "required": false; }; }, { "change": "change"; "valueChange": "valueChange"; }, ["_chips"], ["*"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipGrid, never>;
}

// @public
export class MatChipGridChange {
    constructor(
    source: MatChipGrid,
    value: any);
    source: MatChipGrid;
    value: any;
}

// @public
export class MatChipInput implements MatChipTextControl, OnChanges, OnDestroy {
    constructor(...args: unknown[]);
    addOnBlur: boolean;
    _blur(): void;
    readonly chipEnd: EventEmitter<MatChipInputEvent>;
    get chipGrid(): MatChipGrid;
    set chipGrid(value: MatChipGrid);
    // (undocumented)
    protected _chipGrid: MatChipGrid;
    clear(): void;
    get disabled(): boolean;
    set disabled(value: boolean);
    disabledInteractive: boolean;
    // (undocumented)
    protected _elementRef: ElementRef<HTMLInputElement>;
    _emitChipEnd(event?: KeyboardEvent): void;
    get empty(): boolean;
    focus(): void;
    // (undocumented)
    _focus(): void;
    focused: boolean;
    protected _getReadonlyAttribute(): string | null;
    id: string;
    readonly inputElement: HTMLInputElement;
    _keydown(event: KeyboardEvent): void;
    // (undocumented)
    static ngAcceptInputType_addOnBlur: unknown;
    // (undocumented)
    static ngAcceptInputType_disabled: unknown;
    // (undocumented)
    static ngAcceptInputType_disabledInteractive: unknown;
    // (undocumented)
    static ngAcceptInputType_readonly: unknown;
    // (undocumented)
    ngOnChanges(): void;
    // (undocumented)
    ngOnDestroy(): void;
    // (undocumented)
    _onInput(): void;
    placeholder: string;
    readonly: boolean;
    separatorKeyCodes: readonly number[] | ReadonlySet<number>;
    // (undocumented)
    setDescribedByIds(ids: string[]): void;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatChipInput, "input[matChipInputFor]", ["matChipInput", "matChipInputFor"], { "chipGrid": { "alias": "matChipInputFor"; "required": false; }; "addOnBlur": { "alias": "matChipInputAddOnBlur"; "required": false; }; "separatorKeyCodes": { "alias": "matChipInputSeparatorKeyCodes"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "id": { "alias": "id"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "disabledInteractive": { "alias": "matChipInputDisabledInteractive"; "required": false; }; }, { "chipEnd": "matChipInputTokenEnd"; }, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipInput, never>;
}

// @public
export interface MatChipInputEvent {
    chipInput: MatChipInput;
    // @deprecated
    input: HTMLInputElement;
    value: string;
}

// @public
export class MatChipListbox extends MatChipSet implements AfterContentInit, OnDestroy, ControlValueAccessor {
    ariaOrientation: 'horizontal' | 'vertical';
    _blur(): void;
    readonly change: EventEmitter<MatChipListboxChange>;
    get chipBlurChanges(): Observable<MatChipEvent>;
    // (undocumented)
    _chips: QueryList<MatChipOption>;
    get chipSelectionChanges(): Observable<MatChipSelectionChange>;
    compareWith: (o1: any, o2: any) => boolean;
    // (undocumented)
    protected _defaultRole: string;
    focus(): void;
    get hideSingleSelectionIndicator(): boolean;
    set hideSingleSelectionIndicator(value: boolean);
    // (undocumented)
    _keydown(event: KeyboardEvent): void;
    get multiple(): boolean;
    set multiple(value: boolean);
    // (undocumented)
    static ngAcceptInputType_hideSingleSelectionIndicator: unknown;
    // (undocumented)
    static ngAcceptInputType_multiple: unknown;
    // (undocumented)
    static ngAcceptInputType_required: unknown;
    // (undocumented)
    static ngAcceptInputType_selectable: unknown;
    // (undocumented)
    ngAfterContentInit(): void;
    _onChange: (value: any) => void;
    _onTouched: () => void;
    registerOnChange(fn: (value: any) => void): void;
    registerOnTouched(fn: () => void): void;
    required: boolean;
    get selectable(): boolean;
    set selectable(value: boolean);
    // (undocumented)
    protected _selectable: boolean;
    get selected(): MatChipOption[] | MatChipOption;
    setDisabledState(isDisabled: boolean): void;
    _setSelectionByValue(value: any, isUserInput?: boolean): void;
    protected _skipPredicate(action: MatChipAction): boolean;
    get value(): any;
    set value(value: any);
    // (undocumented)
    protected _value: any;
    writeValue(value: any): void;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatChipListbox, "mat-chip-listbox", never, { "multiple": { "alias": "multiple"; "required": false; }; "ariaOrientation": { "alias": "aria-orientation"; "required": false; }; "selectable": { "alias": "selectable"; "required": false; }; "compareWith": { "alias": "compareWith"; "required": false; }; "required": { "alias": "required"; "required": false; }; "hideSingleSelectionIndicator": { "alias": "hideSingleSelectionIndicator"; "required": false; }; "value": { "alias": "value"; "required": false; }; }, { "change": "change"; }, ["_chips"], ["*"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipListbox, never>;
}

// @public
export class MatChipListboxChange {
    constructor(
    source: MatChipListbox,
    value: any);
    source: MatChipListbox;
    value: any;
}

// @public
export class MatChipOption extends MatChip implements OnInit {
    get ariaSelected(): string | null;
    protected basicChipAttrName: string;
    _chipListHideSingleSelectionIndicator: boolean;
    _chipListMultiple: boolean;
    chipListSelectable: boolean;
    deselect(): void;
    // (undocumented)
    _handlePrimaryActionInteraction(): void;
    // (undocumented)
    _hasLeadingGraphic(): boolean;
    // (undocumented)
    static ngAcceptInputType_selectable: unknown;
    // (undocumented)
    static ngAcceptInputType_selected: unknown;
    // (undocumented)
    ngOnInit(): void;
    select(): void;
    get selectable(): boolean;
    set selectable(value: boolean);
    // (undocumented)
    protected _selectable: boolean;
    get selected(): boolean;
    set selected(value: boolean);
    readonly selectionChange: EventEmitter<MatChipSelectionChange>;
    selectViaInteraction(): void;
    // (undocumented)
    _setSelectedState(isSelected: boolean, isUserInput: boolean, emitEvent: boolean): void;
    toggleSelected(isUserInput?: boolean): boolean;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatChipOption, "mat-basic-chip-option, [mat-basic-chip-option], mat-chip-option, [mat-chip-option]", never, { "selectable": { "alias": "selectable"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; }, { "selectionChange": "selectionChange"; }, never, ["mat-chip-avatar, [matChipAvatar]", "*", "mat-chip-trailing-icon,[matChipRemove],[matChipTrailingIcon]"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipOption, never>;
}

// @public
export class MatChipRemove extends MatChipAction {
    // (undocumented)
    _handleClick(event: MouseEvent): void;
    // (undocumented)
    _handleKeydown(event: KeyboardEvent): void;
    // (undocumented)
    _isPrimary: boolean;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatChipRemove, "[matChipRemove]", never, {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipRemove, never>;
}

// @public
export class MatChipRow extends MatChip implements AfterViewInit {
    constructor(...args: unknown[]);
    // (undocumented)
    protected basicChipAttrName: string;
    contentEditInput?: MatChipEditInput;
    defaultEditInput?: MatChipEditInput;
    // (undocumented)
    editable: boolean;
    readonly edited: EventEmitter<MatChipEditedEvent>;
    // (undocumented)
    _handleDoubleclick(event: MouseEvent): void;
    _handleFocus(): void;
    // (undocumented)
    _handleKeydown(event: KeyboardEvent): void;
    // (undocumented)
    _hasTrailingIcon(): boolean;
    // (undocumented)
    _isEditing: boolean;
    // (undocumented)
    _isRippleDisabled(): boolean;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatChipRow, "mat-chip-row, [mat-chip-row], mat-basic-chip-row, [mat-basic-chip-row]", never, { "editable": { "alias": "editable"; "required": false; }; }, { "edited": "edited"; }, ["contentEditInput"], ["mat-chip-avatar, [matChipAvatar]", "[matChipEditInput]", "*", "mat-chip-trailing-icon,[matChipRemove],[matChipTrailingIcon]"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipRow, never>;
}

// @public
export interface MatChipsDefaultOptions {
    hideSingleSelectionIndicator?: boolean;
    inputDisabledInteractive?: boolean;
    separatorKeyCodes: readonly number[] | ReadonlySet<number>;
}

// @public
export class MatChipSelectionChange {
    constructor(
    source: MatChipOption,
    selected: boolean,
    isUserInput?: boolean);
    isUserInput: boolean;
    selected: boolean;
    source: MatChipOption;
}

// @public
export class MatChipSet implements AfterViewInit, OnDestroy {
    constructor(...args: unknown[]);
    protected _allowFocusEscape(): void;
    // (undocumented)
    protected _changeDetectorRef: ChangeDetectorRef;
    _chipActions: QueryList<MatChipAction>;
    get chipDestroyedChanges(): Observable<MatChipEvent>;
    get chipFocusChanges(): Observable<MatChipEvent>;
    get chipRemovedChanges(): Observable<MatChipEvent>;
    _chips: QueryList<MatChip>;
    protected _defaultRole: string;
    protected _destroyed: Subject<void>;
    get disabled(): boolean;
    set disabled(value: boolean);
    // (undocumented)
    protected _disabled: boolean;
    // (undocumented)
    protected _elementRef: ElementRef<HTMLElement>;
    get empty(): boolean;
    focus(): void;
    get focused(): boolean;
    protected _getChipStream<T, C extends MatChip = MatChip>(mappingFunction: (chip: C) => Observable<T>): Observable<T>;
    _handleKeydown(event: KeyboardEvent): void;
    protected _hasFocusedChip(): boolean;
    protected _isValidIndex(index: number): boolean;
    protected _keyManager: FocusKeyManager<MatChipAction>;
    // (undocumented)
    static ngAcceptInputType_disabled: unknown;
    // (undocumented)
    static ngAcceptInputType_tabIndex: unknown;
    // (undocumented)
    ngAfterViewInit(): void;
    // (undocumented)
    ngOnDestroy(): void;
    protected _originatesFromChip(event: Event): boolean;
    get role(): string | null;
    set role(value: string | null);
    protected _skipPredicate(action: MatChipAction): boolean;
    protected _syncChipsState(): void;
    tabIndex: number;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatChipSet, "mat-chip-set", never, { "disabled": { "alias": "disabled"; "required": false; }; "role": { "alias": "role"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; }, {}, ["_chips"], ["*"], true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipSet, never>;
}

// @public (undocumented)
export class MatChipsModule {
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipsModule, never>;
    // (undocumented)
    static ɵinj: i0.ɵɵInjectorDeclaration<MatChipsModule>;
    // (undocumented)
    static ɵmod: i0.ɵɵNgModuleDeclaration<MatChipsModule, never, [typeof MatCommonModule, typeof MatRippleModule, typeof MatChipAction, typeof MatChip, typeof MatChipAvatar, typeof MatChipEditInput, typeof MatChipGrid, typeof MatChipInput, typeof MatChipListbox, typeof MatChipOption, typeof MatChipRemove, typeof MatChipRow, typeof MatChipSet, typeof MatChipTrailingIcon], [typeof MatCommonModule, typeof MatChip, typeof MatChipAvatar, typeof MatChipEditInput, typeof MatChipGrid, typeof MatChipInput, typeof MatChipListbox, typeof MatChipOption, typeof MatChipRemove, typeof MatChipRow, typeof MatChipSet, typeof MatChipTrailingIcon]>;
}

// @public
export interface MatChipTextControl {
    empty: boolean;
    focus(): void;
    focused: boolean;
    id: string;
    placeholder: string;
    setDescribedByIds(ids: string[]): void;
}

// @public
export class MatChipTrailingIcon extends MatChipAction {
    isInteractive: boolean;
    // (undocumented)
    _isPrimary: boolean;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatChipTrailingIcon, "mat-chip-trailing-icon, [matChipTrailingIcon]", never, {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipTrailingIcon, never>;
}

// (No @packageDocumentation comment for this package)