list.md

API Report File for "components-srcs"

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

import { AfterViewInit } from '@angular/core';
import { BooleanInput } from '@angular/cdk/coercion';
import { ChangeDetectorRef } from '@angular/core';
import { ControlValueAccessor } from '@angular/forms';
import { ElementRef } from '@angular/core';
import { EventEmitter } from '@angular/core';
import * as i0 from '@angular/core';
import * as i10 from '@angular/material/core';
import * as i11 from '@angular/material/divider';
import * as i8 from '@angular/cdk/observers';
import * as i9 from '@angular/common';
import { InjectionToken } from '@angular/core';
import { NgZone } from '@angular/core';
import { OnChanges } from '@angular/core';
import { OnDestroy } from '@angular/core';
import { OnInit } from '@angular/core';
import { Platform } from '@angular/cdk/platform';
import { QueryList } from '@angular/core';
import { RippleConfig } from '@angular/material/core';
import { RippleGlobalOptions } from '@angular/material/core';
import { RippleTarget } from '@angular/material/core';
import { SelectionModel } from '@angular/cdk/collections';
import { SimpleChanges } from '@angular/core';
import { ThemePalette } from '@angular/material/core';

// @public
export const MAT_LIST: InjectionToken<MatList>;

// @public
export const MAT_NAV_LIST: InjectionToken<MatNavList>;

// @public (undocumented)
export const MAT_SELECTION_LIST_VALUE_ACCESSOR: any;

// @public (undocumented)
export class MatActionList extends MatListBase {
    // (undocumented)
    _isNonInteractive: boolean;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatActionList, "mat-action-list", ["matActionList"], {}, {}, never, ["*"], false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatActionList, never>;
}

// @public (undocumented)
export class MatList extends MatListBase {
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatList, "mat-list", ["matList"], {}, {}, never, ["*"], false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatList, never>;
}

// @public (undocumented)
export class MatListItem extends MatListItemBase {
    constructor(element: ElementRef, ngZone: NgZone, listBase: MatListBase | null, platform: Platform, globalRippleOptions?: RippleGlobalOptions, animationMode?: string);
    get activated(): boolean;
    set activated(activated: boolean);
    // (undocumented)
    _activated: boolean;
    _getAriaCurrent(): string | null;
    // (undocumented)
    _itemText: ElementRef<HTMLElement>;
    // (undocumented)
    _lines: QueryList<MatListItemLine>;
    // (undocumented)
    _meta: QueryList<MatListItemMeta>;
    // (undocumented)
    _titles: QueryList<MatListItemTitle>;
    // (undocumented)
    _unscopedContent: ElementRef<HTMLSpanElement>;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatListItem, "mat-list-item, a[mat-list-item], button[mat-list-item]", ["matListItem"], { "activated": "activated"; }, {}, ["_lines", "_titles", "_meta"], ["[matListItemAvatar],[matListItemIcon]", "[matListItemTitle]", "[matListItemLine]", "*", "[matListItemMeta]", "mat-divider"], false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatListItem, [null, null, { optional: true; }, null, { optional: true; }, { optional: true; }]>;
}

// @public
export class MatListItemAvatar extends _MatListItemGraphicBase {
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatListItemAvatar, "[matListItemAvatar]", never, {}, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatListItemAvatar, never>;
}

// @public
export class _MatListItemGraphicBase {
    constructor(_listOption: ListOption);
    // (undocumented)
    _isAlignedAtStart(): boolean;
    // (undocumented)
    _listOption: ListOption;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<_MatListItemGraphicBase, never, never, {}, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<_MatListItemGraphicBase, [{ optional: true; }]>;
}

// @public
export class MatListItemIcon extends _MatListItemGraphicBase {
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatListItemIcon, "[matListItemIcon]", never, {}, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatListItemIcon, never>;
}

// @public
export class MatListItemLine {
    constructor(_elementRef: ElementRef<HTMLElement>);
    // (undocumented)
    _elementRef: ElementRef<HTMLElement>;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatListItemLine, "[matListItemLine]", never, {}, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatListItemLine, never>;
}

// @public
export class MatListItemMeta {
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatListItemMeta, "[matListItemMeta]", never, {}, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatListItemMeta, never>;
}

// @public
export class MatListItemTitle {
    constructor(_elementRef: ElementRef<HTMLElement>);
    // (undocumented)
    _elementRef: ElementRef<HTMLElement>;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatListItemTitle, "[matListItemTitle]", never, {}, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatListItemTitle, never>;
}

// @public (undocumented)
export class MatListModule {
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatListModule, never>;
    // (undocumented)
    static ɵinj: i0.ɵɵInjectorDeclaration<MatListModule>;
    // (undocumented)
    static ɵmod: i0.ɵɵNgModuleDeclaration<MatListModule, [typeof i1.MatList, typeof i2.MatActionList, typeof i3.MatNavList, typeof i4.MatSelectionList, typeof i1.MatListItem, typeof i5.MatListOption, typeof i6.MatListSubheaderCssMatStyler, typeof i7.MatListItemAvatar, typeof i7.MatListItemIcon, typeof i7.MatListItemLine, typeof i7.MatListItemTitle, typeof i7.MatListItemMeta], [typeof i8.ObserversModule, typeof i9.CommonModule, typeof i10.MatCommonModule, typeof i10.MatRippleModule, typeof i10.MatPseudoCheckboxModule], [typeof i1.MatList, typeof i2.MatActionList, typeof i3.MatNavList, typeof i4.MatSelectionList, typeof i1.MatListItem, typeof i5.MatListOption, typeof i7.MatListItemAvatar, typeof i7.MatListItemIcon, typeof i6.MatListSubheaderCssMatStyler, typeof i11.MatDividerModule, typeof i7.MatListItemLine, typeof i7.MatListItemTitle, typeof i7.MatListItemMeta]>;
}

// @public (undocumented)
export class MatListOption extends MatListItemBase implements ListOption, OnInit, OnDestroy {
    constructor(elementRef: ElementRef<HTMLElement>, ngZone: NgZone, _selectionList: SelectionList, platform: Platform, _changeDetectorRef: ChangeDetectorRef, globalRippleOptions?: RippleGlobalOptions, animationMode?: string);
    // @deprecated
    get checkboxPosition(): MatListOptionTogglePosition;
    set checkboxPosition(value: MatListOptionTogglePosition);
    get color(): ThemePalette;
    set color(newValue: ThemePalette);
    focus(): void;
    getLabel(): string;
    _getTogglePosition(): MatListOptionTogglePosition;
    // (undocumented)
    _handleBlur(): void;
    _hasCheckboxAt(position: MatListOptionTogglePosition): boolean;
    _hasIconsOrAvatarsAt(position: 'before' | 'after'): boolean;
    _hasProjected(type: 'icons' | 'avatars', position: 'before' | 'after'): boolean;
    _hasRadioAt(position: MatListOptionTogglePosition): boolean;
    // (undocumented)
    _lines: QueryList<MatListItemLine>;
    _markForCheck(): void;
    // (undocumented)
    ngOnDestroy(): void;
    // (undocumented)
    ngOnInit(): void;
    get selected(): boolean;
    set selected(value: BooleanInput);
    readonly selectedChange: EventEmitter<boolean>;
    _setSelected(selected: boolean): boolean;
    _setTabindex(value: number): void;
    // (undocumented)
    _titles: QueryList<MatListItemTitle>;
    toggle(): void;
    _toggleOnInteraction(): void;
    togglePosition: MatListOptionTogglePosition;
    // (undocumented)
    _unscopedContent: ElementRef<HTMLSpanElement>;
    get value(): any;
    set value(newValue: any);
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatListOption, "mat-list-option", ["matListOption"], { "togglePosition": "togglePosition"; "checkboxPosition": "checkboxPosition"; "color": "color"; "value": "value"; "selected": "selected"; }, { "selectedChange": "selectedChange"; }, ["_lines", "_titles"], ["[matListItemAvatar],[matListItemIcon]", "[matListItemTitle]", "[matListItemLine]", "*", "mat-divider"], false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatListOption, [null, null, null, null, null, { optional: true; }, { optional: true; }]>;
}

// @public
type MatListOptionTogglePosition = 'before' | 'after';
export { MatListOptionTogglePosition as MatListOptionCheckboxPosition }
export { MatListOptionTogglePosition }

// @public
export class MatListSubheaderCssMatStyler {
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatListSubheaderCssMatStyler, "[mat-subheader], [matSubheader]", never, {}, {}, never, never, false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatListSubheaderCssMatStyler, never>;
}

// @public (undocumented)
export class MatNavList extends MatListBase {
    // (undocumented)
    _isNonInteractive: boolean;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatNavList, "mat-nav-list", ["matNavList"], {}, {}, never, ["*"], false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatNavList, never>;
}

// @public (undocumented)
export class MatSelectionList extends MatListBase implements SelectionList, ControlValueAccessor, AfterViewInit, OnChanges, OnDestroy {
    constructor(_element: ElementRef<HTMLElement>, _ngZone: NgZone);
    color: ThemePalette;
    compareWith: (o1: any, o2: any) => boolean;
    deselectAll(): MatListOption[];
    get disabled(): boolean;
    set disabled(value: BooleanInput);
    // (undocumented)
    _element: ElementRef<HTMLElement>;
    _emitChangeEvent(options: MatListOption[]): void;
    focus(options?: FocusOptions): void;
    _handleKeydown(event: KeyboardEvent): void;
    // (undocumented)
    _items: QueryList<MatListOption>;
    get multiple(): boolean;
    set multiple(value: BooleanInput);
    // (undocumented)
    ngAfterViewInit(): void;
    // (undocumented)
    ngOnChanges(changes: SimpleChanges): void;
    // (undocumented)
    ngOnDestroy(): void;
    _onTouched: () => void;
    get options(): QueryList<MatListOption>;
    registerOnChange(fn: (value: any) => void): void;
    registerOnTouched(fn: () => void): void;
    _reportValueChange(): void;
    selectAll(): MatListOption[];
    selectedOptions: SelectionModel<MatListOption>;
    readonly selectionChange: EventEmitter<MatSelectionListChange>;
    setDisabledState(isDisabled: boolean): void;
    _value: string[] | null;
    writeValue(values: string[]): void;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatSelectionList, "mat-selection-list", ["matSelectionList"], { "color": "color"; "compareWith": "compareWith"; "multiple": "multiple"; "disabled": "disabled"; }, { "selectionChange": "selectionChange"; }, ["_items"], ["*"], false, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatSelectionList, never>;
}

// @public
export class MatSelectionListChange {
    constructor(
    source: MatSelectionList,
    options: MatListOption[]);
    options: MatListOption[];
    source: MatSelectionList;
}

// @public
export const SELECTION_LIST: InjectionToken<SelectionList>;

// @public
export interface SelectionList extends MatListBase {
    // (undocumented)
    color: ThemePalette;
    // (undocumented)
    compareWith: (o1: any, o2: any) => boolean;
    // (undocumented)
    _emitChangeEvent(options: MatListOption[]): void;
    // (undocumented)
    multiple: boolean;
    // (undocumented)
    _onTouched(): void;
    // (undocumented)
    _reportValueChange(): void;
    // (undocumented)
    selectedOptions: SelectionModel<MatListOption>;
    // (undocumented)
    _value: string[] | null;
}

// (No @packageDocumentation comment for this package)