-
Notifications
You must be signed in to change notification settings - Fork 7
/
Tooltip.jsx
299 lines (251 loc) · 8.73 KB
/
Tooltip.jsx
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
/* global Modernizr */
import PropTypes from 'prop-types';
import React from 'react';
import ReactDOM from 'react-dom';
import ReactDOMServer from 'react-dom/server';
import { TimelineMax } from 'gsap/TweenMax';
import { UtilitySystem } from '../UtilitySystem';
class Tooltip extends React.Component {
isTooltipOpen = false; // We don't use React state because setState is asyncronous and we need syncronous changes here.
tooltipDelayTimeoutId = undefined; // Store setTimeout when using tooltip delay. Used in order to clearTimeout when needed.
/**
* @NOTE Attaching event listeners here is not ideal,
* but `onMouseEnter` (and `onMouseOver`) is not reliably fired;
* as well as the context of the currentTarget being incorrect.
* */
componentDidMount() {
window.addEventListener('scroll', this.closeTooltip, true);
const tooltipTrigger = this.getTooltipTrigger();
/**
* Add event listeners for tooltips triggers.
* Using Modernizr we detect whether we're dealing with a touch device
* in order to attach the correct event listener. The tooltip works with
* HOVER on non-touch devices, and CLICK on touch devices.
*
* @NOTE: We're not using native touch event sequence since touch devices will emulate a
* click event and this is the most reliable way to toggle the tooltip.
* */
if (!Modernizr.touchevents) {
tooltipTrigger.addEventListener('mouseenter', this.createTooltip);
tooltipTrigger.addEventListener('mouseleave', this.closeTooltip);
}
if (Modernizr.touchevents || Modernizr.pointerevents) {
tooltipTrigger.addEventListener('click', this.toggleTooltip);
tooltipTrigger.addEventListener('focusout', this.closeTooltip);
}
}
componentWillUnmount() {
const tooltipTrigger = this.getTooltipTrigger();
window.removeEventListener('scroll', this.closeTooltip);
// Remove event listeners from non-touch devices
if (!Modernizr.touchevents) {
tooltipTrigger.removeEventListener('mouseenter', this.createTooltip);
tooltipTrigger.removeEventListener('mouseleave', this.closeTooltip);
}
if (Modernizr.touchevents || Modernizr.pointerevents) {
tooltipTrigger.removeEventListener('click', this.toggleTooltip);
tooltipTrigger.removeEventListener('focusout', this.closeTooltip);
}
}
/**
* Get tooltip trigger
* @return {HTMLElement} DOM Node where tooltip originates
*/
getTooltipTrigger = () => {
const { tooltipTrigger } = this;
// If this a React component; get DOM reference
if (typeof this.tooltipTrigger === 'object') {
return ReactDOM.findDOMNode(this.tooltipTrigger);
}
return tooltipTrigger;
}
/**
* Create tooltip
* @param {MouseEvent} e mouse enter event
* @return {void}
*/
createTooltip = (e) => {
e.preventDefault();
if (this.tooltipId) {
return;
}
// Random ID
this.tooltipId = `tooltip-${UtilitySystem.generateUUID()}`;
const $tooltip = document.createElement('div');
const $tooltipContent = document.createElement('div');
$tooltip.setAttribute('id', this.tooltipId);
$tooltip.setAttribute('role', 'tooltip');
$tooltip.classList.add('tooltip');
// Because classList.add function do not works with multiple arguments in IE
$tooltipContent.classList.add('tooltip-inner');
$tooltipContent.classList.add(`tooltip-inner--${this.props.type}`);
const tooltipContent = this.props.content;
// If tooltip content is valid HTMl (wrapped in object), convert to HTML and inject
$tooltipContent.innerHTML = typeof tooltipContent === 'object' ? ReactDOMServer.renderToStaticMarkup(tooltipContent) : tooltipContent;
$tooltip.appendChild($tooltipContent);
// Set placement as parameter
$tooltip.placement = this.props.placement;
document.body.appendChild($tooltip);
// Attach GSAP
$tooltip.timeline = new TimelineMax({
paused: true,
onStart: () => {
this.isTooltipOpen = true;
},
onReverseComplete: () => {
this.removeTooltip($tooltip);
this.isTooltipOpen = false;
},
});
let transformOrigin;
switch ($tooltip.placement) { // eslint-disable-line default-case
case 'top':
transformOrigin = 'center bottom';
break;
case 'bottom':
transformOrigin = 'center top';
break;
case 'left':
transformOrigin = 'right center';
break;
case 'right':
transformOrigin = 'left center';
break;
}
$tooltip.timeline.set($tooltip, {
transformOrigin,
scale: 0.75,
})
.to($tooltip, 0.175, {
css: {
y: 0,
x: 0,
scale: 1,
opacity: 1,
},
ease: UtilitySystem.config.easingBounce,
});
this.styleTooltip($tooltip);
}
/**
* Figure out direction and position
* @param {HTMLElement} tooltip Div element for tooltip
* @return {void}
*/
styleTooltip = (tooltip) => {
const $tooltip = tooltip;
const tooltipTrigger = this.getTooltipTrigger();
const rect = tooltipTrigger.getBoundingClientRect();
$tooltip.classList.add(`tooltip--${$tooltip.placement}`);
// Grab dimensions of link
const linkDim = { w: rect.width, h: rect.height };
// Tooltip dimensions
const tooltipDim = { w: $tooltip.offsetWidth, h: $tooltip.offsetHeight };
const scrollYOffset = window.pageYOffset || document.documentElement.scrollTop;
const scrollXOffset = window.pageXOffset || document.documentElement.scrollLeft;
// Apply styling
switch ($tooltip.placement) { // eslint-disable-line default-case
case 'top':
$tooltip.style.top = `${(rect.top + scrollYOffset) - tooltipDim.h}px`;
$tooltip.style.left = `${(rect.left + scrollXOffset + (linkDim.w / 2)) - (tooltipDim.w / 2)}px`;
break;
case 'bottom':
$tooltip.style.top = `${(rect.top + scrollYOffset) + linkDim.h}px`;
$tooltip.style.left = `${(rect.left + scrollXOffset + (linkDim.w / 2)) - (tooltipDim.w / 2)}px`;
break;
case 'left':
$tooltip.style.top = `${(rect.top + scrollYOffset + (linkDim.h / 2)) - (tooltipDim.h / 2)}px`;
$tooltip.style.left = `${(rect.left + scrollXOffset) - tooltipDim.w}px`;
break;
case 'right':
$tooltip.style.top = `${(rect.top + scrollYOffset + (linkDim.h / 2)) - (tooltipDim.h / 2)}px`;
$tooltip.style.left = `${rect.left + scrollXOffset + linkDim.w}px`;
break;
}
this.openTooltip($tooltip);
}
/**
* Open tooltip
* @param {HTMLElement} tooltip The DOM node where tooltip originates
* @return {void}
*/
openTooltip(tooltip) {
const { delay } = this.props;
if (delay) {
// Takes care of multiple PropTypes
const delayDuration = Number.isInteger(delay) ? delay : 1000;
this.tooltipDelayTimeoutId = setTimeout(() => {
tooltip.timeline.play();
}, delayDuration);
} else {
tooltip.timeline.play();
}
}
/**
* Close tooltip
* @return {void}
*/
closeTooltip = () => {
// Cancel delayed tooltip open if user hovers out of target. On 'mouseleave'.
if (this.tooltipDelayTimeoutId) {
clearTimeout(this.tooltipDelayTimeoutId);
}
if (this.tooltipId) {
document.querySelector(`#${this.tooltipId}`).timeline.reverse();
}
this.tooltipDelayTimeoutId = undefined;
this.isTooltipOpen = false;
}
/**
* Remove tooltip from DOM
* @param {HTMLElement} tooltip DOM node where tooltip originates.
* @return {void}
*/
removeTooltip(tooltip) {
this.tooltipId = undefined;
// Using removeChild as remove function do not works in IE
tooltip.parentNode.removeChild(tooltip);
}
/**
* Open or close tooltip based on its current state.
* Used only on touch devices that rely on click events since a click could
* call for either opening or closing.
* @param {event} e
* @return {void}
*/
toggleTooltip = (e) => {
if (!this.isTooltipOpen) {
this.createTooltip(e);
} else {
this.closeTooltip(e);
}
}
renderChildren = () => {
const { children } = this.props;
const returnChild = React.cloneElement(React.Children.only(children), {
ref: (node) => {
this.tooltipTrigger = node;
},
});
return returnChild;
};
render() {
return React.Children.only(this.renderChildren());
}
}
Tooltip.propTypes = {
delay: PropTypes.oneOfType([
PropTypes.bool.isRequired,
PropTypes.number.isRequired,
]),
children: PropTypes.node.isRequired,
content: PropTypes.any.isRequired,
placement: PropTypes.oneOf(['top', 'bottom', 'left', 'right']),
type: PropTypes.oneOf(['light', 'dark']),
};
Tooltip.defaultProps = {
delay: false,
placement: 'top',
type: 'light',
};
export default Tooltip;