react-virtuoso 2.2.7 → 2.3.0

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 +31 -21
  2. package/dist/List.d.ts +276 -206
  3. package/dist/alignToBottomSystem.d.ts +25 -21
  4. package/dist/components.d.ts +4 -0
  5. package/dist/domIOSystem.d.ts +1 -4
  6. package/dist/followOutputSystem.d.ts +38 -12
  7. package/dist/gridSystem.d.ts +25 -19
  8. package/dist/groupedListSystem.d.ts +2 -2
  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 -17
  16. package/dist/initialScrollTopSystem.d.ts +25 -21
  17. package/dist/initialTopMostItemIndexSystem.d.ts +4 -4
  18. package/dist/interfaces.d.ts +1 -1
  19. package/dist/listStateSystem.d.ts +19 -16
  20. package/dist/listSystem.d.ts +256 -193
  21. package/dist/scrollIntoViewSystem.d.ts +25 -21
  22. package/dist/scrollSeekSystem.d.ts +9 -7
  23. package/dist/scrollToIndexSystem.d.ts +2 -2
  24. package/dist/sizeRangeSystem.d.ts +3 -3
  25. package/dist/stateFlagsSystem.d.ts +9 -5
  26. package/dist/topItemCountSystem.d.ts +21 -17
  27. package/dist/totalListHeightSystem.d.ts +23 -19
  28. package/dist/upwardScrollFixSystem.d.ts +31 -25
  29. package/dist/windowScrollerSystem.d.ts +2 -2
  30. package/package.json +3 -3
package/dist/Grid.d.ts CHANGED
@@ -31,10 +31,10 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
31
31
  viewportHeight: u.Stream<number>;
32
32
  headerHeight: u.StatefulStream<number>;
33
33
  footerHeight: u.StatefulStream<number>;
34
+ scrollHeight: u.Stream<number>;
34
35
  smoothScrollTargetReached: u.Stream<true>;
35
36
  scrollTo: u.Stream<ScrollToOptions>;
36
37
  scrollBy: u.Stream<ScrollToOptions>;
37
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
38
38
  statefulScrollTop: u.StatefulStream<number>;
39
39
  deviation: u.StatefulStream<number>;
40
40
  scrollingInProgress: u.StatefulStream<boolean>;
@@ -43,10 +43,10 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
43
43
  viewportHeight: u.Stream<number>;
44
44
  headerHeight: u.StatefulStream<number>;
45
45
  footerHeight: u.StatefulStream<number>;
46
+ scrollHeight: u.Stream<number>;
46
47
  smoothScrollTargetReached: u.Stream<true>;
47
48
  scrollTo: u.Stream<ScrollToOptions>;
48
49
  scrollBy: u.Stream<ScrollToOptions>;
49
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
50
50
  statefulScrollTop: u.StatefulStream<number>;
51
51
  deviation: u.StatefulStream<number>;
52
52
  scrollingInProgress: u.StatefulStream<boolean>;
@@ -61,10 +61,10 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
61
61
  viewportHeight: u.Stream<number>;
62
62
  headerHeight: u.StatefulStream<number>;
63
63
  footerHeight: u.StatefulStream<number>;
64
+ scrollHeight: u.Stream<number>;
64
65
  smoothScrollTargetReached: u.Stream<true>;
65
66
  scrollTo: u.Stream<ScrollToOptions>;
66
67
  scrollBy: u.Stream<ScrollToOptions>;
67
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
68
68
  statefulScrollTop: u.StatefulStream<number>;
69
69
  deviation: u.StatefulStream<number>;
70
70
  scrollingInProgress: u.StatefulStream<boolean>;
@@ -73,22 +73,22 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
73
73
  viewportHeight: u.Stream<number>;
74
74
  headerHeight: u.StatefulStream<number>;
75
75
  footerHeight: u.StatefulStream<number>;
76
+ scrollHeight: u.Stream<number>;
76
77
  smoothScrollTargetReached: u.Stream<true>;
77
78
  scrollTo: u.Stream<ScrollToOptions>;
78
79
  scrollBy: u.Stream<ScrollToOptions>;
79
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
80
80
  statefulScrollTop: u.StatefulStream<number>;
81
81
  deviation: u.StatefulStream<number>;
82
82
  scrollingInProgress: u.StatefulStream<boolean>;
83
- }>], ([{ scrollTop, viewportHeight, headerHeight, footerHeight }]: [{
83
+ }>], ([{ scrollTop, viewportHeight, headerHeight, footerHeight, scrollHeight }]: [{
84
84
  scrollTop: u.Stream<number>;
85
85
  viewportHeight: u.Stream<number>;
86
86
  headerHeight: u.StatefulStream<number>;
87
87
  footerHeight: u.StatefulStream<number>;
88
+ scrollHeight: u.Stream<number>;
88
89
  smoothScrollTargetReached: u.Stream<true>;
89
90
  scrollTo: u.Stream<ScrollToOptions>;
90
91
  scrollBy: u.Stream<ScrollToOptions>;
91
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
92
92
  statefulScrollTop: u.StatefulStream<number>;
93
93
  deviation: u.StatefulStream<number>;
94
94
  scrollingInProgress: u.StatefulStream<boolean>;
@@ -99,16 +99,17 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
99
99
  atBottomState: u.Stream<import("./stateFlagsSystem").AtBottomState>;
100
100
  atTopStateChange: u.Stream<boolean>;
101
101
  atBottomStateChange: u.Stream<boolean>;
102
- listStateListener: u.Stream<import("./stateFlagsSystem").ListBottomInfo>;
102
+ scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
103
+ atBottomThreshold: u.StatefulStream<number>;
103
104
  }>, u.SystemSpec<[u.SystemSpec<never[], () => {
104
105
  scrollTop: u.Stream<number>;
105
106
  viewportHeight: u.Stream<number>;
106
107
  headerHeight: u.StatefulStream<number>;
107
108
  footerHeight: u.StatefulStream<number>;
109
+ scrollHeight: u.Stream<number>;
108
110
  smoothScrollTargetReached: u.Stream<true>;
109
111
  scrollTo: u.Stream<ScrollToOptions>;
110
112
  scrollBy: u.Stream<ScrollToOptions>;
111
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
112
113
  statefulScrollTop: u.StatefulStream<number>;
113
114
  deviation: u.StatefulStream<number>;
114
115
  scrollingInProgress: u.StatefulStream<boolean>;
@@ -117,22 +118,22 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
117
118
  viewportHeight: u.Stream<number>;
118
119
  headerHeight: u.StatefulStream<number>;
119
120
  footerHeight: u.StatefulStream<number>;
121
+ scrollHeight: u.Stream<number>;
120
122
  smoothScrollTargetReached: u.Stream<true>;
121
123
  scrollTo: u.Stream<ScrollToOptions>;
122
124
  scrollBy: u.Stream<ScrollToOptions>;
123
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
124
125
  statefulScrollTop: u.StatefulStream<number>;
125
126
  deviation: u.StatefulStream<number>;
126
127
  scrollingInProgress: u.StatefulStream<boolean>;
127
- }>], ([{ scrollTop, viewportHeight, headerHeight, footerHeight }]: [{
128
+ }>], ([{ scrollTop, viewportHeight, headerHeight, footerHeight, scrollHeight }]: [{
128
129
  scrollTop: u.Stream<number>;
129
130
  viewportHeight: u.Stream<number>;
130
131
  headerHeight: u.StatefulStream<number>;
131
132
  footerHeight: u.StatefulStream<number>;
133
+ scrollHeight: u.Stream<number>;
132
134
  smoothScrollTargetReached: u.Stream<true>;
133
135
  scrollTo: u.Stream<ScrollToOptions>;
134
136
  scrollBy: u.Stream<ScrollToOptions>;
135
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
136
137
  statefulScrollTop: u.StatefulStream<number>;
137
138
  deviation: u.StatefulStream<number>;
138
139
  scrollingInProgress: u.StatefulStream<boolean>;
@@ -143,16 +144,17 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
143
144
  atBottomState: u.Stream<import("./stateFlagsSystem").AtBottomState>;
144
145
  atTopStateChange: u.Stream<boolean>;
145
146
  atBottomStateChange: u.Stream<boolean>;
146
- listStateListener: u.Stream<import("./stateFlagsSystem").ListBottomInfo>;
147
+ scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
148
+ atBottomThreshold: u.StatefulStream<number>;
147
149
  }>], ([{ scrollTop }, { isScrolling }]: [{
148
150
  scrollTop: u.Stream<number>;
149
151
  viewportHeight: u.Stream<number>;
150
152
  headerHeight: u.StatefulStream<number>;
151
153
  footerHeight: u.StatefulStream<number>;
154
+ scrollHeight: u.Stream<number>;
152
155
  smoothScrollTargetReached: u.Stream<true>;
153
156
  scrollTo: u.Stream<ScrollToOptions>;
154
157
  scrollBy: u.Stream<ScrollToOptions>;
155
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
156
158
  statefulScrollTop: u.StatefulStream<number>;
157
159
  deviation: u.StatefulStream<number>;
158
160
  scrollingInProgress: u.StatefulStream<boolean>;
@@ -163,7 +165,8 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
163
165
  atBottomState: u.Stream<import("./stateFlagsSystem").AtBottomState>;
164
166
  atTopStateChange: u.Stream<boolean>;
165
167
  atBottomStateChange: u.Stream<boolean>;
166
- listStateListener: u.Stream<import("./stateFlagsSystem").ListBottomInfo>;
168
+ scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
169
+ atBottomThreshold: u.StatefulStream<number>;
167
170
  }]) => {
168
171
  isSeeking: u.StatefulStream<boolean>;
169
172
  scrollSeekConfiguration: u.StatefulStream<false | import("./interfaces").ScrollSeekConfiguration | undefined>;
@@ -183,10 +186,10 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
183
186
  viewportHeight: u.Stream<number>;
184
187
  headerHeight: u.StatefulStream<number>;
185
188
  footerHeight: u.StatefulStream<number>;
189
+ scrollHeight: u.Stream<number>;
186
190
  smoothScrollTargetReached: u.Stream<true>;
187
191
  scrollTo: u.Stream<ScrollToOptions>;
188
192
  scrollBy: u.Stream<ScrollToOptions>;
189
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
190
193
  statefulScrollTop: u.StatefulStream<number>;
191
194
  deviation: u.StatefulStream<number>;
192
195
  scrollingInProgress: u.StatefulStream<boolean>;
@@ -195,10 +198,10 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
195
198
  viewportHeight: u.Stream<number>;
196
199
  headerHeight: u.StatefulStream<number>;
197
200
  footerHeight: u.StatefulStream<number>;
201
+ scrollHeight: u.Stream<number>;
198
202
  smoothScrollTargetReached: u.Stream<true>;
199
203
  scrollTo: u.Stream<ScrollToOptions>;
200
204
  scrollBy: u.Stream<ScrollToOptions>;
201
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
202
205
  statefulScrollTop: u.StatefulStream<number>;
203
206
  deviation: u.StatefulStream<number>;
204
207
  scrollingInProgress: u.StatefulStream<boolean>;
@@ -218,10 +221,10 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
218
221
  viewportHeight: u.Stream<number>;
219
222
  headerHeight: u.StatefulStream<number>;
220
223
  footerHeight: u.StatefulStream<number>;
224
+ scrollHeight: u.Stream<number>;
221
225
  smoothScrollTargetReached: u.Stream<true>;
222
226
  scrollTo: u.Stream<ScrollToOptions>;
223
227
  scrollBy: u.Stream<ScrollToOptions>;
224
- scrollDirection: u.StatefulStream<import("./domIOSystem").ScrollDirection>;
225
228
  statefulScrollTop: u.StatefulStream<number>;
226
229
  deviation: u.StatefulStream<number>;
227
230
  scrollingInProgress: u.StatefulStream<boolean>;
@@ -232,7 +235,8 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
232
235
  atBottomState: u.Stream<import("./stateFlagsSystem").AtBottomState>;
233
236
  atTopStateChange: u.Stream<boolean>;
234
237
  atBottomStateChange: u.Stream<boolean>;
235
- listStateListener: u.Stream<import("./stateFlagsSystem").ListBottomInfo>;
238
+ scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
239
+ atBottomThreshold: u.StatefulStream<number>;
236
240
  }, {
237
241
  isSeeking: u.StatefulStream<boolean>;
238
242
  scrollSeekConfiguration: u.StatefulStream<false | import("./interfaces").ScrollSeekConfiguration | undefined>;
@@ -257,7 +261,8 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
257
261
  atBottomState: u.Stream<import("./stateFlagsSystem").AtBottomState>;
258
262
  atTopStateChange: u.Stream<boolean>;
259
263
  atBottomStateChange: u.Stream<boolean>;
260
- listStateListener: u.Stream<import("./stateFlagsSystem").ListBottomInfo>;
264
+ scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
265
+ atBottomThreshold: u.StatefulStream<number>;
261
266
  gridState: u.StatefulStream<import("./gridSystem").GridState>;
262
267
  totalListHeight: u.StatefulStream<number>;
263
268
  isSeeking: u.StatefulStream<boolean>;
@@ -268,6 +273,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
268
273
  viewportDimensions: u.StatefulStream<import("./gridSystem").ElementDimensions>;
269
274
  itemDimensions: u.StatefulStream<import("./gridSystem").ElementDimensions>;
270
275
  scrollTop: u.Stream<number>;
276
+ scrollHeight: u.Stream<number>;
271
277
  overscan: u.StatefulStream<import("./sizeRangeSystem").Overscan>;
272
278
  scrollBy: u.Stream<ScrollToOptions>;
273
279
  scrollTo: u.Stream<ScrollToOptions>;
@@ -300,7 +306,8 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
300
306
  atBottomState: u.Stream<import("./stateFlagsSystem").AtBottomState>;
301
307
  atTopStateChange: u.Stream<boolean>;
302
308
  atBottomStateChange: u.Stream<boolean>;
303
- listStateListener: u.Stream<import("./stateFlagsSystem").ListBottomInfo>;
309
+ scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
310
+ atBottomThreshold: u.StatefulStream<number>;
304
311
  gridState: u.StatefulStream<import("./gridSystem").GridState>;
305
312
  totalListHeight: u.StatefulStream<number>;
306
313
  isSeeking: u.StatefulStream<boolean>;
@@ -311,6 +318,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
311
318
  viewportDimensions: u.StatefulStream<import("./gridSystem").ElementDimensions>;
312
319
  itemDimensions: u.StatefulStream<import("./gridSystem").ElementDimensions>;
313
320
  scrollTop: u.Stream<number>;
321
+ scrollHeight: u.Stream<number>;
314
322
  overscan: u.StatefulStream<import("./sizeRangeSystem").Overscan>;
315
323
  scrollBy: u.Stream<ScrollToOptions>;
316
324
  scrollTo: u.Stream<ScrollToOptions>;
@@ -359,7 +367,8 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
359
367
  atBottomState: u.Stream<import("./stateFlagsSystem").AtBottomState>;
360
368
  atTopStateChange: u.Stream<boolean>;
361
369
  atBottomStateChange: u.Stream<boolean>;
362
- listStateListener: u.Stream<import("./stateFlagsSystem").ListBottomInfo>;
370
+ scrollDirection: u.StatefulStream<import("./stateFlagsSystem").ScrollDirection>;
371
+ atBottomThreshold: u.StatefulStream<number>;
363
372
  gridState: u.StatefulStream<import("./gridSystem").GridState>;
364
373
  totalListHeight: u.StatefulStream<number>;
365
374
  isSeeking: u.StatefulStream<boolean>;
@@ -370,6 +379,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
370
379
  viewportDimensions: u.StatefulStream<import("./gridSystem").ElementDimensions>;
371
380
  itemDimensions: u.StatefulStream<import("./gridSystem").ElementDimensions>;
372
381
  scrollTop: u.Stream<number>;
382
+ scrollHeight: u.Stream<number>;
373
383
  overscan: u.StatefulStream<import("./sizeRangeSystem").Overscan>;
374
384
  scrollBy: u.Stream<ScrollToOptions>;
375
385
  scrollTo: u.Stream<ScrollToOptions>;