Skip to content

Commit 402d14d

Browse files
authored
feat: add overlayClass property to vaadin-tooltip (#5212)
1 parent 5c2f4e7 commit 402d14d

5 files changed

Lines changed: 60 additions & 6 deletions

File tree

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
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 { OverlayClassMixin } from '@vaadin/component-base/src/overlay-class-mixin.js';
78
import { ThemePropertyMixin } from '@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js';
89

910
export type TooltipPosition =
@@ -58,7 +59,7 @@ export type TooltipPosition =
5859
*
5960
* See [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.
6061
*/
61-
declare class Tooltip extends ThemePropertyMixin(ElementMixin(HTMLElement)) {
62+
declare class Tooltip extends OverlayClassMixin(ThemePropertyMixin(ElementMixin(HTMLElement))) {
6263
/**
6364
* Sets the default focus delay to be used by all tooltip instances,
6465
* except for those that have focus delay configured using property.

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
88
import { addValueToAttribute, removeValueFromAttribute } from '@vaadin/component-base/src/dom-utils.js';
99
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
1010
import { isKeyboardActive } from '@vaadin/component-base/src/focus-utils.js';
11+
import { OverlayClassMixin } from '@vaadin/component-base/src/overlay-class-mixin.js';
1112
import { generateUniqueId } from '@vaadin/component-base/src/unique-id-utils.js';
1213
import { ThemePropertyMixin } from '@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js';
1314

@@ -231,9 +232,10 @@ class TooltipStateController {
231232
*
232233
* @extends HTMLElement
233234
* @mixes ElementMixin
235+
* @mixes OverlayClassMixin
234236
* @mixes ThemePropertyMixin
235237
*/
236-
class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
238+
class Tooltip extends OverlayClassMixin(ThemePropertyMixin(ElementMixin(PolymerElement))) {
237239
static get is() {
238240
return 'vaadin-tooltip';
239241
}
@@ -410,9 +412,6 @@ class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
410412
computed: '__computePosition(position, _position)',
411413
},
412414

413-
/** @protected */
414-
_overlayElement: Object,
415-
416415
/** @private */
417416
__isTargetHidden: {
418417
type: Boolean,

‎packages/tooltip/test/dom/__snapshots__/tooltip.test.snap.js‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,3 +170,34 @@ snapshots["vaadin-tooltip end-bottom"] =
170170
`;
171171
/* end snapshot vaadin-tooltip end-bottom */
172172

173+
snapshots["vaadin-tooltip opened overlay"] =
174+
`<vaadin-tooltip-overlay
175+
dir="ltr"
176+
hidden=""
177+
id="vaadin-tooltip-0"
178+
modeless=""
179+
no-vertical-overlap=""
180+
opened=""
181+
position="bottom"
182+
role="tooltip"
183+
>
184+
</vaadin-tooltip-overlay>
185+
`;
186+
/* end snapshot vaadin-tooltip opened overlay */
187+
188+
snapshots["vaadin-tooltip opened overlay class"] =
189+
`<vaadin-tooltip-overlay
190+
class="custom tooltip-overlay"
191+
dir="ltr"
192+
hidden=""
193+
id="vaadin-tooltip-0"
194+
modeless=""
195+
no-vertical-overlap=""
196+
opened=""
197+
position="bottom"
198+
role="tooltip"
199+
>
200+
</vaadin-tooltip-overlay>
201+
`;
202+
/* end snapshot vaadin-tooltip opened overlay class */
203+

‎packages/tooltip/test/dom/tooltip.test.js‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { expect } from '@esm-bundle/chai';
2-
import { fixtureSync } from '@vaadin/testing-helpers';
2+
import { fixtureSync, oneEvent } from '@vaadin/testing-helpers';
33
import '../../src/vaadin-tooltip.js';
44
import { resetUniqueId } from '@vaadin/component-base/src/unique-id-utils.js';
55

@@ -34,4 +34,24 @@ describe('vaadin-tooltip', () => {
3434
await expect(tooltip).shadowDom.to.equalSnapshot();
3535
});
3636
});
37+
38+
describe('opened', () => {
39+
let overlay;
40+
41+
beforeEach(async () => {
42+
overlay = tooltip.shadowRoot.querySelector('vaadin-tooltip-overlay');
43+
tooltip.manual = true;
44+
tooltip.opened = true;
45+
await oneEvent(overlay, 'vaadin-overlay-open');
46+
});
47+
48+
it('overlay', async () => {
49+
await expect(overlay).dom.to.equalSnapshot();
50+
});
51+
52+
it('overlay class', async () => {
53+
tooltip.overlayClass = 'custom tooltip-overlay';
54+
await expect(overlay).dom.to.equalSnapshot();
55+
});
56+
});
3757
});

‎packages/tooltip/test/typings/tooltip.types.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import '../../vaadin-tooltip.js';
22
import type { ElementMixinClass } from '@vaadin/component-base/src/element-mixin.js';
3+
import type { OverlayClassMixinClass } from '@vaadin/component-base/src/overlay-class-mixin.js';
34
import type { ThemePropertyMixinClass } from '@vaadin/vaadin-themable-mixin/vaadin-theme-property-mixin.js';
45
import type { TooltipPosition } from '../../vaadin-tooltip.js';
56

@@ -9,6 +10,7 @@ const tooltip = document.createElement('vaadin-tooltip');
910

1011
// Mixins
1112
assertType<ElementMixinClass>(tooltip);
13+
assertType<OverlayClassMixinClass>(tooltip);
1214
assertType<ThemePropertyMixinClass>(tooltip);
1315

1416
// Properties
@@ -23,4 +25,5 @@ assertType<number>(tooltip.focusDelay);
2325
assertType<number>(tooltip.hideDelay);
2426
assertType<number>(tooltip.hoverDelay);
2527
assertType<TooltipPosition>(tooltip.position);
28+
assertType<string>(tooltip.overlayClass);
2629
assertType<(target: HTMLElement, context?: Record<string, unknown>) => boolean>(tooltip.shouldShow);

0 commit comments

Comments
 (0)