Skip to content

Commit 2bf6b57

Browse files
authored
fix(overlay): add prefixed inputs, deprecate old ones (#5957)
1 parent 2deed4c commit 2bf6b57

File tree

1 file changed

+78
-26
lines changed

1 file changed

+78
-26
lines changed

src/lib/core/overlay/overlay-directives.ts

Lines changed: 78 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -102,17 +102,14 @@ export class ConnectedOverlayDirective implements OnDestroy, OnChanges {
102102
private _escapeListener: Function;
103103

104104
/** Origin for the connected overlay. */
105-
@Input() origin: OverlayOrigin;
105+
@Input('cdkConnectedOverlayOrigin') origin: OverlayOrigin;
106106

107107
/** Registered connected position pairs. */
108-
@Input() positions: ConnectionPositionPair[];
108+
@Input('cdkConnectedOverlayPositions') positions: ConnectionPositionPair[];
109109

110110
/** The offset in pixels for the overlay connection point on the x-axis */
111-
@Input()
112-
get offsetX(): number {
113-
return this._offsetX;
114-
}
115-
111+
@Input('cdkConnectedOverlayOffsetX')
112+
get offsetX(): number { return this._offsetX; }
116113
set offsetX(offsetX: number) {
117114
this._offsetX = offsetX;
118115
if (this._position) {
@@ -121,11 +118,8 @@ export class ConnectedOverlayDirective implements OnDestroy, OnChanges {
121118
}
122119

123120
/** The offset in pixels for the overlay connection point on the y-axis */
124-
@Input()
125-
get offsetY() {
126-
return this._offsetY;
127-
}
128-
121+
@Input('cdkConnectedOverlayOffsetY')
122+
get offsetY() { return this._offsetY; }
129123
set offsetY(offsetY: number) {
130124
this._offsetY = offsetY;
131125
if (this._position) {
@@ -134,35 +128,93 @@ export class ConnectedOverlayDirective implements OnDestroy, OnChanges {
134128
}
135129

136130
/** The width of the overlay panel. */
137-
@Input() width: number | string;
131+
@Input('cdkConnectedOverlayWidth') width: number | string;
138132

139133
/** The height of the overlay panel. */
140-
@Input() height: number | string;
134+
@Input('cdkConnectedOverlayHeight') height: number | string;
141135

142136
/** The min width of the overlay panel. */
143-
@Input() minWidth: number | string;
137+
@Input('cdkConnectedOverlayMinWidth') minWidth: number | string;
144138

145139
/** The min height of the overlay panel. */
146-
@Input() minHeight: number | string;
140+
@Input('cdkConnectedOverlayMinHeight') minHeight: number | string;
147141

148142
/** The custom class to be set on the backdrop element. */
149-
@Input() backdropClass: string;
143+
@Input('cdkConnectedOverlayBackdropClass') backdropClass: string;
150144

151145
/** Strategy to be used when handling scroll events while the overlay is open. */
152-
@Input() scrollStrategy: ScrollStrategy = this._scrollStrategy();
146+
@Input('cdkConnectedOverlayScrollStrategy') scrollStrategy: ScrollStrategy =
147+
this._scrollStrategy();
153148

154149
/** Whether the overlay is open. */
155-
@Input() open: boolean = false;
150+
@Input('cdkConnectedOverlayOpen') open: boolean = false;
156151

157152
/** Whether or not the overlay should attach a backdrop. */
158-
@Input()
159-
get hasBackdrop() {
160-
return this._hasBackdrop;
153+
@Input('cdkConnectedOverlayHasBackdrop')
154+
get hasBackdrop() { return this._hasBackdrop; }
155+
set hasBackdrop(value: any) { this._hasBackdrop = coerceBooleanProperty(value); }
156+
157+
/** @deprecated */
158+
@Input('origin')
159+
get _deprecatedOrigin(): OverlayOrigin { return this.origin; }
160+
set _deprecatedOrigin(_origin: OverlayOrigin) { this.origin = _origin; }
161+
162+
/** @deprecated */
163+
@Input('positions')
164+
get _deprecatedPositions(): ConnectionPositionPair[] { return this.positions; }
165+
set _deprecatedPositions(_positions: ConnectionPositionPair[]) { this.positions = _positions; }
166+
167+
/** @deprecated */
168+
@Input('offsetX')
169+
get _deprecatedOffsetX(): number { return this.offsetX; }
170+
set _deprecatedOffsetX(_offsetX: number) { this.offsetX = _offsetX; }
171+
172+
/** @deprecated */
173+
@Input('offsetY')
174+
get _deprecatedOffsetY(): number { return this.offsetY; }
175+
set _deprecatedOffsetY(_offsetY: number) { this.offsetY = _offsetY; }
176+
177+
/** @deprecated */
178+
@Input('width')
179+
get _deprecatedWidth(): number | string { return this.width; }
180+
set _deprecatedWidth(_width: number | string) { this.width = _width; }
181+
182+
/** @deprecated */
183+
@Input('height')
184+
get _deprecatedHeight(): number | string { return this.height; }
185+
set _deprecatedHeight(_height: number | string) { this.height = _height; }
186+
187+
/** @deprecated */
188+
@Input('minWidth')
189+
get _deprecatedMinWidth(): number | string { return this.minWidth; }
190+
set _deprecatedMinWidth(_minWidth: number | string) { this.minWidth = _minWidth; }
191+
192+
/** @deprecated */
193+
@Input('minHeight')
194+
get _deprecatedMinHeight(): number | string { return this.minHeight; }
195+
set _deprecatedMinHeight(_minHeight: number | string) { this.minHeight = _minHeight; }
196+
197+
/** @deprecated */
198+
@Input('backdropClass')
199+
get _deprecatedBackdropClass(): string { return this.backdropClass; }
200+
set _deprecatedBackdropClass(_backdropClass: string) { this.backdropClass = _backdropClass; }
201+
202+
/** @deprecated */
203+
@Input('scrollStrategy')
204+
get _deprecatedScrollStrategy(): ScrollStrategy { return this.scrollStrategy; }
205+
set _deprecatedScrollStrategy(_scrollStrategy: ScrollStrategy) {
206+
this.scrollStrategy = _scrollStrategy;
161207
}
162208

163-
set hasBackdrop(value: any) {
164-
this._hasBackdrop = coerceBooleanProperty(value);
165-
}
209+
/** @deprecated */
210+
@Input('open')
211+
get _deprecatedOpen(): boolean { return this.open; }
212+
set _deprecatedOpen(_open: boolean) { this.open = _open; }
213+
214+
/** @deprecated */
215+
@Input('hasBackdrop')
216+
get _deprecatedHasBackdrop() { return this.hasBackdrop; }
217+
set _deprecatedHasBackdrop(_hasBackdrop: any) { this.hasBackdrop = _hasBackdrop; }
166218

167219
/** Event emitted when the backdrop is clicked. */
168220
@Output() backdropClick = new EventEmitter<void>();
@@ -203,7 +255,7 @@ export class ConnectedOverlayDirective implements OnDestroy, OnChanges {
203255
}
204256

205257
ngOnChanges(changes: SimpleChanges) {
206-
if (changes['open']) {
258+
if (changes['open'] || changes['_deprecatedOpen']) {
207259
this.open ? this._attachOverlay() : this._detachOverlay();
208260
}
209261
}

0 commit comments

Comments
 (0)