1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/**
* @license
* Copyright (C) 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import '../gr-icons/gr-icons';
import '../gr-tooltip/gr-tooltip';
import {getRootElement} from '../../../scripts/rootElement';
import {GrTooltip} from '../gr-tooltip/gr-tooltip';
import {css, html, LitElement, PropertyValues} from 'lit';
import {customElement, property, state} from 'lit/decorators';
const BOTTOM_OFFSET = 7.2; // Height of the arrow in tooltip.
declare global {
interface HTMLElementTagNameMap {
'gr-tooltip-content': GrTooltipContent;
}
}
@customElement('gr-tooltip-content')
export class GrTooltipContent extends LitElement {
@property({type: Boolean, attribute: 'has-tooltip', reflect: true})
hasTooltip = false;
// A light tooltip will disappear immediately when the original hovered
// over content is no longer hovered over.
@property({type: Boolean, attribute: 'light-tooltip', reflect: true})
lightTooltip = false;
@property({type: Boolean, attribute: 'position-below', reflect: true})
positionBelow = false;
@property({type: String, attribute: 'max-width', reflect: true})
maxWidth?: string;
@property({type: Boolean, attribute: 'show-icon'})
showIcon = false;
// Should be private but used in tests.
@state()
isTouchDevice = 'ontouchstart' in document.documentElement;
// Should be private but used in tests.
tooltip: GrTooltip | null = null;
@state()
private originalTitle = '';
private hasSetupTooltipListeners = false;
private readonly windowScrollHandler: () => void;
private readonly showHandler: () => void;
private readonly hideHandler: (e: Event) => void;
// eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any
constructor() {
super();
this.windowScrollHandler = () => this._handleWindowScroll();
this.showHandler = () => this._handleShowTooltip();
this.hideHandler = (e: Event | undefined) => this._handleHideTooltip(e);
}
override disconnectedCallback() {
this._handleHideTooltip(undefined);
this.removeEventListener('mouseenter', this.showHandler);
window.removeEventListener('scroll', this.windowScrollHandler);
super.disconnectedCallback();
}
static override get styles() {
return [
css`
iron-icon {
width: var(--line-height-normal);
height: var(--line-height-normal);
vertical-align: top;
}
`,
];
}
override render() {
return html`
<slot></slot>
${this.renderIcon()}
`;
}
renderIcon() {
if (!this.showIcon) return;
return html`<iron-icon icon="gr-icons:info"></iron-icon>`;
}
override updated(changedProperties: PropertyValues) {
if (changedProperties.has('hasTooltip')) {
this.setupTooltipListeners();
}
}
private setupTooltipListeners() {
if (!this.hasTooltip) {
if (this.hasSetupTooltipListeners) {
// if attribute set to false, remove the listener
this.removeEventListener('mouseenter', this.showHandler);
this.hasSetupTooltipListeners = false;
}
return;
}
if (this.hasSetupTooltipListeners) {
return;
}
this.hasSetupTooltipListeners = true;
this.addEventListener('mouseenter', this.showHandler);
}
async _handleShowTooltip() {
if (this.isTouchDevice) {
return;
}
if (
!this.hasAttribute('title') ||
this.getAttribute('title') === '' ||
this.tooltip
) {
return;
}
// Store the title attribute text then set it to an empty string to
// prevent it from showing natively.
this.originalTitle = this.getAttribute('title') || '';
this.setAttribute('title', '');
const tooltip = document.createElement('gr-tooltip');
tooltip.text = this.originalTitle;
tooltip.maxWidth = this.getAttribute('max-width') || '';
tooltip.positionBelow = this.hasAttribute('position-below');
this.tooltip = tooltip;
// Set visibility to hidden before appending to the DOM so that
// calculations can be made based on the element’s size.
tooltip.style.visibility = 'hidden';
getRootElement().appendChild(tooltip);
await tooltip.updateComplete;
this._positionTooltip(tooltip);
tooltip.style.visibility = 'initial';
window.addEventListener('scroll', this.windowScrollHandler);
this.addEventListener('mouseleave', this.hideHandler);
this.addEventListener('click', this.hideHandler);
if (!this.lightTooltip) {
tooltip.addEventListener('mouseleave', this.hideHandler);
}
}
_handleHideTooltip(e?: Event) {
if (this.isTouchDevice) {
return;
}
if (!this.hasAttribute('title') || !this.originalTitle) {
return;
}
// Do not hide if mouse left this or this.tooltip and came to this or
// this.tooltip
if (
(!this.lightTooltip &&
(e as MouseEvent)?.relatedTarget === this.tooltip) ||
(e as MouseEvent)?.relatedTarget === this
) {
return;
}
window.removeEventListener('scroll', this.windowScrollHandler);
this.removeEventListener('mouseleave', this.hideHandler);
this.removeEventListener('click', this.hideHandler);
this.setAttribute('title', this.originalTitle);
if (!this.lightTooltip) {
this.tooltip?.removeEventListener('mouseleave', this.hideHandler);
}
if (this.tooltip?.parentNode) {
this.tooltip.parentNode.removeChild(this.tooltip);
}
this.tooltip = null;
}
_handleWindowScroll() {
if (!this.tooltip) {
return;
}
// This wait is needed for tooltips to be positioned correctly in Firefox
// and Safari.
this.updateComplete.then(() => this._positionTooltip(this.tooltip));
}
// private but used in tests.
_positionTooltip(tooltip: GrTooltip | null) {
if (tooltip === null) return;
const rect = this.getBoundingClientRect();
const boxRect = tooltip.getBoundingClientRect();
if (!tooltip.parentElement) {
return;
}
const parentRect = tooltip.parentElement.getBoundingClientRect();
const top = rect.top - parentRect.top;
const left = rect.left - parentRect.left + (rect.width - boxRect.width) / 2;
const right = parentRect.width - left - boxRect.width;
if (left < 0) {
tooltip.arrowCenterOffset = `${left}px`;
} else if (right < 0) {
tooltip.arrowCenterOffset = `${-0.5 * right}px`;
}
tooltip.style.left = `${Math.max(0, left)}px`;
if (!this.positionBelow) {
tooltip.style.top = `${Math.max(0, top)}px`;
tooltip.style.transform = `translateY(calc(-100% - ${BOTTOM_OFFSET}px))`;
} else {
tooltip.style.top = `${top + rect.height + BOTTOM_OFFSET}px`;
}
}
}
|
