@react-native/virtualized-lists 0.72.0 → 0.72.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,444 +0,0 @@
1
- /**
2
- * Copyright (c) Meta Platforms, Inc. and affiliates.
3
- *
4
- * This source code is licensed under the MIT license found in the
5
- * LICENSE file in the root directory of this source tree.
6
- *
7
- * @format
8
- * @oncall react_native
9
- */
10
-
11
- 'use strict';
12
-
13
- const ViewabilityHelper = require('../ViewabilityHelper');
14
-
15
- let rowFrames;
16
- let data;
17
- const props = {
18
- data,
19
- getItemCount: () => data.length,
20
- };
21
- function getFrameMetrics(index: number) {
22
- const frame = rowFrames[data[index].key];
23
- return {length: frame.height, offset: frame.y};
24
- }
25
- function createViewToken(index: number, isViewable: boolean) {
26
- return {key: data[index].key, isViewable};
27
- }
28
-
29
- describe('computeViewableItems', function () {
30
- it('returns all 4 entirely visible rows as viewable', function () {
31
- const helper = new ViewabilityHelper({
32
- viewAreaCoveragePercentThreshold: 50,
33
- });
34
- rowFrames = {
35
- a: {y: 0, height: 50},
36
- b: {y: 50, height: 50},
37
- c: {y: 100, height: 50},
38
- d: {y: 150, height: 50},
39
- };
40
- data = [{key: 'a'}, {key: 'b'}, {key: 'c'}, {key: 'd'}];
41
- expect(helper.computeViewableItems(props, 0, 200, getFrameMetrics)).toEqual(
42
- [0, 1, 2, 3],
43
- );
44
- });
45
-
46
- it('returns top 2 rows as viewable (1. entirely visible and 2. majority)', function () {
47
- const helper = new ViewabilityHelper({
48
- viewAreaCoveragePercentThreshold: 50,
49
- });
50
- rowFrames = {
51
- a: {y: 0, height: 50},
52
- b: {y: 50, height: 150},
53
- c: {y: 200, height: 50},
54
- d: {y: 250, height: 50},
55
- };
56
- data = [{key: 'a'}, {key: 'b'}, {key: 'c'}, {key: 'd'}];
57
- expect(helper.computeViewableItems(props, 0, 200, getFrameMetrics)).toEqual(
58
- [0, 1],
59
- );
60
- });
61
-
62
- it('returns only 2nd row as viewable (majority)', function () {
63
- const helper = new ViewabilityHelper({
64
- viewAreaCoveragePercentThreshold: 50,
65
- });
66
- rowFrames = {
67
- a: {y: 0, height: 50},
68
- b: {y: 50, height: 150},
69
- c: {y: 200, height: 50},
70
- d: {y: 250, height: 50},
71
- };
72
- data = [{key: 'a'}, {key: 'b'}, {key: 'c'}, {key: 'd'}];
73
- expect(
74
- helper.computeViewableItems(props, 25, 200, getFrameMetrics),
75
- ).toEqual([1]);
76
- });
77
-
78
- it('handles empty input', function () {
79
- const helper = new ViewabilityHelper({
80
- viewAreaCoveragePercentThreshold: 50,
81
- });
82
- rowFrames = {};
83
- data = [];
84
- expect(helper.computeViewableItems(props, 0, 200, getFrameMetrics)).toEqual(
85
- [],
86
- );
87
- });
88
-
89
- it('handles different view area coverage percent thresholds', function () {
90
- rowFrames = {
91
- a: {y: 0, height: 50},
92
- b: {y: 50, height: 150},
93
- c: {y: 200, height: 500},
94
- d: {y: 700, height: 50},
95
- };
96
- data = [{key: 'a'}, {key: 'b'}, {key: 'c'}, {key: 'd'}];
97
-
98
- let helper = new ViewabilityHelper({viewAreaCoveragePercentThreshold: 0});
99
- expect(helper.computeViewableItems(props, 0, 50, getFrameMetrics)).toEqual([
100
- 0,
101
- ]);
102
- expect(helper.computeViewableItems(props, 1, 50, getFrameMetrics)).toEqual([
103
- 0, 1,
104
- ]);
105
- expect(
106
- helper.computeViewableItems(props, 199, 50, getFrameMetrics),
107
- ).toEqual([1, 2]);
108
- expect(
109
- helper.computeViewableItems(props, 250, 50, getFrameMetrics),
110
- ).toEqual([2]);
111
-
112
- helper = new ViewabilityHelper({viewAreaCoveragePercentThreshold: 100});
113
- expect(helper.computeViewableItems(props, 0, 200, getFrameMetrics)).toEqual(
114
- [0, 1],
115
- );
116
- expect(helper.computeViewableItems(props, 1, 200, getFrameMetrics)).toEqual(
117
- [1],
118
- );
119
- expect(
120
- helper.computeViewableItems(props, 400, 200, getFrameMetrics),
121
- ).toEqual([2]);
122
- expect(
123
- helper.computeViewableItems(props, 600, 200, getFrameMetrics),
124
- ).toEqual([3]);
125
-
126
- helper = new ViewabilityHelper({viewAreaCoveragePercentThreshold: 10});
127
- expect(
128
- helper.computeViewableItems(props, 30, 200, getFrameMetrics),
129
- ).toEqual([0, 1, 2]);
130
- expect(
131
- helper.computeViewableItems(props, 31, 200, getFrameMetrics),
132
- ).toEqual([1, 2]);
133
- });
134
-
135
- it('handles different item visible percent thresholds', function () {
136
- rowFrames = {
137
- a: {y: 0, height: 50},
138
- b: {y: 50, height: 150},
139
- c: {y: 200, height: 50},
140
- d: {y: 250, height: 50},
141
- };
142
- data = [{key: 'a'}, {key: 'b'}, {key: 'c'}, {key: 'd'}];
143
- let helper = new ViewabilityHelper({itemVisiblePercentThreshold: 0});
144
- expect(helper.computeViewableItems(props, 0, 50, getFrameMetrics)).toEqual([
145
- 0,
146
- ]);
147
- expect(helper.computeViewableItems(props, 1, 50, getFrameMetrics)).toEqual([
148
- 0, 1,
149
- ]);
150
-
151
- helper = new ViewabilityHelper({itemVisiblePercentThreshold: 100});
152
- expect(helper.computeViewableItems(props, 0, 250, getFrameMetrics)).toEqual(
153
- [0, 1, 2],
154
- );
155
- expect(helper.computeViewableItems(props, 1, 250, getFrameMetrics)).toEqual(
156
- [1, 2],
157
- );
158
-
159
- helper = new ViewabilityHelper({itemVisiblePercentThreshold: 10});
160
- expect(
161
- helper.computeViewableItems(props, 184, 20, getFrameMetrics),
162
- ).toEqual([1]);
163
- expect(
164
- helper.computeViewableItems(props, 185, 20, getFrameMetrics),
165
- ).toEqual([1, 2]);
166
- expect(
167
- helper.computeViewableItems(props, 186, 20, getFrameMetrics),
168
- ).toEqual([2]);
169
- });
170
- });
171
-
172
- describe('onUpdate', function () {
173
- it('returns 1 visible row as viewable then scrolls away', function () {
174
- const helper = new ViewabilityHelper();
175
- rowFrames = {
176
- a: {y: 0, height: 50},
177
- };
178
- data = [{key: 'a'}];
179
- const onViewableItemsChanged = jest.fn();
180
- helper.onUpdate(
181
- props,
182
- 0,
183
- 200,
184
- getFrameMetrics,
185
- createViewToken,
186
- onViewableItemsChanged,
187
- );
188
- expect(onViewableItemsChanged.mock.calls.length).toBe(1);
189
- expect(onViewableItemsChanged.mock.calls[0][0]).toEqual({
190
- changed: [{isViewable: true, key: 'a'}],
191
- viewabilityConfig: {viewAreaCoveragePercentThreshold: 0},
192
- viewableItems: [{isViewable: true, key: 'a'}],
193
- });
194
- helper.onUpdate(
195
- props,
196
- 0,
197
- 200,
198
- getFrameMetrics,
199
- createViewToken,
200
- onViewableItemsChanged,
201
- );
202
- expect(onViewableItemsChanged.mock.calls.length).toBe(1); // nothing changed!
203
- helper.onUpdate(
204
- props,
205
- 100,
206
- 200,
207
- getFrameMetrics,
208
- createViewToken,
209
- onViewableItemsChanged,
210
- );
211
- expect(onViewableItemsChanged.mock.calls.length).toBe(2);
212
- expect(onViewableItemsChanged.mock.calls[1][0]).toEqual({
213
- changed: [{isViewable: false, key: 'a'}],
214
- viewabilityConfig: {viewAreaCoveragePercentThreshold: 0},
215
- viewableItems: [],
216
- });
217
- });
218
-
219
- it('returns 1st visible row then 1st and 2nd then just 2nd', function () {
220
- const helper = new ViewabilityHelper();
221
- rowFrames = {
222
- a: {y: 0, height: 200},
223
- b: {y: 200, height: 200},
224
- };
225
- data = [{key: 'a'}, {key: 'b'}];
226
- const onViewableItemsChanged = jest.fn();
227
- helper.onUpdate(
228
- props,
229
- 0,
230
- 200,
231
- getFrameMetrics,
232
- createViewToken,
233
- onViewableItemsChanged,
234
- );
235
- expect(onViewableItemsChanged.mock.calls.length).toBe(1);
236
- expect(onViewableItemsChanged.mock.calls[0][0]).toEqual({
237
- changed: [{isViewable: true, key: 'a'}],
238
- viewabilityConfig: {viewAreaCoveragePercentThreshold: 0},
239
- viewableItems: [{isViewable: true, key: 'a'}],
240
- });
241
- helper.onUpdate(
242
- props,
243
- 100,
244
- 200,
245
- getFrameMetrics,
246
- createViewToken,
247
- onViewableItemsChanged,
248
- );
249
- expect(onViewableItemsChanged.mock.calls.length).toBe(2);
250
- // Both visible with 100px overlap each
251
- expect(onViewableItemsChanged.mock.calls[1][0]).toEqual({
252
- changed: [{isViewable: true, key: 'b'}],
253
- viewabilityConfig: {viewAreaCoveragePercentThreshold: 0},
254
- viewableItems: [
255
- {isViewable: true, key: 'a'},
256
- {isViewable: true, key: 'b'},
257
- ],
258
- });
259
- helper.onUpdate(
260
- props,
261
- 200,
262
- 200,
263
- getFrameMetrics,
264
- createViewToken,
265
- onViewableItemsChanged,
266
- );
267
- expect(onViewableItemsChanged.mock.calls.length).toBe(3);
268
- expect(onViewableItemsChanged.mock.calls[2][0]).toEqual({
269
- changed: [{isViewable: false, key: 'a'}],
270
- viewabilityConfig: {viewAreaCoveragePercentThreshold: 0},
271
- viewableItems: [{isViewable: true, key: 'b'}],
272
- });
273
- });
274
-
275
- it('minimumViewTime delays callback', function () {
276
- const helper = new ViewabilityHelper({
277
- minimumViewTime: 350,
278
- viewAreaCoveragePercentThreshold: 0,
279
- });
280
- rowFrames = {
281
- a: {y: 0, height: 200},
282
- b: {y: 200, height: 200},
283
- };
284
- data = [{key: 'a'}, {key: 'b'}];
285
- const onViewableItemsChanged = jest.fn();
286
- helper.onUpdate(
287
- props,
288
- 0,
289
- 200,
290
- getFrameMetrics,
291
- createViewToken,
292
- onViewableItemsChanged,
293
- );
294
- expect(onViewableItemsChanged).not.toBeCalled();
295
-
296
- jest.runAllTimers();
297
-
298
- expect(onViewableItemsChanged.mock.calls.length).toBe(1);
299
- expect(onViewableItemsChanged.mock.calls[0][0]).toEqual({
300
- changed: [{isViewable: true, key: 'a'}],
301
- viewabilityConfig: {
302
- minimumViewTime: 350,
303
- viewAreaCoveragePercentThreshold: 0,
304
- },
305
- viewableItems: [{isViewable: true, key: 'a'}],
306
- });
307
- });
308
-
309
- it('minimumViewTime skips briefly visible items', function () {
310
- const helper = new ViewabilityHelper({
311
- minimumViewTime: 350,
312
- viewAreaCoveragePercentThreshold: 0,
313
- });
314
- rowFrames = {
315
- a: {y: 0, height: 250},
316
- b: {y: 250, height: 200},
317
- };
318
- data = [{key: 'a'}, {key: 'b'}];
319
- const onViewableItemsChanged = jest.fn();
320
- helper.onUpdate(
321
- props,
322
- 0,
323
- 200,
324
- getFrameMetrics,
325
- createViewToken,
326
- onViewableItemsChanged,
327
- );
328
- helper.onUpdate(
329
- props,
330
- 300, // scroll past item 'a'
331
- 200,
332
- getFrameMetrics,
333
- createViewToken,
334
- onViewableItemsChanged,
335
- );
336
-
337
- jest.runAllTimers();
338
-
339
- expect(onViewableItemsChanged.mock.calls.length).toBe(1);
340
- expect(onViewableItemsChanged.mock.calls[0][0]).toEqual({
341
- changed: [{isViewable: true, key: 'b'}],
342
- viewabilityConfig: {
343
- minimumViewTime: 350,
344
- viewAreaCoveragePercentThreshold: 0,
345
- },
346
- viewableItems: [{isViewable: true, key: 'b'}],
347
- });
348
- });
349
-
350
- it('waitForInteraction blocks callback until interaction', function () {
351
- const helper = new ViewabilityHelper({
352
- waitForInteraction: true,
353
- viewAreaCoveragePercentThreshold: 0,
354
- });
355
- rowFrames = {
356
- a: {y: 0, height: 200},
357
- b: {y: 200, height: 200},
358
- };
359
- data = [{key: 'a'}, {key: 'b'}];
360
- const onViewableItemsChanged = jest.fn();
361
- helper.onUpdate(
362
- props,
363
- 0,
364
- 100,
365
- getFrameMetrics,
366
- createViewToken,
367
- onViewableItemsChanged,
368
- );
369
- expect(onViewableItemsChanged).not.toBeCalled();
370
-
371
- helper.recordInteraction();
372
-
373
- helper.onUpdate(
374
- props,
375
- 20,
376
- 100,
377
- getFrameMetrics,
378
- createViewToken,
379
- onViewableItemsChanged,
380
- );
381
- expect(onViewableItemsChanged.mock.calls.length).toBe(1);
382
- expect(onViewableItemsChanged.mock.calls[0][0]).toEqual({
383
- changed: [{isViewable: true, key: 'a'}],
384
- viewabilityConfig: {
385
- waitForInteraction: true,
386
- viewAreaCoveragePercentThreshold: 0,
387
- },
388
- viewableItems: [{isViewable: true, key: 'a'}],
389
- });
390
- });
391
-
392
- it('returns the right visible row after the underlying data changed', function () {
393
- const helper = new ViewabilityHelper();
394
- rowFrames = {
395
- a: {y: 0, height: 200},
396
- b: {y: 200, height: 200},
397
- };
398
- data = [{key: 'a'}, {key: 'b'}];
399
- const onViewableItemsChanged = jest.fn();
400
- helper.onUpdate(
401
- props,
402
- 0,
403
- 200,
404
- getFrameMetrics,
405
- createViewToken,
406
- onViewableItemsChanged,
407
- );
408
- expect(onViewableItemsChanged.mock.calls.length).toBe(1);
409
- expect(onViewableItemsChanged.mock.calls[0][0]).toEqual({
410
- changed: [{isViewable: true, key: 'a'}],
411
- viewabilityConfig: {viewAreaCoveragePercentThreshold: 0},
412
- viewableItems: [{isViewable: true, key: 'a'}],
413
- });
414
-
415
- // update data
416
- rowFrames = {
417
- c: {y: 0, height: 200},
418
- a: {y: 200, height: 200},
419
- b: {y: 400, height: 200},
420
- };
421
- data = [{key: 'c'}, {key: 'a'}, {key: 'b'}];
422
-
423
- helper.resetViewableIndices();
424
-
425
- helper.onUpdate(
426
- props,
427
- 0,
428
- 200,
429
- getFrameMetrics,
430
- createViewToken,
431
- onViewableItemsChanged,
432
- );
433
-
434
- expect(onViewableItemsChanged.mock.calls.length).toBe(2);
435
- expect(onViewableItemsChanged.mock.calls[1][0]).toEqual({
436
- changed: [
437
- {isViewable: true, key: 'c'},
438
- {isViewable: false, key: 'a'},
439
- ],
440
- viewabilityConfig: {viewAreaCoveragePercentThreshold: 0},
441
- viewableItems: [{isViewable: true, key: 'c'}],
442
- });
443
- });
444
- });
@@ -1,108 +0,0 @@
1
- /**
2
- * Copyright (c) Meta Platforms, Inc. and affiliates.
3
- *
4
- * This source code is licensed under the MIT license found in the
5
- * LICENSE file in the root directory of this source tree.
6
- *
7
- * @format
8
- * @oncall react_native
9
- */
10
-
11
- 'use strict';
12
-
13
- import {elementsThatOverlapOffsets, newRangeCount} from '../VirtualizeUtils';
14
-
15
- describe('newRangeCount', function () {
16
- it('handles subset', function () {
17
- expect(newRangeCount({first: 1, last: 4}, {first: 2, last: 3})).toBe(0);
18
- });
19
- it('handles forward disjoint set', function () {
20
- expect(newRangeCount({first: 1, last: 4}, {first: 6, last: 9})).toBe(4);
21
- });
22
- it('handles reverse disjoint set', function () {
23
- expect(newRangeCount({first: 6, last: 8}, {first: 1, last: 4})).toBe(4);
24
- });
25
- it('handles superset', function () {
26
- expect(newRangeCount({first: 1, last: 4}, {first: 0, last: 5})).toBe(2);
27
- });
28
- it('handles end extension', function () {
29
- expect(newRangeCount({first: 1, last: 4}, {first: 1, last: 8})).toBe(4);
30
- });
31
- it('handles front extension', function () {
32
- expect(newRangeCount({first: 1, last: 4}, {first: 0, last: 4})).toBe(1);
33
- });
34
- it('handles forward intersect', function () {
35
- expect(newRangeCount({first: 1, last: 4}, {first: 3, last: 6})).toBe(2);
36
- });
37
- it('handles reverse intersect', function () {
38
- expect(newRangeCount({first: 3, last: 6}, {first: 1, last: 4})).toBe(2);
39
- });
40
- });
41
-
42
- describe('elementsThatOverlapOffsets', function () {
43
- it('handles fixed length', function () {
44
- const offsets = [0, 250, 350, 450];
45
- function getFrameMetrics(index: number) {
46
- return {
47
- length: 100,
48
- offset: 100 * index,
49
- };
50
- }
51
- expect(
52
- elementsThatOverlapOffsets(offsets, fakeProps(100), getFrameMetrics, 1),
53
- ).toEqual([0, 2, 3, 4]);
54
- });
55
- it('handles variable length', function () {
56
- const offsets = [150, 250, 900];
57
- const frames = [
58
- {offset: 0, length: 50},
59
- {offset: 50, length: 200},
60
- {offset: 250, length: 600},
61
- {offset: 850, length: 100},
62
- {offset: 950, length: 150},
63
- ];
64
- expect(
65
- elementsThatOverlapOffsets(
66
- offsets,
67
- fakeProps(frames.length),
68
- ii => frames[ii],
69
- 1,
70
- ),
71
- ).toEqual([1, 1, 3]);
72
- });
73
- it('handles frame boundaries', function () {
74
- const offsets = [0, 100, 200, 300];
75
- function getFrameMetrics(index: number) {
76
- return {
77
- length: 100,
78
- offset: 100 * index,
79
- };
80
- }
81
- expect(
82
- elementsThatOverlapOffsets(offsets, fakeProps(100), getFrameMetrics, 1),
83
- ).toEqual([0, 0, 1, 2]);
84
- });
85
- it('handles out of bounds', function () {
86
- const offsets = [-100, 150, 900];
87
- const frames = [
88
- {offset: 0, length: 50},
89
- {offset: 50, length: 150},
90
- {offset: 250, length: 100},
91
- ];
92
- expect(
93
- elementsThatOverlapOffsets(
94
- offsets,
95
- fakeProps(frames.length),
96
- ii => frames[ii],
97
- 1,
98
- ),
99
- ).toEqual([undefined, 1]);
100
- });
101
- });
102
-
103
- function fakeProps(length) {
104
- return {
105
- data: new Array(length).fill({}),
106
- getItemCount: () => length,
107
- };
108
- }