You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
88 lines
3.6 KiB
88 lines
3.6 KiB
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
import { ViewContainerRef, ComponentFactoryResolver } from '@angular/core';
|
|
import { Direction } from '@angular/cdk/bidi';
|
|
import { ScrollStrategy } from '@angular/cdk/overlay';
|
|
/** Valid ARIA roles for a dialog element. */
|
|
export declare type DialogRole = 'dialog' | 'alertdialog';
|
|
/** Possible overrides for a dialog's position. */
|
|
export interface DialogPosition {
|
|
/** Override for the dialog's top position. */
|
|
top?: string;
|
|
/** Override for the dialog's bottom position. */
|
|
bottom?: string;
|
|
/** Override for the dialog's left position. */
|
|
left?: string;
|
|
/** Override for the dialog's right position. */
|
|
right?: string;
|
|
}
|
|
/**
|
|
* Configuration for opening a modal dialog with the MatDialog service.
|
|
*/
|
|
export declare class MatDialogConfig<D = any> {
|
|
/**
|
|
* Where the attached component should live in Angular's *logical* component tree.
|
|
* This affects what is available for injection and the change detection order for the
|
|
* component instantiated inside of the dialog. This does not affect where the dialog
|
|
* content will be rendered.
|
|
*/
|
|
viewContainerRef?: ViewContainerRef;
|
|
/** ID for the dialog. If omitted, a unique one will be generated. */
|
|
id?: string;
|
|
/** The ARIA role of the dialog element. */
|
|
role?: DialogRole;
|
|
/** Custom class for the overlay pane. */
|
|
panelClass?: string | string[];
|
|
/** Whether the dialog has a backdrop. */
|
|
hasBackdrop?: boolean;
|
|
/** Custom class for the backdrop. */
|
|
backdropClass?: string | string[];
|
|
/** Whether the user can use escape or clicking on the backdrop to close the modal. */
|
|
disableClose?: boolean;
|
|
/** Width of the dialog. */
|
|
width?: string;
|
|
/** Height of the dialog. */
|
|
height?: string;
|
|
/** Min-width of the dialog. If a number is provided, assumes pixel units. */
|
|
minWidth?: number | string;
|
|
/** Min-height of the dialog. If a number is provided, assumes pixel units. */
|
|
minHeight?: number | string;
|
|
/** Max-width of the dialog. If a number is provided, assumes pixel units. Defaults to 80vw. */
|
|
maxWidth?: number | string;
|
|
/** Max-height of the dialog. If a number is provided, assumes pixel units. */
|
|
maxHeight?: number | string;
|
|
/** Position overrides. */
|
|
position?: DialogPosition;
|
|
/** Data being injected into the child component. */
|
|
data?: D | null;
|
|
/** Layout direction for the dialog's content. */
|
|
direction?: Direction;
|
|
/** ID of the element that describes the dialog. */
|
|
ariaDescribedBy?: string | null;
|
|
/** ID of the element that labels the dialog. */
|
|
ariaLabelledBy?: string | null;
|
|
/** Aria label to assign to the dialog element. */
|
|
ariaLabel?: string | null;
|
|
/** Whether the dialog should focus the first focusable element on open. */
|
|
autoFocus?: boolean;
|
|
/**
|
|
* Whether the dialog should restore focus to the
|
|
* previously-focused element, after it's closed.
|
|
*/
|
|
restoreFocus?: boolean;
|
|
/** Scroll strategy to be used for the dialog. */
|
|
scrollStrategy?: ScrollStrategy;
|
|
/**
|
|
* Whether the dialog should close when the user goes backwards/forwards in history.
|
|
* Note that this usually doesn't include clicking on links (unless the user is using
|
|
* the `HashLocationStrategy`).
|
|
*/
|
|
closeOnNavigation?: boolean;
|
|
/** Alternate `ComponentFactoryResolver` to use when resolving the associated component. */
|
|
componentFactoryResolver?: ComponentFactoryResolver;
|
|
}
|