dialog.md

API Report File for "components-srcs"

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

import { AnimationTriggerMetadata } from '@angular/animations';
import { CdkDialogContainer } from '@angular/cdk/dialog';
import { ComponentFactoryResolver } from '@angular/core';
import { ComponentType } from '@angular/cdk/overlay';
import { DialogRef } from '@angular/cdk/dialog';
import { Direction } from '@angular/cdk/bidi';
import { ElementRef } from '@angular/core';
import { EventEmitter } from '@angular/core';
import { FocusMonitor } from '@angular/cdk/a11y';
import { FocusOrigin } from '@angular/cdk/a11y';
import { FocusTrapFactory } from '@angular/cdk/a11y';
import * as i0 from '@angular/core';
import * as i3 from '@angular/cdk/dialog';
import * as i4 from '@angular/cdk/overlay';
import * as i5 from '@angular/cdk/portal';
import * as i6 from '@angular/material/core';
import { InjectionToken } from '@angular/core';
import { Injector } from '@angular/core';
import { InteractivityChecker } from '@angular/cdk/a11y';
import { Location as Location_2 } from '@angular/common';
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 { Overlay } from '@angular/cdk/overlay';
import { OverlayContainer } from '@angular/cdk/overlay';
import { OverlayRef } from '@angular/cdk/overlay';
import { ScrollStrategy } from '@angular/cdk/overlay';
import { SimpleChanges } from '@angular/core';
import { Subject } from 'rxjs';
import { TemplateRef } from '@angular/core';
import { Type } from '@angular/core';
import { ViewContainerRef } from '@angular/core';

// @public
export type AutoFocusTarget = 'dialog' | 'first-tabbable' | 'first-heading';

// @public
export function _closeDialogVia<R>(ref: MatDialogRef<R>, interactionType: FocusOrigin, result?: R): void;

// @public
export const _defaultParams: {
    params: {
        enterAnimationDuration: string;
        exitAnimationDuration: string;
    };
};

// @public
export interface DialogPosition {
    bottom?: string;
    left?: string;
    right?: string;
    top?: string;
}

// @public
export type DialogRole = 'dialog' | 'alertdialog';

// @public
export const MAT_DIALOG_DATA: InjectionToken<any>;

// @public
export const MAT_DIALOG_DEFAULT_OPTIONS: InjectionToken<MatDialogConfig<any>>;

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

// @public
export function MAT_DIALOG_SCROLL_STRATEGY_FACTORY(overlay: Overlay): () => ScrollStrategy;

// @public
export const MAT_DIALOG_SCROLL_STRATEGY_PROVIDER: {
    provide: InjectionToken<() => ScrollStrategy>;
    deps: (typeof Overlay)[];
    useFactory: typeof MAT_DIALOG_SCROLL_STRATEGY_PROVIDER_FACTORY;
};

// @public
export function MAT_DIALOG_SCROLL_STRATEGY_PROVIDER_FACTORY(overlay: Overlay): () => ScrollStrategy;

// @public
export class MatDialog extends _MatDialogBase<MatDialogContainer> {
    constructor(overlay: Overlay, injector: Injector,
    location: Location_2, defaultOptions: MatDialogConfig, scrollStrategy: any, parentDialog: MatDialog,
    overlayContainer: OverlayContainer,
    animationMode?: 'NoopAnimations' | 'BrowserAnimations');
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatDialog, [null, null, { optional: true; }, { optional: true; }, null, { optional: true; skipSelf: true; }, null, { optional: true; }]>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<MatDialog>;
}

// @public
export class MatDialogActions {
    align?: 'start' | 'center' | 'end';
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatDialogActions, "[mat-dialog-actions], mat-dialog-actions, [matDialogActions]", never, { "align": "align"; }, {}, never, never, false>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatDialogActions, never>;
}

// @public
export const matDialogAnimations: {
    readonly dialogContainer: AnimationTriggerMetadata;
};

// @public
export abstract class _MatDialogBase<C extends _MatDialogContainerBase> implements OnDestroy {
    constructor(_overlay: Overlay, injector: Injector, _defaultOptions: MatDialogConfig | undefined, _parentDialog: _MatDialogBase<C> | undefined,
    _overlayContainer: OverlayContainer, scrollStrategy: any, _dialogRefConstructor: Type<MatDialogRef<any>>, _dialogContainerType: Type<C>, _dialogDataToken: InjectionToken<any>,
    _animationMode?: 'NoopAnimations' | 'BrowserAnimations');
    readonly afterAllClosed: Observable<void>;
    get afterOpened(): Subject<MatDialogRef<any>>;
    closeAll(): void;
    getDialogById(id: string): MatDialogRef<any> | undefined;
    // (undocumented)
    protected _idPrefix: string;
    // (undocumented)
    ngOnDestroy(): void;
    open<T, D = any, R = any>(component: ComponentType<T>, config?: MatDialogConfig<D>): MatDialogRef<T, R>;
    open<T, D = any, R = any>(template: TemplateRef<T>, config?: MatDialogConfig<D>): MatDialogRef<T, R>;
    // (undocumented)
    open<T, D = any, R = any>(template: ComponentType<T> | TemplateRef<T>, config?: MatDialogConfig<D>): MatDialogRef<T, R>;
    get openDialogs(): MatDialogRef<any>[];
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<_MatDialogBase<any>, never>;
    // (undocumented)
    static ɵprov: i0.ɵɵInjectableDeclaration<_MatDialogBase<any>>;
}

// @public
export class MatDialogClose implements OnInit, OnChanges {
    constructor(dialogRef: MatDialogRef<any>, _elementRef: ElementRef<HTMLElement>, _dialog: MatDialog);
    ariaLabel: string;
    // (undocumented)
    dialogRef: MatDialogRef<any>;
    dialogResult: any;
    // (undocumented)
    _matDialogClose: any;
    // (undocumented)
    ngOnChanges(changes: SimpleChanges): void;
    // (undocumented)
    ngOnInit(): void;
    // (undocumented)
    _onButtonClick(event: MouseEvent): void;
    type: 'submit' | 'button' | 'reset';
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatDialogClose, "[mat-dialog-close], [matDialogClose]", ["matDialogClose"], { "ariaLabel": "aria-label"; "type": "type"; "dialogResult": "mat-dialog-close"; "_matDialogClose": "matDialogClose"; }, {}, never, never, false>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatDialogClose, [{ optional: true; }, null, null]>;
}

// @public
export class MatDialogConfig<D = any> {
    ariaDescribedBy?: string | null;
    ariaLabel?: string | null;
    ariaLabelledBy?: string | null;
    autoFocus?: AutoFocusTarget | string | boolean;
    backdropClass?: string | string[];
    closeOnNavigation?: boolean;
    componentFactoryResolver?: ComponentFactoryResolver;
    data?: D | null;
    delayFocusTrap?: boolean;
    direction?: Direction;
    disableClose?: boolean;
    enterAnimationDuration?: string | number;
    exitAnimationDuration?: string | number;
    hasBackdrop?: boolean;
    height?: string;
    id?: string;
    injector?: Injector;
    maxHeight?: number | string;
    maxWidth?: number | string;
    minHeight?: number | string;
    minWidth?: number | string;
    panelClass?: string | string[];
    position?: DialogPosition;
    restoreFocus?: boolean;
    role?: DialogRole;
    scrollStrategy?: ScrollStrategy;
    viewContainerRef?: ViewContainerRef;
    width?: string;
}

// @public
export class MatDialogContainer extends _MatDialogContainerBase implements OnDestroy {
    constructor(elementRef: ElementRef, focusTrapFactory: FocusTrapFactory, document: any, dialogConfig: MatDialogConfig, checker: InteractivityChecker, ngZone: NgZone, overlayRef: OverlayRef, _animationMode?: string | undefined, focusMonitor?: FocusMonitor);
    _animationsEnabled: boolean;
    // (undocumented)
    protected _contentAttached(): void;
    // (undocumented)
    ngOnDestroy(): void;
    _startExitAnimation(): void;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<MatDialogContainer, "mat-dialog-container", never, {}, {}, never, never, false>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatDialogContainer, [null, null, { optional: true; }, null, null, null, null, { optional: true; }, null]>;
}

// @public
export abstract class _MatDialogContainerBase extends CdkDialogContainer<MatDialogConfig> {
    constructor(elementRef: ElementRef, focusTrapFactory: FocusTrapFactory, _document: any, dialogConfig: MatDialogConfig, interactivityChecker: InteractivityChecker, ngZone: NgZone, overlayRef: OverlayRef, focusMonitor?: FocusMonitor);
    _animationStateChanged: EventEmitter<LegacyDialogAnimationEvent>;
    // (undocumented)
    protected _captureInitialFocus(): void;
    protected _openAnimationDone(totalTime: number): void;
    abstract _startExitAnimation(): void;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<_MatDialogContainerBase, "ng-component", never, {}, {}, never, never, false>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<_MatDialogContainerBase, [null, null, { optional: true; }, null, null, null, null, null]>;
}

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

// @public (undocumented)
export class MatDialogModule {
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatDialogModule, never>;
    // (undocumented)
    static ɵinj: i0.ɵɵInjectorDeclaration<MatDialogModule>;
    // (undocumented)
    static ɵmod: i0.ɵɵNgModuleDeclaration<MatDialogModule, [typeof i1.MatDialogContainer, typeof i2.MatDialogClose, typeof i2.MatDialogTitle, typeof i2.MatDialogActions, typeof i2.MatDialogContent], [typeof i3.DialogModule, typeof i4.OverlayModule, typeof i5.PortalModule, typeof i6.MatCommonModule], [typeof i1.MatDialogContainer, typeof i2.MatDialogClose, typeof i2.MatDialogTitle, typeof i2.MatDialogContent, typeof i2.MatDialogActions, typeof i6.MatCommonModule]>;
}

// @public
export class MatDialogRef<T, R = any> {
    constructor(_ref: DialogRef<R, T>, config: MatDialogConfig, _containerInstance: _MatDialogContainerBase);
    addPanelClass(classes: string | string[]): this;
    afterClosed(): Observable<R | undefined>;
    afterOpened(): Observable<void>;
    backdropClick(): Observable<MouseEvent>;
    beforeClosed(): Observable<R | undefined>;
    close(dialogResult?: R): void;
    componentInstance: T;
    // (undocumented)
    _containerInstance: _MatDialogContainerBase;
    disableClose: boolean | undefined;
    getState(): MatDialogState;
    id: string;
    keydownEvents(): Observable<KeyboardEvent>;
    removePanelClass(classes: string | string[]): this;
    updatePosition(position?: DialogPosition): this;
    updateSize(width?: string, height?: string): this;
}

// @public (undocumented)
export const enum MatDialogState {
    // (undocumented)
    CLOSED = 2,
    // (undocumented)
    CLOSING = 1,
    // (undocumented)
    OPEN = 0
}

// @public
export class MatDialogTitle implements OnInit {
    constructor(_dialogRef: MatDialogRef<any>, _elementRef: ElementRef<HTMLElement>, _dialog: MatDialog);
    // (undocumented)
    id: string;
    // (undocumented)
    ngOnInit(): void;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatDialogTitle, "[mat-dialog-title], [matDialogTitle]", ["matDialogTitle"], { "id": "id"; }, {}, never, never, false>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatDialogTitle, [{ optional: true; }, null, null]>;
}

// (No @packageDocumentation comment for this package)