| 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
300
301
302
303
304
305
306
307
308
309
310
311
312 |
15×
15×
15×
15×
15×
15×
15×
15×
15×
60×
60×
15×
15×
16×
17×
17×
21×
21×
16×
5×
1×
16×
64×
2×
6×
1×
1×
17×
20×
1×
20×
5×
20×
20×
15×
15×
15×
15×
15×
15×
15×
60×
17×
68×
2×
1×
1×
4×
2×
2×
2×
2×
2×
2×
72×
70×
2×
2×
2×
2×
2×
2×
2×
2×
2×
1×
1×
1×
3×
1×
1×
1×
1×
4×
4×
2×
2×
8×
15×
15×
60×
60×
15×
15×
15×
15×
15×
15×
15×
1×
| import TinyEmitter from 'tiny-emitter';
import debounce from 'debounce';
import Hotspot from './hotspot';
import settings from './settings';
class Hotspots extends TinyEmitter {
/**
* Component which has a draggable element in the middle which reveals one or
* the other sides as the user drags.
*
* @constructor
*/
constructor(el) {
super();
this.element = el;
this.size = this._getContainerSize();
this.hotspots = this._getHotspots();
this._noopElement = this._getFirstBodyDescendant();
this._noop = () => {};
this._activeHotspot = null;
this._bindEvents();
this.hotspots.forEach((hotspot) => {
hotspot.setA11yAttributes();
hotspot.setPosition();
});
this.element.classList.add(Hotspots.ClassName.LOADED);
this.dispatchEvent(Hotspots.EventType.INITIALIZED);
}
/**
* Scope the query to the main element.
* @param {string} className Class name of the desired elements.
* @return {Array.<Element>} An array of elements.
*/
getElementsByClass(className) {
return Array.from(this.element.querySelectorAll('.' + className));
}
/**
* In iOS, event delegation does not work for click events.
* http://www.quirksmode.org/blog/archives/2010/09/click_event_del.html
* @return {?Element} The first child of the body which is a parent of the
* main element in this class.
*/
_getFirstBodyDescendant() {
let element = this.element;
while (element) {
const parent = element.parentElement;
if (parent === document.body) {
return element;
}
element = parent;
}
return null;
}
/**
* Creates the hotspot instances.
* @return {Array.<Hotspot>}
*/
_getHotspots() {
return this.getElementsByClass(Hotspots.ClassName.HOTSPOT)
.map(element => new Hotspot(element, this));
}
/**
* Finds the hotspot instance which uses the given wrapper element.
* @param {Element} wrapper Element.
* @return {?Hotspot}
*/
_getHotspotByWrapper(wrapper) {
for (let i = 0, len = this.hotspots.length; i < len; i++) {
if (this.hotspots[i].wrapper === wrapper) {
return this.hotspots[i];
}
}
return null;
}
/**
* Retrieves the dimensions of the main element.
* @return {{width: number, height: number}}
*/
_getContainerSize() {
return {
width: this.element.offsetWidth,
height: this.element.offsetHeight,
};
}
/**
* Triggers a custom event on the main element.
* @param {string} eventName Name of event.
* @param {Hotspot} [hotspot] Optional hotspot object.
* @return {boolean} Whether preventDefault was called on the event.
*/
dispatchEvent(eventName, hotspot) {
const event = {
defaultPrevented: false,
preventDefault() {
this.defaultPrevented = true;
},
};
if (hotspot) {
event.hotspot = hotspot;
}
this.emit(eventName, event);
return event.defaultPrevented;
}
/**
* Add event listeners.
*/
_bindEvents() {
this._clickHandler = this._handleHotspotClick.bind(this);
this._resizeHandler = debounce(this._handleResize.bind(this), 200);
this._loadHandler = this._handleLoad.bind(this);
this._outerClickHandler = this._handleOuterClick.bind(this);
window.addEventListener('resize', this._resizeHandler, false);
window.addEventListener('load', this._loadHandler, false);
this.hotspots.forEach((hotspot) => {
hotspot.button.addEventListener('click', this._clickHandler, false);
});
}
/**
* Closes all open hotspots so that only one can be open at a time.
*/
closeAllHotspots() {
this.hotspots.forEach((hotspot) => {
this.closeHotspot(hotspot);
});
}
/**
* Toggles the display of a hotspot.
* @param {Hotspot} hotspot Hotspot to toggle.
*/
toggleHotspot(hotspot) {
if (hotspot.isOpen) {
this.closeHotspot(hotspot);
} else {
this.openHotspot(hotspot);
}
}
/**
* Attempts to show the hotspot. It will emit an event which, if preventDefault
* is called on, can be canceled.
* @param {Hotspot} hotspot Hotspot to open.
*/
openHotspot(hotspot) {
// If preventDefault is called on this event, do not open the hotspot.
if (hotspot.isOpen || this.dispatchEvent(Hotspots.EventType.WILL_OPEN, hotspot)) {
return;
}
this.closeAllHotspots();
hotspot.show();
this.setActiveHotspot(hotspot);
// Listen for clicks outside the hotspot which will close it.
// In a timeout so that a click on the hotspot button doesn't bubble
// up to the body and register as a click outside the hotspot.
setTimeout(() => {
this._listenForOuterClicks();
}, 0);
}
/**
* Attempts to hide the hotspot. It will emit an event which, if preventDefault
* is called on, can be canceled.
* @param {Hotspot} hotspot Hotspot to close.
*/
closeHotspot(hotspot) {
// If preventDefault is called on this event, do not close the hotspot.
if (!hotspot.isOpen || this.dispatchEvent(Hotspots.EventType.WILL_CLOSE, hotspot)) {
return;
}
hotspot.hide();
this.setActiveHotspot(null);
this._removeOuterClick();
}
/**
* Bind a click listener to the body which closes any active hotspots if the
* user clicked outside of the current hotspot. This method also adds a no-op
* event lister to the first child of the body that is a parent of this module.
* This is due to a bug in iOS where click events do not bubble properly.
* The no-op element's tap highlight color is also set to transparent because
* it would show the default color on tap because it has a click handler.
*/
_listenForOuterClicks() {
this._noopElement.addEventListener('click', this._noop, false);
this._noopElement.style.WebkitTapHighlightColor = 'transparent';
document.body.addEventListener('click', this._outerClickHandler, false);
}
/**
* Remove the delegated click listeners and tap highlight color.
*/
_removeOuterClick() {
this._noopElement.removeEventListener('click', this._noop, false);
this._noopElement.style.WebkitTapHighlightColor = '';
document.body.removeEventListener('click', this._outerClickHandler, false);
}
/**
* Listener for clicks on the button inside the hotspot and toggles the hotspot's state.
* @param {Event} evt Click event object.
*/
_handleHotspotClick(evt) {
evt.preventDefault();
const hotspot = this._getHotspotByWrapper(evt.currentTarget.parentElement);
this.toggleHotspot(hotspot);
}
/**
* When a hotspot is open, this handler is active. If the user clicks outside
* the hotspot, it will be closed.
* @param {Event} evt Click event object.
*/
_handleOuterClick(evt) {
if (!this.getActiveHotspot().content.contains(evt.target)) {
this.closeHotspot(this.getActiveHotspot());
}
}
/**
* When the window size changes, recalculate things.
*/
_handleResize() {
this.refresh();
}
/**
* Refresh when the page has finished loading. There are likely images within
* the hotspot content which may now have a width/height which affects the
* size of the hotspot content.
*/
_handleLoad() {
window.removeEventListener('load', this._loadHandler, false);
this.refresh();
}
/**
* Returns the currently open hotspot or null if none are open.
* @return {?Hotspot}
*/
getActiveHotspot() {
return this._activeHotspot;
}
/**
* Update the active hotspot property.
* @param {Hotspot} hotspot
*/
setActiveHotspot(hotspot) {
this._activeHotspot = hotspot;
}
/**
* Recalculates offsets and sizes.
*/
refresh() {
this.size = this._getContainerSize();
this.hotspots.forEach((hotspot) => {
hotspot.refresh();
});
}
/**
* Remove event listeners and DOM references.
*/
dispose() {
this.closeAllHotspots();
this.hotspots.forEach((hotspot) => {
hotspot.button.removeEventListener('click', this._clickHandler, false);
hotspot.dispose();
});
this.hotspots = null;
window.removeEventListener('load', this._loadHandler, false);
window.removeEventListener('resize', this._resizeHandler, false);
this.element.classList.remove(Hotspots.ClassName.LOADED);
this.element = null;
this._activeHotspot = null;
this._noopElement = null;
}
}
Object.assign(Hotspots, settings);
export default Hotspots;
|