| 1 | /**
|
|---|
| 2 | * @license
|
|---|
| 3 | * Copyright Google LLC All Rights Reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Use of this source code is governed by an MIT-style license that can be
|
|---|
| 6 | * found in the LICENSE file at https://angular.io/license
|
|---|
| 7 | */
|
|---|
| 8 | import { PositionStrategy } from './position/position-strategy';
|
|---|
| 9 | import { Direction, Directionality } from '@angular/cdk/bidi';
|
|---|
| 10 | import { ScrollStrategy } from './scroll/index';
|
|---|
| 11 | /** Initial configuration used when creating an overlay. */
|
|---|
| 12 | export declare class OverlayConfig {
|
|---|
| 13 | /** Strategy with which to position the overlay. */
|
|---|
| 14 | positionStrategy?: PositionStrategy;
|
|---|
| 15 | /** Strategy to be used when handling scroll events while the overlay is open. */
|
|---|
| 16 | scrollStrategy?: ScrollStrategy;
|
|---|
| 17 | /** Custom class to add to the overlay pane. */
|
|---|
| 18 | panelClass?: string | string[];
|
|---|
| 19 | /** Whether the overlay has a backdrop. */
|
|---|
| 20 | hasBackdrop?: boolean;
|
|---|
| 21 | /** Custom class to add to the backdrop */
|
|---|
| 22 | backdropClass?: string | string[];
|
|---|
| 23 | /** The width of the overlay panel. If a number is provided, pixel units are assumed. */
|
|---|
| 24 | width?: number | string;
|
|---|
| 25 | /** The height of the overlay panel. If a number is provided, pixel units are assumed. */
|
|---|
| 26 | height?: number | string;
|
|---|
| 27 | /** The min-width of the overlay panel. If a number is provided, pixel units are assumed. */
|
|---|
| 28 | minWidth?: number | string;
|
|---|
| 29 | /** The min-height of the overlay panel. If a number is provided, pixel units are assumed. */
|
|---|
| 30 | minHeight?: number | string;
|
|---|
| 31 | /** The max-width of the overlay panel. If a number is provided, pixel units are assumed. */
|
|---|
| 32 | maxWidth?: number | string;
|
|---|
| 33 | /** The max-height of the overlay panel. If a number is provided, pixel units are assumed. */
|
|---|
| 34 | maxHeight?: number | string;
|
|---|
| 35 | /**
|
|---|
| 36 | * Direction of the text in the overlay panel. If a `Directionality` instance
|
|---|
| 37 | * is passed in, the overlay will handle changes to its value automatically.
|
|---|
| 38 | */
|
|---|
| 39 | direction?: Direction | Directionality;
|
|---|
| 40 | /**
|
|---|
| 41 | * Whether the overlay should be disposed of when the user goes backwards/forwards in history.
|
|---|
| 42 | * Note that this usually doesn't include clicking on links (unless the user is using
|
|---|
| 43 | * the `HashLocationStrategy`).
|
|---|
| 44 | */
|
|---|
| 45 | disposeOnNavigation?: boolean;
|
|---|
| 46 | constructor(config?: OverlayConfig);
|
|---|
| 47 | }
|
|---|
