/
tempo-tile-carousel.jsx
413 lines (368 loc) · 11.6 KB
/
tempo-tile-carousel.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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
import React, { PropTypes, Component } from "react";
import ReactDOM from "react-dom";
import classNames from "classnames";
import ExecutionEnvironment from "exenv";
import { getCarouselDecorators }
from "@walmart/wmreact-carousel/lib/components/carousel-decorators";
import FeaturedElementCarousel
from "@walmart/wmreact-carousel/lib/components/featured-element-carousel";
import CollectorContext from "@walmart/wmreact-analytics/lib/backplane/collector-context";
import fireDataEvent from "@walmart/wmreact-analytics/lib/helpers/fire-data-event";
import WaypointCollector from "@walmart/wmreact-analytics/lib/collectors/waypoint-collector";
import ModuleHeader from "./module-header";
import CarouselFirstTile from "./carousel-first-tile";
import TempoItemTile from "./tempo-item-tile";
import TempoCategoryTile from "./tempo-category-tile";
import validCategoryTile from "../../helpers/category-tile-helpers";
import {
_isTileVisible,
_setTileOptionProps,
_getItemTileHeight,
_getCategoryTileHeight,
_getSlideToShow,
HORIZONTAL_CAROUSEL_PROPS,
VERTICAL_CAROUSEL_PROPS,
PAGINATOR_STYLE
} from "../../helpers/tempo-tile-carousel-helpers";
class TempoTileCarousel extends Component {
constructor(props) {
super(props);
this.state = {
lazyLoadIndex: props.isMobile ? 6 : 8
};
this.analyticsIds = []; // track rendered products or categories for analytics
this._loadTiles = this._loadTiles.bind(this);
this._fireModuleView = this._fireModuleView.bind(this);
this._fireScrollModuleView = this._fireScrollModuleView.bind(this);
}
_renderFirstTile(
vertical,
{ firstTile, themeButton, themeButtonColor, themeTextColor },
automationId
) {
if (firstTile && !vertical) {
this.analyticsIds.push(null);
const props = {
themeButton: {
buttonTextColor: themeTextColor,
themeButtonColor,
...themeButton
},
dataAutomationId: `${automationId}-firstTile`,
...firstTile
};
return [<CarouselFirstTile key={0} {...props} />];
}
}
_renderItemTiles(props, lazyLoadIndex, automationId, tileOptionProps) { // eslint-disable-line max-params, max-len
const {
moduleData: {
configs,
configs: {
products,
maxCompareValues
}
},
userLoggedIn,
lowQuantityThreshold,
vertical,
isMobile
} = props;
const tileProps = {
userLoggedIn,
lowQuantityThreshold,
isMobile,
maxCompareValues,
...tileOptionProps
};
// reset instance variable
this.analyticsIds = [];
const tiles = this._renderFirstTile(vertical, configs, automationId) || [];
let renderedTileIndex = tiles.length;
products.forEach((product) => {
if (product.canAddToCart) {
this.analyticsIds.push(product.id.productId);
if (lazyLoadIndex !== null && renderedTileIndex >= lazyLoadIndex) {
tiles.push(null);
} else {
tiles.push(
<TempoItemTile
key={renderedTileIndex}
dataAutomationId={`${automationId}-itemTile-${renderedTileIndex}`}
productData={product}
{...tileProps}
vertical={vertical}
/>
);
}
renderedTileIndex++;
}
});
return tiles;
}
_renderCategoryTiles(props, lazyLoadIndex, automationId) {
const {
moduleData: {
configs,
configs: {
tiles: categories,
titleAlignment
}
},
vertical,
isMobile
} = props;
const tileProps = {
titleAlignment,
isMobile
};
// reset instance variable
this.analyticsIds = [];
const tiles = this._renderFirstTile(vertical, configs, automationId) || [];
let renderedTileIndex = tiles.length;
categories.forEach((category) => {
// don't render tiles with no image or link
if (validCategoryTile(category)) {
this.analyticsIds.push(category.link.uid);
if (lazyLoadIndex !== null && renderedTileIndex >= lazyLoadIndex) {
tiles.push(null);
} else {
tiles.push(
<TempoCategoryTile
key={renderedTileIndex}
dataAutomationId={`${automationId}-categoryTile-${renderedTileIndex}`}
category={category}
className={classNames({"font-semibold": vertical})}
{...tileProps}
/>
);
}
renderedTileIndex++;
}
});
return tiles;
}
// Load all tiles once user interacts with carousel
_loadTiles() {
if (this.state.lazyLoadIndex !== null) {
this.setState({ lazyLoadIndex: null });
}
}
// count number of slides that are currently visible for analytics
_getVisibleTileCount(isVertical) {
const carouselNode = ReactDOM.findDOMNode(this);
const carouselFrameNode = carouselNode.querySelector(".slider-frame");
const carouselTiles = carouselFrameNode.querySelectorAll(".slider-slide");
const frameBoundingRect = carouselFrameNode.getBoundingClientRect();
let visibleTileCount = 0;
for (let index = 0; index < carouselTiles.length; index++) {
const tileNode = carouselTiles.item(index);
if (_isTileVisible(frameBoundingRect, tileNode.getBoundingClientRect(), isVertical)) {
++visibleTileCount;
} else if (visibleTileCount) {
// after all visible tiles have been counted stop iteration
break;
}
}
return visibleTileCount;
}
// used to stub fireDataEvent in tests
_fireDataEventWrapper(data) {
return fireDataEvent(this, "module_view", data);
}
// fire analytics event with required data on page of tiles
_fireModuleView(index, isScroll) {
const { moduleData: { moduleId }, vertical } = this.props;
const visibleTileCount = this._getVisibleTileCount(vertical);
const page = Math.floor(index / visibleTileCount) + 1;
const hasFirstTile = this.analyticsIds[0] === null;
let idIndex = index;
let totalResults = this.analyticsIds.length;
// skip first tile for analytics data
if (hasFirstTile) {
if (index === 0) {
idIndex = 1;
}
totalResults--;
}
const visibleResults = this.analyticsIds.slice(idIndex, index + visibleTileCount);
const plData = {
pn: page,
or: visibleResults,
ni: visibleResults.length,
tr: totalResults
};
this._fireDataEventWrapper({ moduleId, plData, isScroll });
}
_fireScrollModuleView() {
this._fireModuleView(0, true);
}
/* eslint-disable max-statements */
render() {
const {
moduleData: {
configs: {
title,
titleColor,
themeColor,
themeImage,
seeAllLink,
seeAllLinkHexCode,
products,
tiles,
tileOptions,
titleAlignment,
maxCompareValues
},
moduleId,
type
},
dataAutomationId,
vertical,
className,
isMobile,
otherChild,
containerProps,
zoneId
} = this.props;
// Don't bother rendering if no products or categories
if ((!products || !products.length) && (!tiles || !tiles.length)) {
return null;
}
const { lazyLoadIndex } = this.state;
const wrapperProps = {
backgroundColor: themeColor,
backgroundImage: themeImage ? `url(${themeImage.src})` : null,
dataModuleId: moduleId,
dataModuleType: type,
dataAutomationId,
otherChild,
containerProps
};
const newAutomationId = `${dataAutomationId}-${type}`;
const headerProps = {
headerTitle: title,
headerTitleColor: titleColor,
themeButton: {
buttonTextColor: seeAllLinkHexCode,
...seeAllLink
},
dataAutomationId: `${newAutomationId}-header`
};
HORIZONTAL_CAROUSEL_PROPS.decorators = getCarouselDecorators({
dataAutomationId: newAutomationId,
rightBtnStyle: PAGINATOR_STYLE,
leftBtnStyle: PAGINATOR_STYLE
});
VERTICAL_CAROUSEL_PROPS.decorators = getCarouselDecorators({
dataAutomationId: newAutomationId,
vertical
});
// set initial carousel props based on device type
HORIZONTAL_CAROUSEL_PROPS.breakpoint = isMobile ? "small" : "large";
const tempoTileClass = vertical ? "TempoTileCarousel--vertical" : "TempoTileCarousel";
const tileOptionProps = products ? _setTileOptionProps(tileOptions) : null;
const tileHeight = products ? _getItemTileHeight(tileOptionProps, maxCompareValues) :
_getCategoryTileHeight(titleAlignment);
VERTICAL_CAROUSEL_PROPS.slidesToShow = _getSlideToShow(products);
const CAROUSEL_PROPS = vertical ? {...VERTICAL_CAROUSEL_PROPS} : {...HORIZONTAL_CAROUSEL_PROPS};
return (
<CollectorContext moduleId={moduleId} zoneId={zoneId}>
<WaypointCollector onEnter={this._fireScrollModuleView} fireAtBottom>
<FeaturedElementCarousel
className={classNames(className, tempoTileClass, `tile--height${tileHeight}`, {
"is-loading": !ExecutionEnvironment.canUseDOM
})}
vertical={vertical}
{...wrapperProps}
{...CAROUSEL_PROPS}
header={<ModuleHeader {...headerProps} />}
beforeSlide={this._loadTiles}
afterSlide={this._fireModuleView}>
{products ?
this._renderItemTiles(this.props, lazyLoadIndex, newAutomationId, tileOptionProps) :
this._renderCategoryTiles(this.props, lazyLoadIndex, newAutomationId)}
</FeaturedElementCarousel>
</WaypointCollector>
</CollectorContext>
);
}
/* eslint-enable max-statements*/
}
TempoTileCarousel.displayName = "TempoTileCarousel";
TempoTileCarousel.propTypes = {
/**
* Data coming from Tempo and IRO via Quimby to Apply to the Module
*/
moduleData: PropTypes.shape({
configs: PropTypes.shape({
title: PropTypes.string,
titleColor: PropTypes.string,
themeColor: PropTypes.string,
themeImage: PropTypes.object,
firstTile: PropTypes.object,
themeButton: PropTypes.object,
themeButtonColor: PropTypes.string,
themeTextColor: PropTypes.string,
seeAllLink: PropTypes.object,
seeAllLinkHexCode: PropTypes.string,
tileOptions: PropTypes.object,
products: PropTypes.array,
tiles: PropTypes.array,
titleAlignment: PropTypes.string
}).isRequired,
moduleId: PropTypes.string,
type: PropTypes.string
}).isRequired,
/**
* Whether or not user is logged in. Used in tiles for submap logic.
*/
userLoggedIn: PropTypes.bool,
/**
* Threshold at which to display the low quantity flag in item tiles.
*/
lowQuantityThreshold: PropTypes.number,
/**
* Whether or not the carousel is vertical.
*/
vertical: PropTypes.bool,
/**
* Whether or not the device has type mobile.
*/
isMobile: PropTypes.bool,
/**
* ID used to identify the component in automation tests.
*/
dataAutomationId: PropTypes.string,
/**
* Any additional classes to add for styling purposes
*/
className: PropTypes.string,
/**
* Zone ID for analytics
*/
zoneId: PropTypes.number,
/**
* Additional props to put on the container div
*/
containerProps: PropTypes.object,
/**
* Additional child of container that is not a carousel tile
*/
otherChild: PropTypes.node
};
TempoTileCarousel.defaultProps = {
userLoggedIn: false,
lowQuantityThreshold: 7,
vertical: false,
isMobile: false,
dataAutomationId: "",
className: "",
zoneId: 0,
containerProps: {},
otherChild: null
};
TempoTileCarousel.contextTypes = {
analytics: PropTypes.object
};
export default TempoTileCarousel;