Skip to content

Commit 30cb00c

Browse files
authored
refactor!: rename OverlayElement class to Overlay (#4752)
1 parent 3926c3a commit 30cb00c

19 files changed

Lines changed: 66 additions & 69 deletions

‎packages/avatar-group/src/vaadin-avatar-group-overlay.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
* Copyright (c) 2020 - 2022 Vaadin Ltd.
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
6-
import { OverlayElement } from '@vaadin/overlay/src/vaadin-overlay.js';
6+
import { Overlay } from '@vaadin/overlay/src/vaadin-overlay.js';
77
import { PositionMixin } from '@vaadin/overlay/src/vaadin-overlay-position-mixin.js';
88

99
/**
1010
* An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.
1111
*
12-
* @extends OverlayElement
12+
* @extends Overlay
1313
* @private
1414
*/
15-
class AvatarGroupOverlay extends PositionMixin(OverlayElement) {
15+
class AvatarGroupOverlay extends PositionMixin(Overlay) {
1616
static get is() {
1717
return 'vaadin-avatar-group-overlay';
1818
}

‎packages/combo-box/src/vaadin-combo-box-overlay.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* Copyright (c) 2015 - 2022 Vaadin Ltd.
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
6-
import { OverlayElement } from '@vaadin/overlay/src/vaadin-overlay.js';
6+
import { Overlay } from '@vaadin/overlay/src/vaadin-overlay.js';
77
import { PositionMixin } from '@vaadin/overlay/src/vaadin-overlay-position-mixin.js';
88
import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
99

@@ -28,10 +28,10 @@ let memoizedTemplate;
2828
/**
2929
* An element used internally by `<vaadin-combo-box>`. Not intended to be used separately.
3030
*
31-
* @extends OverlayElement
31+
* @extends Overlay
3232
* @private
3333
*/
34-
export class ComboBoxOverlay extends PositionMixin(OverlayElement) {
34+
export class ComboBoxOverlay extends PositionMixin(Overlay) {
3535
static get is() {
3636
return 'vaadin-combo-box-overlay';
3737
}

‎packages/confirm-dialog/src/vaadin-confirm-dialog-overlay.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ class ConfirmDialogOverlay extends DialogOverlay {
8282
}
8383

8484
/**
85-
* Override method inherited from `OverlayElement` to notify when overlay is closed.
85+
* Override method inherited from `Overlay` to notify when overlay is closed.
8686
* The `vaadin-overlay-close` event is not suitable, as it fires before closing.
8787
* @protected
8888
* @override

‎packages/context-menu/src/vaadin-context-menu-overlay.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* Copyright (c) 2016 - 2022 Vaadin Ltd.
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
6-
import { OverlayElement } from '@vaadin/overlay/src/vaadin-overlay.js';
6+
import { Overlay } from '@vaadin/overlay/src/vaadin-overlay.js';
77
import { PositionMixin } from '@vaadin/overlay/src/vaadin-overlay-position-mixin.js';
88
import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
99

@@ -34,10 +34,10 @@ registerStyles(
3434
/**
3535
* An element used internally by `<vaadin-context-menu>`. Not intended to be used separately.
3636
*
37-
* @extends OverlayElement
37+
* @extends Overlay
3838
* @protected
3939
*/
40-
class ContextMenuOverlay extends PositionMixin(OverlayElement) {
40+
class ContextMenuOverlay extends PositionMixin(Overlay) {
4141
static get is() {
4242
return 'vaadin-context-menu-overlay';
4343
}

‎packages/date-picker/src/vaadin-date-picker-overlay.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* Copyright (c) 2016 - 2022 Vaadin Ltd.
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
6-
import { OverlayElement } from '@vaadin/overlay/src/vaadin-overlay.js';
6+
import { Overlay } from '@vaadin/overlay/src/vaadin-overlay.js';
77
import { PositionMixin } from '@vaadin/overlay/src/vaadin-overlay-position-mixin.js';
88
import { registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
99
import { datePickerOverlayStyles } from './vaadin-date-picker-styles.js';
@@ -17,10 +17,10 @@ let memoizedTemplate;
1717
/**
1818
* An element used internally by `<vaadin-date-picker>`. Not intended to be used separately.
1919
*
20-
* @extends OverlayElement
20+
* @extends Overlay
2121
* @private
2222
*/
23-
class DatePickerOverlay extends PositionMixin(OverlayElement) {
23+
class DatePickerOverlay extends PositionMixin(Overlay) {
2424
static get is() {
2525
return 'vaadin-date-picker-overlay';
2626
}

‎packages/dialog/src/vaadin-dialog.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
66
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
7-
import { OverlayElement } from '@vaadin/overlay/src/vaadin-overlay.js';
7+
import { Overlay } from '@vaadin/overlay/src/vaadin-overlay.js';
88
import { ThemePropertyMixin } from '@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js';
99
import { DialogDraggableMixin } from './vaadin-dialog-draggable-mixin.js';
1010
import { DialogResizableMixin } from './vaadin-dialog-resizable-mixin.js';
1111

1212
/**
1313
* An element used internally by `<vaadin-dialog>`. Not intended to be used separately.
1414
*/
15-
export class DialogOverlay extends OverlayElement {}
15+
export class DialogOverlay extends Overlay {}
1616

1717
export type DialogRenderer = (root: HTMLElement, dialog?: Dialog) => void;
1818

‎packages/dialog/src/vaadin-dialog.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
77
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
88
import { processTemplates } from '@vaadin/component-base/src/templates.js';
9-
import { OverlayElement } from '@vaadin/overlay/src/vaadin-overlay.js';
9+
import { Overlay } from '@vaadin/overlay/src/vaadin-overlay.js';
1010
import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
1111
import { ThemePropertyMixin } from '@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js';
1212
import { DialogDraggableMixin } from './vaadin-dialog-draggable-mixin.js';
@@ -95,10 +95,10 @@ let memoizedTemplate;
9595
/**
9696
* An element used internally by `<vaadin-dialog>`. Not intended to be used separately.
9797
*
98-
* @extends OverlayElement
98+
* @extends Overlay
9999
* @private
100100
*/
101-
export class DialogOverlay extends OverlayElement {
101+
export class DialogOverlay extends Overlay {
102102
static get is() {
103103
return 'vaadin-dialog-overlay';
104104
}

‎packages/field-highlighter/src/vaadin-user-tags-overlay.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* Copyright (c) 2021 - 2022 Vaadin Ltd.
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
6-
import { OverlayElement } from '@vaadin/overlay/src/vaadin-overlay.js';
6+
import { Overlay } from '@vaadin/overlay/src/vaadin-overlay.js';
77
import { PositionMixin } from '@vaadin/overlay/src/vaadin-overlay-position-mixin.js';
88
import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
99

@@ -60,10 +60,10 @@ registerStyles(
6060
/**
6161
* An element used internally by `<vaadin-field-highlighter>`. Not intended to be used separately.
6262
*
63-
* @extends OverlayElement
63+
* @extends Overlay
6464
* @private
6565
*/
66-
class UserTagsOverlay extends PositionMixin(OverlayElement) {
66+
class UserTagsOverlay extends PositionMixin(Overlay) {
6767
static get is() {
6868
return 'vaadin-user-tags-overlay';
6969
}

‎packages/login/src/vaadin-login-overlay-wrapper.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
66
import { DomModule } from '@polymer/polymer/lib/elements/dom-module.js';
7-
import { OverlayElement } from '@vaadin/overlay/src/vaadin-overlay.js';
7+
import { Overlay } from '@vaadin/overlay/src/vaadin-overlay.js';
88

99
const template = document.createElement('template');
1010

@@ -59,10 +59,10 @@ let memoizedTemplate;
5959
/**
6060
* An element used internally by `<vaadin-login-overlay>`. Not intended to be used separately.
6161
*
62-
* @extends OverlayElement
62+
* @extends Overlay
6363
* @private
6464
*/
65-
class LoginOverlayWrapper extends OverlayElement {
65+
class LoginOverlayWrapper extends Overlay {
6666
static get is() {
6767
return 'vaadin-login-overlay-wrapper';
6868
}

‎packages/overlay/src/vaadin-overlay.d.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export type OverlayOutsideClickEvent = CustomEvent<{ sourceEvent: MouseEvent }>;
4242
*/
4343
export type OverlayEscapePressEvent = CustomEvent<{ sourceEvent: KeyboardEvent }>;
4444

45-
export interface OverlayElementEventMap {
45+
export interface OverlayCustomEventMap {
4646
'opened-changed': OverlayOpenedChangedEvent;
4747
'vaadin-overlay-open': OverlayOpenEvent;
4848
'vaadin-overlay-close': OverlayCloseEvent;
@@ -51,7 +51,7 @@ export interface OverlayElementEventMap {
5151
'vaadin-overlay-escape-press': OverlayEscapePressEvent;
5252
}
5353

54-
export type OverlayEventMap = HTMLElementEventMap & OverlayElementEventMap;
54+
export type OverlayEventMap = HTMLElementEventMap & OverlayCustomEventMap;
5555

5656
/**
5757
* `<vaadin-overlay>` is a Web Component for creating overlays. The content of the overlay
@@ -144,7 +144,7 @@ export type OverlayEventMap = HTMLElementEventMap & OverlayElementEventMap;
144144
* @fires {CustomEvent} vaadin-overlay-outside-click - Fired before the overlay will be closed on outside click. If canceled the closing of the overlay is canceled as well.
145145
* @fires {CustomEvent} vaadin-overlay-escape-press - Fired before the overlay will be closed on ESC button press. If canceled the closing of the overlay is canceled as well.
146146
*/
147-
declare class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(HTMLElement))) {
147+
declare class Overlay extends ThemableMixin(DirMixin(ControllerMixin(HTMLElement))) {
148148
/**
149149
* When true, the overlay is visible and attached to body.
150150
*/
@@ -231,21 +231,21 @@ declare class OverlayElement extends ThemableMixin(DirMixin(ControllerMixin(HTML
231231

232232
addEventListener<K extends keyof OverlayEventMap>(
233233
type: K,
234-
listener: (this: OverlayElement, ev: OverlayEventMap[K]) => void,
234+
listener: (this: Overlay, ev: OverlayEventMap[K]) => void,
235235
options?: AddEventListenerOptions | boolean,
236236
): void;
237237

238238
removeEventListener<K extends keyof OverlayEventMap>(
239239
type: K,
240-
listener: (this: OverlayElement, ev: OverlayEventMap[K]) => void,
240+
listener: (this: Overlay, ev: OverlayEventMap[K]) => void,
241241
options?: EventListenerOptions | boolean,
242242
): void;
243243
}
244244

245245
declare global {
246246
interface HTMLElementTagNameMap {
247-
'vaadin-overlay': OverlayElement;
247+
'vaadin-overlay': Overlay;
248248
}
249249
}
250250

251-
export { OverlayElement };
251+
export { Overlay };

0 commit comments

Comments
 (0)