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 { Direction, Directionality } from '@angular/cdk/bidi';
|
---|
9 | import { BooleanInput } from '@angular/cdk/coercion';
|
---|
10 | import { ElementRef, EventEmitter, InjectionToken, OnChanges, OnDestroy, SimpleChanges, TemplateRef, ViewContainerRef } from '@angular/core';
|
---|
11 | import { Overlay } from './overlay';
|
---|
12 | import { OverlayRef } from './overlay-ref';
|
---|
13 | import { ConnectedOverlayPositionChange } from './position/connected-position';
|
---|
14 | import { ConnectedPosition, FlexibleConnectedPositionStrategy } from './position/flexible-connected-position-strategy';
|
---|
15 | import { RepositionScrollStrategy, ScrollStrategy } from './scroll/index';
|
---|
16 | /** Injection token that determines the scroll handling while the connected overlay is open. */
|
---|
17 | export declare const CDK_CONNECTED_OVERLAY_SCROLL_STRATEGY: InjectionToken<() => ScrollStrategy>;
|
---|
18 | /**
|
---|
19 | * Directive applied to an element to make it usable as an origin for an Overlay using a
|
---|
20 | * ConnectedPositionStrategy.
|
---|
21 | */
|
---|
22 | export declare class CdkOverlayOrigin {
|
---|
23 | /** Reference to the element on which the directive is applied. */
|
---|
24 | elementRef: ElementRef;
|
---|
25 | constructor(
|
---|
26 | /** Reference to the element on which the directive is applied. */
|
---|
27 | elementRef: ElementRef);
|
---|
28 | }
|
---|
29 | /**
|
---|
30 | * Directive to facilitate declarative creation of an
|
---|
31 | * Overlay using a FlexibleConnectedPositionStrategy.
|
---|
32 | */
|
---|
33 | export declare class CdkConnectedOverlay implements OnDestroy, OnChanges {
|
---|
34 | private _overlay;
|
---|
35 | private _dir;
|
---|
36 | private _overlayRef;
|
---|
37 | private _templatePortal;
|
---|
38 | private _hasBackdrop;
|
---|
39 | private _lockPosition;
|
---|
40 | private _growAfterOpen;
|
---|
41 | private _flexibleDimensions;
|
---|
42 | private _push;
|
---|
43 | private _backdropSubscription;
|
---|
44 | private _attachSubscription;
|
---|
45 | private _detachSubscription;
|
---|
46 | private _positionSubscription;
|
---|
47 | private _offsetX;
|
---|
48 | private _offsetY;
|
---|
49 | private _position;
|
---|
50 | private _scrollStrategyFactory;
|
---|
51 | /** Origin for the connected overlay. */
|
---|
52 | origin: CdkOverlayOrigin;
|
---|
53 | /** Registered connected position pairs. */
|
---|
54 | positions: ConnectedPosition[];
|
---|
55 | /**
|
---|
56 | * This input overrides the positions input if specified. It lets users pass
|
---|
57 | * in arbitrary positioning strategies.
|
---|
58 | */
|
---|
59 | positionStrategy: FlexibleConnectedPositionStrategy;
|
---|
60 | /** The offset in pixels for the overlay connection point on the x-axis */
|
---|
61 | get offsetX(): number;
|
---|
62 | set offsetX(offsetX: number);
|
---|
63 | /** The offset in pixels for the overlay connection point on the y-axis */
|
---|
64 | get offsetY(): number;
|
---|
65 | set offsetY(offsetY: number);
|
---|
66 | /** The width of the overlay panel. */
|
---|
67 | width: number | string;
|
---|
68 | /** The height of the overlay panel. */
|
---|
69 | height: number | string;
|
---|
70 | /** The min width of the overlay panel. */
|
---|
71 | minWidth: number | string;
|
---|
72 | /** The min height of the overlay panel. */
|
---|
73 | minHeight: number | string;
|
---|
74 | /** The custom class to be set on the backdrop element. */
|
---|
75 | backdropClass: string;
|
---|
76 | /** The custom class to add to the overlay pane element. */
|
---|
77 | panelClass: string | string[];
|
---|
78 | /** Margin between the overlay and the viewport edges. */
|
---|
79 | viewportMargin: number;
|
---|
80 | /** Strategy to be used when handling scroll events while the overlay is open. */
|
---|
81 | scrollStrategy: ScrollStrategy;
|
---|
82 | /** Whether the overlay is open. */
|
---|
83 | open: boolean;
|
---|
84 | /** Whether the overlay can be closed by user interaction. */
|
---|
85 | disableClose: boolean;
|
---|
86 | /** CSS selector which to set the transform origin. */
|
---|
87 | transformOriginSelector: string;
|
---|
88 | /** Whether or not the overlay should attach a backdrop. */
|
---|
89 | get hasBackdrop(): any;
|
---|
90 | set hasBackdrop(value: any);
|
---|
91 | /** Whether or not the overlay should be locked when scrolling. */
|
---|
92 | get lockPosition(): any;
|
---|
93 | set lockPosition(value: any);
|
---|
94 | /** Whether the overlay's width and height can be constrained to fit within the viewport. */
|
---|
95 | get flexibleDimensions(): boolean;
|
---|
96 | set flexibleDimensions(value: boolean);
|
---|
97 | /** Whether the overlay can grow after the initial open when flexible positioning is turned on. */
|
---|
98 | get growAfterOpen(): boolean;
|
---|
99 | set growAfterOpen(value: boolean);
|
---|
100 | /** Whether the overlay can be pushed on-screen if none of the provided positions fit. */
|
---|
101 | get push(): boolean;
|
---|
102 | set push(value: boolean);
|
---|
103 | /** Event emitted when the backdrop is clicked. */
|
---|
104 | readonly backdropClick: EventEmitter<MouseEvent>;
|
---|
105 | /** Event emitted when the position has changed. */
|
---|
106 | readonly positionChange: EventEmitter<ConnectedOverlayPositionChange>;
|
---|
107 | /** Event emitted when the overlay has been attached. */
|
---|
108 | readonly attach: EventEmitter<void>;
|
---|
109 | /** Event emitted when the overlay has been detached. */
|
---|
110 | readonly detach: EventEmitter<void>;
|
---|
111 | /** Emits when there are keyboard events that are targeted at the overlay. */
|
---|
112 | readonly overlayKeydown: EventEmitter<KeyboardEvent>;
|
---|
113 | /** Emits when there are mouse outside click events that are targeted at the overlay. */
|
---|
114 | readonly overlayOutsideClick: EventEmitter<MouseEvent>;
|
---|
115 | constructor(_overlay: Overlay, templateRef: TemplateRef<any>, viewContainerRef: ViewContainerRef, scrollStrategyFactory: any, _dir: Directionality);
|
---|
116 | /** The associated overlay reference. */
|
---|
117 | get overlayRef(): OverlayRef;
|
---|
118 | /** The element's layout direction. */
|
---|
119 | get dir(): Direction;
|
---|
120 | ngOnDestroy(): void;
|
---|
121 | ngOnChanges(changes: SimpleChanges): void;
|
---|
122 | /** Creates an overlay */
|
---|
123 | private _createOverlay;
|
---|
124 | /** Builds the overlay config based on the directive's inputs */
|
---|
125 | private _buildConfig;
|
---|
126 | /** Updates the state of a position strategy, based on the values of the directive inputs. */
|
---|
127 | private _updatePositionStrategy;
|
---|
128 | /** Returns the position strategy of the overlay to be set on the overlay config */
|
---|
129 | private _createPositionStrategy;
|
---|
130 | /** Attaches the overlay and subscribes to backdrop clicks if backdrop exists */
|
---|
131 | private _attachOverlay;
|
---|
132 | /** Detaches the overlay and unsubscribes to backdrop clicks if backdrop exists */
|
---|
133 | private _detachOverlay;
|
---|
134 | static ngAcceptInputType_hasBackdrop: BooleanInput;
|
---|
135 | static ngAcceptInputType_lockPosition: BooleanInput;
|
---|
136 | static ngAcceptInputType_flexibleDimensions: BooleanInput;
|
---|
137 | static ngAcceptInputType_growAfterOpen: BooleanInput;
|
---|
138 | static ngAcceptInputType_push: BooleanInput;
|
---|
139 | }
|
---|
140 | /** @docs-private */
|
---|
141 | export declare function CDK_CONNECTED_OVERLAY_SCROLL_STRATEGY_PROVIDER_FACTORY(overlay: Overlay): () => RepositionScrollStrategy;
|
---|
142 | /** @docs-private */
|
---|
143 | export declare const CDK_CONNECTED_OVERLAY_SCROLL_STRATEGY_PROVIDER: {
|
---|
144 | provide: InjectionToken<() => ScrollStrategy>;
|
---|
145 | deps: (typeof Overlay)[];
|
---|
146 | useFactory: typeof CDK_CONNECTED_OVERLAY_SCROLL_STRATEGY_PROVIDER_FACTORY;
|
---|
147 | };
|
---|