react-virtuoso 2.3.1 → 2.3.5

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.
Files changed (30) hide show
  1. package/dist/Grid.d.ts +41 -38
  2. package/dist/List.d.ts +256 -52
  3. package/dist/alignToBottomSystem.d.ts +25 -1
  4. package/dist/domIOSystem.d.ts +1 -0
  5. package/dist/followOutputSystem.d.ts +15 -1
  6. package/dist/gridSystem.d.ts +31 -34
  7. package/dist/groupedListSystem.d.ts +2 -0
  8. package/dist/hooks/__mocks__/useScrollTop.d.ts +1 -1
  9. package/dist/hooks/useChangedChildSizes.d.ts +1 -1
  10. package/dist/hooks/useScrollTop.d.ts +1 -1
  11. package/dist/index.js +1 -1
  12. package/dist/index.js.map +1 -1
  13. package/dist/index.m.js +1 -1
  14. package/dist/index.m.js.map +1 -1
  15. package/dist/initialItemCountSystem.d.ts +21 -1
  16. package/dist/initialScrollTopSystem.d.ts +25 -1
  17. package/dist/initialTopMostItemIndexSystem.d.ts +4 -0
  18. package/dist/interfaces.d.ts +3 -1
  19. package/dist/listStateSystem.d.ts +19 -1
  20. package/dist/listSystem.d.ts +238 -44
  21. package/dist/scrollIntoViewSystem.d.ts +25 -1
  22. package/dist/scrollSeekSystem.d.ts +52 -69
  23. package/dist/scrollToIndexSystem.d.ts +2 -0
  24. package/dist/sizeRangeSystem.d.ts +2 -0
  25. package/dist/stateFlagsSystem.d.ts +10 -2
  26. package/dist/topItemCountSystem.d.ts +21 -1
  27. package/dist/totalListHeightSystem.d.ts +23 -1
  28. package/dist/upwardScrollFixSystem.d.ts +31 -3
  29. package/dist/windowScrollerSystem.d.ts +4 -2
  30. package/package.json +5 -4
package/dist/Grid.d.ts CHANGED
@@ -27,6 +27,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
27
27
  endReached?: ((value: number) => void) | undefined;
28
28
  rangeChanged?: ((value: import("./interfaces").ListRange) => void) | undefined;
29
29
  } & GridRootProps & React.RefAttributes<import("@virtuoso.dev/react-urx").MethodsFromPropMap<u.SystemSpec<[u.SystemSpec<[u.SystemSpec<[u.SystemSpec<never[], () => {
30
+ scrollContainerState: u.Stream<[number, number]>;
30
31
  scrollTop: u.Stream<number>;
31
32
  viewportHeight: u.Stream<number>;
32
33
  headerHeight: u.StatefulStream<number>;
@@ -39,6 +40,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
39
40
  deviation: u.StatefulStream<number>;
40
41
  scrollingInProgress: u.StatefulStream<boolean>;
41
42
  }>], ([{ scrollTop, viewportHeight, deviation, headerHeight }]: [{
43
+ scrollContainerState: u.Stream<[number, number]>;
42
44
  scrollTop: u.Stream<number>;
43
45
  viewportHeight: u.Stream<number>;
44
46
  headerHeight: u.StatefulStream<number>;
@@ -57,6 +59,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
57
59
  increaseViewportBy: u.StatefulStream<import("./sizeRangeSystem").ViewportIncrease>;
58
60
  visibleRange: u.StatefulStream<import("./sizeRangeSystem").NumberTuple>;
59
61
  }>, u.SystemSpec<never[], () => {
62
+ scrollContainerState: u.Stream<[number, number]>;
60
63
  scrollTop: u.Stream<number>;
61
64
  viewportHeight: u.Stream<number>;
62
65
  headerHeight: u.StatefulStream<number>;
@@ -69,6 +72,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
69
72
  deviation: u.StatefulStream<number>;
70
73
  scrollingInProgress: u.StatefulStream<boolean>;
71
74
  }>, u.SystemSpec<[u.SystemSpec<never[], () => {
75
+ scrollContainerState: u.Stream<[number, number]>;
72
76
  scrollTop: u.Stream<number>;
73
77
  viewportHeight: u.Stream<number>;
74
78
  headerHeight: u.StatefulStream<number>;
@@ -80,7 +84,8 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
80
84
  statefulScrollTop: u.StatefulStream<number>;
81
85
  deviation: u.StatefulStream<number>;
82
86
  scrollingInProgress: u.StatefulStream<boolean>;
83
- }>], ([{ scrollTop, viewportHeight, headerHeight, footerHeight, scrollHeight }]: [{
87
+ }>], ([{ scrollContainerState, scrollTop, viewportHeight, headerHeight, footerHeight, scrollBy }]: [{
88
+ scrollContainerState: u.Stream<[number, number]>;
84
89
  scrollTop: u.Stream<number>;
85
90
  viewportHeight: u.Stream<number>;
86
91
  headerHeight: u.StatefulStream<number>;
@@ -101,19 +106,10 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
101
106
  atBottomStateChange: u.Stream<boolean>;
102
107
  scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
103
108
  atBottomThreshold: u.StatefulStream<number>;
104
- }>, u.SystemSpec<[u.SystemSpec<never[], () => {
105
- scrollTop: u.Stream<number>;
106
- viewportHeight: u.Stream<number>;
107
- headerHeight: u.StatefulStream<number>;
108
- footerHeight: u.StatefulStream<number>;
109
- scrollHeight: u.Stream<number>;
110
- smoothScrollTargetReached: u.Stream<true>;
111
- scrollTo: u.Stream<ScrollToOptions>;
112
- scrollBy: u.Stream<ScrollToOptions>;
113
- statefulScrollTop: u.StatefulStream<number>;
114
- deviation: u.StatefulStream<number>;
115
- scrollingInProgress: u.StatefulStream<boolean>;
116
- }>, u.SystemSpec<[u.SystemSpec<never[], () => {
109
+ scrollVelocity: u.StatefulStream<number>;
110
+ lastJumpDueToItemResize: u.StatefulStream<number>;
111
+ }>, u.SystemSpec<[u.SystemSpec<[u.SystemSpec<never[], () => {
112
+ scrollContainerState: u.Stream<[number, number]>;
117
113
  scrollTop: u.Stream<number>;
118
114
  viewportHeight: u.Stream<number>;
119
115
  headerHeight: u.StatefulStream<number>;
@@ -125,7 +121,8 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
125
121
  statefulScrollTop: u.StatefulStream<number>;
126
122
  deviation: u.StatefulStream<number>;
127
123
  scrollingInProgress: u.StatefulStream<boolean>;
128
- }>], ([{ scrollTop, viewportHeight, headerHeight, footerHeight, scrollHeight }]: [{
124
+ }>], ([{ scrollContainerState, scrollTop, viewportHeight, headerHeight, footerHeight, scrollBy }]: [{
125
+ scrollContainerState: u.Stream<[number, number]>;
129
126
  scrollTop: u.Stream<number>;
130
127
  viewportHeight: u.Stream<number>;
131
128
  headerHeight: u.StatefulStream<number>;
@@ -146,19 +143,9 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
146
143
  atBottomStateChange: u.Stream<boolean>;
147
144
  scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
148
145
  atBottomThreshold: u.StatefulStream<number>;
149
- }>], ([{ scrollTop }, { isScrolling }]: [{
150
- scrollTop: u.Stream<number>;
151
- viewportHeight: u.Stream<number>;
152
- headerHeight: u.StatefulStream<number>;
153
- footerHeight: u.StatefulStream<number>;
154
- scrollHeight: u.Stream<number>;
155
- smoothScrollTargetReached: u.Stream<true>;
156
- scrollTo: u.Stream<ScrollToOptions>;
157
- scrollBy: u.Stream<ScrollToOptions>;
158
- statefulScrollTop: u.StatefulStream<number>;
159
- deviation: u.StatefulStream<number>;
160
- scrollingInProgress: u.StatefulStream<boolean>;
161
- }, {
146
+ scrollVelocity: u.StatefulStream<number>;
147
+ lastJumpDueToItemResize: u.StatefulStream<number>;
148
+ }>], ([{ scrollVelocity }]: [{
162
149
  isScrolling: u.Stream<boolean>;
163
150
  isAtTop: u.StatefulStream<boolean>;
164
151
  isAtBottom: u.StatefulStream<boolean>;
@@ -167,6 +154,8 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
167
154
  atBottomStateChange: u.Stream<boolean>;
168
155
  scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
169
156
  atBottomThreshold: u.StatefulStream<number>;
157
+ scrollVelocity: u.StatefulStream<number>;
158
+ lastJumpDueToItemResize: u.StatefulStream<number>;
170
159
  }]) => {
171
160
  isSeeking: u.StatefulStream<boolean>;
172
161
  scrollSeekConfiguration: u.StatefulStream<false | import("./interfaces").ScrollSeekConfiguration | undefined>;
@@ -182,6 +171,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
182
171
  propsReady: u.StatefulStream<boolean>;
183
172
  didMount: u.Stream<boolean>;
184
173
  }>, u.SystemSpec<[u.SystemSpec<never[], () => {
174
+ scrollContainerState: u.Stream<[number, number]>;
185
175
  scrollTop: u.Stream<number>;
186
176
  viewportHeight: u.Stream<number>;
187
177
  headerHeight: u.StatefulStream<number>;
@@ -193,7 +183,8 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
193
183
  statefulScrollTop: u.StatefulStream<number>;
194
184
  deviation: u.StatefulStream<number>;
195
185
  scrollingInProgress: u.StatefulStream<boolean>;
196
- }>], ([{ scrollTop, scrollTo }]: [{
186
+ }>], ([{ scrollTo, scrollContainerState }]: [{
187
+ scrollContainerState: u.Stream<[number, number]>;
197
188
  scrollTop: u.Stream<number>;
198
189
  viewportHeight: u.Stream<number>;
199
190
  headerHeight: u.StatefulStream<number>;
@@ -207,16 +198,17 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
207
198
  scrollingInProgress: u.StatefulStream<boolean>;
208
199
  }]) => {
209
200
  useWindowScroll: u.StatefulStream<boolean>;
210
- windowScrollTop: u.Stream<number>;
201
+ windowScrollContainerState: u.Stream<[number, number]>;
211
202
  windowViewportRect: u.Stream<import("./interfaces").WindowViewportInfo>;
212
203
  windowScrollTo: u.Stream<ScrollToOptions>;
213
- }>], ([{ overscan, visibleRange, listBoundary }, { scrollTop, viewportHeight, scrollBy, scrollTo, smoothScrollTargetReached }, stateFlags, scrollSeek, { propsReady, didMount }, { windowViewportRect, windowScrollTo, useWindowScroll, windowScrollTop },]: [{
204
+ }>], ([{ overscan, visibleRange, listBoundary }, { scrollTop, viewportHeight, scrollBy, scrollTo, smoothScrollTargetReached, scrollContainerState }, stateFlags, scrollSeek, { propsReady, didMount }, { windowViewportRect, windowScrollTo, useWindowScroll, windowScrollContainerState },]: [{
214
205
  listBoundary: u.Stream<import("./sizeRangeSystem").NumberTuple>;
215
206
  overscan: u.StatefulStream<import("./sizeRangeSystem").Overscan>;
216
207
  topListHeight: u.StatefulStream<number>;
217
208
  increaseViewportBy: u.StatefulStream<import("./sizeRangeSystem").ViewportIncrease>;
218
209
  visibleRange: u.StatefulStream<import("./sizeRangeSystem").NumberTuple>;
219
210
  }, {
211
+ scrollContainerState: u.Stream<[number, number]>;
220
212
  scrollTop: u.Stream<number>;
221
213
  viewportHeight: u.Stream<number>;
222
214
  headerHeight: u.StatefulStream<number>;
@@ -237,6 +229,8 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
237
229
  atBottomStateChange: u.Stream<boolean>;
238
230
  scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
239
231
  atBottomThreshold: u.StatefulStream<number>;
232
+ scrollVelocity: u.StatefulStream<number>;
233
+ lastJumpDueToItemResize: u.StatefulStream<number>;
240
234
  }, {
241
235
  isSeeking: u.StatefulStream<boolean>;
242
236
  scrollSeekConfiguration: u.StatefulStream<false | import("./interfaces").ScrollSeekConfiguration | undefined>;
@@ -247,7 +241,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
247
241
  didMount: u.Stream<boolean>;
248
242
  }, {
249
243
  useWindowScroll: u.StatefulStream<boolean>;
250
- windowScrollTop: u.Stream<number>;
244
+ windowScrollContainerState: u.Stream<[number, number]>;
251
245
  windowViewportRect: u.Stream<import("./interfaces").WindowViewportInfo>;
252
246
  windowScrollTo: u.Stream<ScrollToOptions>;
253
247
  }]) => {
@@ -263,11 +257,12 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
263
257
  atBottomStateChange: u.Stream<boolean>;
264
258
  scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
265
259
  atBottomThreshold: u.StatefulStream<number>;
260
+ scrollVelocity: u.StatefulStream<number>;
261
+ lastJumpDueToItemResize: u.StatefulStream<number>;
266
262
  gridState: u.StatefulStream<import("./gridSystem").GridState>;
267
263
  totalListHeight: u.StatefulStream<number>;
268
264
  isSeeking: u.StatefulStream<boolean>;
269
265
  scrollSeekConfiguration: u.StatefulStream<false | import("./interfaces").ScrollSeekConfiguration | undefined>;
270
- scrollVelocity: u.StatefulStream<number>;
271
266
  scrollSeekRangeChanged: u.Stream<import("./interfaces").ListRange>;
272
267
  totalCount: u.StatefulStream<number>;
273
268
  viewportDimensions: u.StatefulStream<import("./gridSystem").ElementDimensions>;
@@ -282,7 +277,9 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
282
277
  windowViewportRect: u.Stream<import("./interfaces").WindowViewportInfo>;
283
278
  windowScrollTo: u.Stream<ScrollToOptions>;
284
279
  useWindowScroll: u.StatefulStream<boolean>;
285
- windowScrollTop: u.Stream<number>;
280
+ windowScrollContainerState: u.Stream<[number, number]>;
281
+ deviation: u.StatefulStream<number>;
282
+ scrollContainerState: u.Stream<[number, number]>;
286
283
  initialItemCount: u.StatefulStream<number>;
287
284
  }>, u.SystemSpec<u.SystemSpecs, () => {
288
285
  itemContent: u.StatefulStream<GridItemContent>;
@@ -308,11 +305,12 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
308
305
  atBottomStateChange: u.Stream<boolean>;
309
306
  scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
310
307
  atBottomThreshold: u.StatefulStream<number>;
308
+ scrollVelocity: u.StatefulStream<number>;
309
+ lastJumpDueToItemResize: u.StatefulStream<number>;
311
310
  gridState: u.StatefulStream<import("./gridSystem").GridState>;
312
311
  totalListHeight: u.StatefulStream<number>;
313
312
  isSeeking: u.StatefulStream<boolean>;
314
313
  scrollSeekConfiguration: u.StatefulStream<false | import("./interfaces").ScrollSeekConfiguration | undefined>;
315
- scrollVelocity: u.StatefulStream<number>;
316
314
  scrollSeekRangeChanged: u.Stream<import("./interfaces").ListRange>;
317
315
  totalCount: u.StatefulStream<number>;
318
316
  viewportDimensions: u.StatefulStream<import("./gridSystem").ElementDimensions>;
@@ -327,7 +325,9 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
327
325
  windowViewportRect: u.Stream<import("./interfaces").WindowViewportInfo>;
328
326
  windowScrollTo: u.Stream<ScrollToOptions>;
329
327
  useWindowScroll: u.StatefulStream<boolean>;
330
- windowScrollTop: u.Stream<number>;
328
+ windowScrollContainerState: u.Stream<[number, number]>;
329
+ deviation: u.StatefulStream<number>;
330
+ scrollContainerState: u.Stream<[number, number]>;
331
331
  initialItemCount: u.StatefulStream<number>;
332
332
  }, {
333
333
  itemContent: u.StatefulStream<GridItemContent>;
@@ -369,11 +369,12 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
369
369
  atBottomStateChange: u.Stream<boolean>;
370
370
  scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
371
371
  atBottomThreshold: u.StatefulStream<number>;
372
+ scrollVelocity: u.StatefulStream<number>;
373
+ lastJumpDueToItemResize: u.StatefulStream<number>;
372
374
  gridState: u.StatefulStream<import("./gridSystem").GridState>;
373
375
  totalListHeight: u.StatefulStream<number>;
374
376
  isSeeking: u.StatefulStream<boolean>;
375
377
  scrollSeekConfiguration: u.StatefulStream<false | import("./interfaces").ScrollSeekConfiguration | undefined>;
376
- scrollVelocity: u.StatefulStream<number>;
377
378
  scrollSeekRangeChanged: u.Stream<import("./interfaces").ListRange>;
378
379
  totalCount: u.StatefulStream<number>;
379
380
  viewportDimensions: u.StatefulStream<import("./gridSystem").ElementDimensions>;
@@ -388,7 +389,9 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
388
389
  windowViewportRect: u.Stream<import("./interfaces").WindowViewportInfo>;
389
390
  windowScrollTo: u.Stream<ScrollToOptions>;
390
391
  useWindowScroll: u.StatefulStream<boolean>;
391
- windowScrollTop: u.Stream<number>;
392
+ windowScrollContainerState: u.Stream<[number, number]>;
393
+ deviation: u.StatefulStream<number>;
394
+ scrollContainerState: u.Stream<[number, number]>;
392
395
  initialItemCount: u.StatefulStream<number>;
393
396
  }>, {
394
397
  optional: {