react-virtuoso 2.5.1 → 2.7.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.
- package/dist/Grid.d.ts +72 -23
- package/dist/List.d.ts +392 -87
- package/dist/Table.d.ts +338 -68
- package/dist/alignToBottomSystem.d.ts +10 -0
- package/dist/components.d.ts +1144 -53
- package/dist/followOutputSystem.d.ts +8 -0
- package/dist/gridSystem.d.ts +4 -1
- package/dist/groupedListSystem.d.ts +2 -0
- package/dist/hooks/useChangedChildSizes.d.ts +1 -1
- package/dist/hooks/useScrollTop.d.ts +1 -1
- package/dist/hooks/useWindowViewportRect.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.m.js +1 -1
- package/dist/index.m.js.map +1 -1
- package/dist/initialItemCountSystem.d.ts +12 -0
- package/dist/initialScrollTopSystem.d.ts +10 -0
- package/dist/initialTopMostItemIndexSystem.d.ts +4 -0
- package/dist/interfaces.d.ts +71 -31
- package/dist/listStateSystem.d.ts +10 -0
- package/dist/listSystem.d.ts +113 -1
- package/dist/scrollIntoViewSystem.d.ts +14 -0
- package/dist/scrollToIndexSystem.d.ts +2 -0
- package/dist/sizeSystem.d.ts +1 -0
- package/dist/topItemCountSystem.d.ts +10 -0
- package/dist/totalListHeightSystem.d.ts +10 -0
- package/dist/upwardScrollFixSystem.d.ts +12 -0
- package/dist/windowScrollerSystem.d.ts +1 -0
- package/package.json +1 -1
|
@@ -17,6 +17,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
17
17
|
firstItemIndex: u.StatefulStream<number>;
|
|
18
18
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
19
19
|
listRefresh: u.Stream<boolean>;
|
|
20
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
20
21
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
21
22
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
22
23
|
}>, u.SystemSpec<[u.SystemSpec<[u.SystemSpec<never[], () => {
|
|
@@ -37,6 +38,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
37
38
|
firstItemIndex: u.StatefulStream<number>;
|
|
38
39
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
39
40
|
listRefresh: u.Stream<boolean>;
|
|
41
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
40
42
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
41
43
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
42
44
|
}>, u.SystemSpec<[u.SystemSpec<[u.SystemSpec<never[], () => {
|
|
@@ -57,6 +59,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
57
59
|
firstItemIndex: u.StatefulStream<number>;
|
|
58
60
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
59
61
|
listRefresh: u.Stream<boolean>;
|
|
62
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
60
63
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
61
64
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
62
65
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -84,6 +87,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
84
87
|
firstItemIndex: u.StatefulStream<number>;
|
|
85
88
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
86
89
|
listRefresh: u.Stream<boolean>;
|
|
90
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
87
91
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
88
92
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
89
93
|
}, {
|
|
@@ -153,6 +157,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
153
157
|
firstItemIndex: u.StatefulStream<number>;
|
|
154
158
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
155
159
|
listRefresh: u.Stream<boolean>;
|
|
160
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
156
161
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
157
162
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
158
163
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -186,6 +191,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
186
191
|
firstItemIndex: u.StatefulStream<number>;
|
|
187
192
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
188
193
|
listRefresh: u.Stream<boolean>;
|
|
194
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
189
195
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
190
196
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
191
197
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -216,6 +222,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
216
222
|
firstItemIndex: u.StatefulStream<number>;
|
|
217
223
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
218
224
|
listRefresh: u.Stream<boolean>;
|
|
225
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
219
226
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
220
227
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
221
228
|
}, {
|
|
@@ -258,6 +265,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
258
265
|
firstItemIndex: u.StatefulStream<number>;
|
|
259
266
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
260
267
|
listRefresh: u.Stream<boolean>;
|
|
268
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
261
269
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
262
270
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
263
271
|
}, {
|
|
@@ -300,6 +308,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
300
308
|
firstItemIndex: u.StatefulStream<number>;
|
|
301
309
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
302
310
|
listRefresh: u.Stream<boolean>;
|
|
311
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
303
312
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
304
313
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
305
314
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -330,6 +339,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
330
339
|
firstItemIndex: u.StatefulStream<number>;
|
|
331
340
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
332
341
|
listRefresh: u.Stream<boolean>;
|
|
342
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
333
343
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
334
344
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
335
345
|
}, {
|
|
@@ -409,6 +419,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
409
419
|
firstItemIndex: u.StatefulStream<number>;
|
|
410
420
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
411
421
|
listRefresh: u.Stream<boolean>;
|
|
422
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
412
423
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
413
424
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
414
425
|
}, {
|
|
@@ -479,6 +490,7 @@ export declare const initialItemCountSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
479
490
|
firstItemIndex: u.StatefulStream<number>;
|
|
480
491
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
481
492
|
listRefresh: u.Stream<boolean>;
|
|
493
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
482
494
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
483
495
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
484
496
|
}, {
|
|
@@ -30,6 +30,7 @@ export declare const initialScrollTopSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
30
30
|
firstItemIndex: u.StatefulStream<number>;
|
|
31
31
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
32
32
|
listRefresh: u.Stream<boolean>;
|
|
33
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
33
34
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
34
35
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
35
36
|
}>, u.SystemSpec<[u.SystemSpec<[u.SystemSpec<never[], () => {
|
|
@@ -50,6 +51,7 @@ export declare const initialScrollTopSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
50
51
|
firstItemIndex: u.StatefulStream<number>;
|
|
51
52
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
52
53
|
listRefresh: u.Stream<boolean>;
|
|
54
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
53
55
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
54
56
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
55
57
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -77,6 +79,7 @@ export declare const initialScrollTopSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
77
79
|
firstItemIndex: u.StatefulStream<number>;
|
|
78
80
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
79
81
|
listRefresh: u.Stream<boolean>;
|
|
82
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
80
83
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
81
84
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
82
85
|
}, {
|
|
@@ -146,6 +149,7 @@ export declare const initialScrollTopSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
146
149
|
firstItemIndex: u.StatefulStream<number>;
|
|
147
150
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
148
151
|
listRefresh: u.Stream<boolean>;
|
|
152
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
149
153
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
150
154
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
151
155
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -179,6 +183,7 @@ export declare const initialScrollTopSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
179
183
|
firstItemIndex: u.StatefulStream<number>;
|
|
180
184
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
181
185
|
listRefresh: u.Stream<boolean>;
|
|
186
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
182
187
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
183
188
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
184
189
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -209,6 +214,7 @@ export declare const initialScrollTopSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
209
214
|
firstItemIndex: u.StatefulStream<number>;
|
|
210
215
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
211
216
|
listRefresh: u.Stream<boolean>;
|
|
217
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
212
218
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
213
219
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
214
220
|
}, {
|
|
@@ -251,6 +257,7 @@ export declare const initialScrollTopSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
251
257
|
firstItemIndex: u.StatefulStream<number>;
|
|
252
258
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
253
259
|
listRefresh: u.Stream<boolean>;
|
|
260
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
254
261
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
255
262
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
256
263
|
}, {
|
|
@@ -293,6 +300,7 @@ export declare const initialScrollTopSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
293
300
|
firstItemIndex: u.StatefulStream<number>;
|
|
294
301
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
295
302
|
listRefresh: u.Stream<boolean>;
|
|
303
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
296
304
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
297
305
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
298
306
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -323,6 +331,7 @@ export declare const initialScrollTopSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
323
331
|
firstItemIndex: u.StatefulStream<number>;
|
|
324
332
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
325
333
|
listRefresh: u.Stream<boolean>;
|
|
334
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
326
335
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
327
336
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
328
337
|
}, {
|
|
@@ -402,6 +411,7 @@ export declare const initialScrollTopSystem: u.SystemSpec<[u.SystemSpec<[u.Syste
|
|
|
402
411
|
firstItemIndex: u.StatefulStream<number>;
|
|
403
412
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
404
413
|
listRefresh: u.Stream<boolean>;
|
|
414
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
405
415
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
406
416
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
407
417
|
}, {
|
|
@@ -17,6 +17,7 @@ export declare const initialTopMostItemIndexSystem: u.SystemSpec<[u.SystemSpec<[
|
|
|
17
17
|
firstItemIndex: u.StatefulStream<number>;
|
|
18
18
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
19
19
|
listRefresh: u.Stream<boolean>;
|
|
20
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
20
21
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
21
22
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
22
23
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -50,6 +51,7 @@ export declare const initialTopMostItemIndexSystem: u.SystemSpec<[u.SystemSpec<[
|
|
|
50
51
|
firstItemIndex: u.StatefulStream<number>;
|
|
51
52
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
52
53
|
listRefresh: u.Stream<boolean>;
|
|
54
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
53
55
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
54
56
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
55
57
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -80,6 +82,7 @@ export declare const initialTopMostItemIndexSystem: u.SystemSpec<[u.SystemSpec<[
|
|
|
80
82
|
firstItemIndex: u.StatefulStream<number>;
|
|
81
83
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
82
84
|
listRefresh: u.Stream<boolean>;
|
|
85
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
83
86
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
84
87
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
85
88
|
}, {
|
|
@@ -122,6 +125,7 @@ export declare const initialTopMostItemIndexSystem: u.SystemSpec<[u.SystemSpec<[
|
|
|
122
125
|
firstItemIndex: u.StatefulStream<number>;
|
|
123
126
|
sizes: u.StatefulStream<import("./sizeSystem").SizeState>;
|
|
124
127
|
listRefresh: u.Stream<boolean>;
|
|
128
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
125
129
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
126
130
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
127
131
|
}, {
|
package/dist/interfaces.d.ts
CHANGED
|
@@ -3,12 +3,12 @@ export interface ListRange {
|
|
|
3
3
|
startIndex: number;
|
|
4
4
|
endIndex: number;
|
|
5
5
|
}
|
|
6
|
-
export interface ItemContent<D> {
|
|
7
|
-
(index: number, data: D): ReactNode;
|
|
6
|
+
export interface ItemContent<D, C> {
|
|
7
|
+
(index: number, data: D, context: C): ReactNode;
|
|
8
8
|
}
|
|
9
9
|
export declare type FixedHeaderContent = (() => React.ReactChildren | React.ReactNode) | null;
|
|
10
|
-
export interface GroupItemContent<D> {
|
|
11
|
-
(index: number, groupIndex: number, data: D): ReactNode;
|
|
10
|
+
export interface GroupItemContent<D, C> {
|
|
11
|
+
(index: number, groupIndex: number, data: D, context: C): ReactNode;
|
|
12
12
|
}
|
|
13
13
|
export interface GroupContent {
|
|
14
14
|
(index: number): ReactNode;
|
|
@@ -63,86 +63,118 @@ export interface GridScrollSeekPlaceholderProps {
|
|
|
63
63
|
/**
|
|
64
64
|
* Customize the Virtuoso rendering by passing a set of custom components.
|
|
65
65
|
*/
|
|
66
|
-
export interface Components {
|
|
66
|
+
export interface Components<Context = unknown> {
|
|
67
67
|
/**
|
|
68
68
|
* Set to render a component at the top of the list.
|
|
69
69
|
*
|
|
70
70
|
* The header remains above the top items and does not remain sticky.
|
|
71
71
|
*/
|
|
72
|
-
Header?: ComponentType
|
|
72
|
+
Header?: ComponentType<{
|
|
73
|
+
context?: Context;
|
|
74
|
+
}>;
|
|
73
75
|
/**
|
|
74
76
|
* Set to render a component at the bottom of the list.
|
|
75
77
|
*/
|
|
76
|
-
Footer?: ComponentType
|
|
78
|
+
Footer?: ComponentType<{
|
|
79
|
+
context?: Context;
|
|
80
|
+
}>;
|
|
77
81
|
/**
|
|
78
82
|
* Set to customize the item wrapping element. Use only if you would like to render list from elements different than a `div`.
|
|
79
83
|
*/
|
|
80
|
-
Item?: ComponentType<ItemProps
|
|
84
|
+
Item?: ComponentType<ItemProps & {
|
|
85
|
+
context?: Context;
|
|
86
|
+
}>;
|
|
81
87
|
/**
|
|
82
88
|
* Set to customize the group item wrapping element. Use only if you would like to render list from elements different than a `div`.
|
|
83
89
|
*/
|
|
84
|
-
Group?: ComponentType<GroupProps
|
|
90
|
+
Group?: ComponentType<GroupProps & {
|
|
91
|
+
context?: Context;
|
|
92
|
+
}>;
|
|
85
93
|
/**
|
|
86
94
|
* Set to customize the top list item wrapping element. Use if you would like to render list from elements different than a `div`
|
|
87
95
|
* or you want to set a custom z-index for the sticky position.
|
|
88
96
|
*/
|
|
89
|
-
TopItemList?: ComponentType<TopItemListProps
|
|
97
|
+
TopItemList?: ComponentType<TopItemListProps & {
|
|
98
|
+
context?: Context;
|
|
99
|
+
}>;
|
|
90
100
|
/**
|
|
91
101
|
* Set to customize the outermost scrollable element. This should not be necessary in general,
|
|
92
102
|
* as the component passes its HTML attribute props to it.
|
|
93
103
|
*/
|
|
94
|
-
Scroller?: ComponentType<ScrollerProps
|
|
104
|
+
Scroller?: ComponentType<ScrollerProps & {
|
|
105
|
+
context?: Context;
|
|
106
|
+
}>;
|
|
95
107
|
/**
|
|
96
108
|
* Set to customize the items wrapper. Use only if you would like to render list from elements different than a `div`.
|
|
97
109
|
*/
|
|
98
|
-
List?: ComponentType<ListProps
|
|
110
|
+
List?: ComponentType<ListProps & {
|
|
111
|
+
context?: Context;
|
|
112
|
+
}>;
|
|
99
113
|
/**
|
|
100
114
|
* Set to render a custom UI when the list is empty.
|
|
101
115
|
*/
|
|
102
|
-
EmptyPlaceholder?: ComponentType
|
|
116
|
+
EmptyPlaceholder?: ComponentType<{
|
|
117
|
+
context?: Context;
|
|
118
|
+
}>;
|
|
103
119
|
/**
|
|
104
120
|
* Set to render an item placeholder when the user scrolls fast. See the `scrollSeek` property for more details.
|
|
105
121
|
*/
|
|
106
|
-
ScrollSeekPlaceholder?: ComponentType<ScrollSeekPlaceholderProps
|
|
122
|
+
ScrollSeekPlaceholder?: ComponentType<ScrollSeekPlaceholderProps & {
|
|
123
|
+
context?: Context;
|
|
124
|
+
}>;
|
|
107
125
|
}
|
|
108
126
|
/**
|
|
109
127
|
* Customize the TableVirtuoso rendering by passing a set of custom components.
|
|
110
128
|
*/
|
|
111
|
-
export interface TableComponents {
|
|
129
|
+
export interface TableComponents<Context = unknown> {
|
|
112
130
|
/**
|
|
113
131
|
* Set to customize the wrapping `table` element.
|
|
114
132
|
*
|
|
115
133
|
*/
|
|
116
|
-
Table?: ComponentType<TableProps
|
|
134
|
+
Table?: ComponentType<TableProps & {
|
|
135
|
+
context?: Context;
|
|
136
|
+
}>;
|
|
117
137
|
/**
|
|
118
138
|
* Set to render a fixed header at the top of the table (`thead`). use [[fixedHeaderHeight]] to set the contents
|
|
119
139
|
*
|
|
120
140
|
*/
|
|
121
|
-
TableHead?: ComponentType
|
|
141
|
+
TableHead?: ComponentType<{
|
|
142
|
+
context?: Context;
|
|
143
|
+
}>;
|
|
122
144
|
/**
|
|
123
145
|
* Set to customize the item wrapping element. Default is `tr`.
|
|
124
146
|
*/
|
|
125
|
-
TableRow?: ComponentType<ItemProps
|
|
147
|
+
TableRow?: ComponentType<ItemProps & {
|
|
148
|
+
context?: Context;
|
|
149
|
+
}>;
|
|
126
150
|
/**
|
|
127
151
|
* Set to customize the outermost scrollable element. This should not be necessary in general,
|
|
128
152
|
* as the component passes its HTML attribute props to it.
|
|
129
153
|
*/
|
|
130
|
-
Scroller?: ComponentType<ScrollerProps
|
|
154
|
+
Scroller?: ComponentType<ScrollerProps & {
|
|
155
|
+
context?: Context;
|
|
156
|
+
}>;
|
|
131
157
|
/**
|
|
132
158
|
* Set to customize the items wrapper. Default is `tbody`.
|
|
133
159
|
*/
|
|
134
|
-
TableBody?: ComponentType<ListProps
|
|
160
|
+
TableBody?: ComponentType<ListProps & {
|
|
161
|
+
context?: Context;
|
|
162
|
+
}>;
|
|
135
163
|
/**
|
|
136
164
|
* Set to render a custom UI when the list is empty.
|
|
137
165
|
*/
|
|
138
|
-
EmptyPlaceholder?: ComponentType
|
|
166
|
+
EmptyPlaceholder?: ComponentType<{
|
|
167
|
+
context?: Context;
|
|
168
|
+
}>;
|
|
139
169
|
/**
|
|
140
170
|
* Set to render an item placeholder when the user scrolls fast. See the `scrollSeek` property for more details.
|
|
141
171
|
*/
|
|
142
|
-
ScrollSeekPlaceholder?: ComponentType<ScrollSeekPlaceholderProps
|
|
172
|
+
ScrollSeekPlaceholder?: ComponentType<ScrollSeekPlaceholderProps & {
|
|
173
|
+
context?: Context;
|
|
174
|
+
}>;
|
|
143
175
|
}
|
|
144
|
-
export interface ComputeItemKey<D> {
|
|
145
|
-
(index: number, item: D): Key;
|
|
176
|
+
export interface ComputeItemKey<D, C> {
|
|
177
|
+
(index: number, item: D, context: C): Key;
|
|
146
178
|
}
|
|
147
179
|
export interface ScrollSeekToggle {
|
|
148
180
|
(velocity: number, range: ListRange): boolean;
|
|
@@ -206,31 +238,39 @@ export interface GridItem {
|
|
|
206
238
|
'data-index': number;
|
|
207
239
|
className?: string;
|
|
208
240
|
}
|
|
209
|
-
export interface GridComponents {
|
|
241
|
+
export interface GridComponents<Context = any> {
|
|
210
242
|
/**
|
|
211
243
|
* Set to customize the item wrapping element. Use only if you would like to render list from elements different than a `div`.
|
|
212
244
|
*/
|
|
213
|
-
Item?: ComponentType<GridItem
|
|
245
|
+
Item?: ComponentType<GridItem & {
|
|
246
|
+
context?: Context;
|
|
247
|
+
}>;
|
|
214
248
|
/**
|
|
215
249
|
* Set to customize the outermost scrollable element. This should not be necessary in general,
|
|
216
250
|
* as the component passes its HTML attribute props to it.
|
|
217
251
|
*/
|
|
218
|
-
Scroller?: ComponentType<ScrollerProps
|
|
252
|
+
Scroller?: ComponentType<ScrollerProps & {
|
|
253
|
+
context?: Context;
|
|
254
|
+
}>;
|
|
219
255
|
/**
|
|
220
256
|
* Set to customize the items wrapper. Use only if you would like to render list from elements different than a `div`.
|
|
221
257
|
*/
|
|
222
|
-
List?: ComponentType<GridListProps
|
|
258
|
+
List?: ComponentType<GridListProps & {
|
|
259
|
+
context?: Context;
|
|
260
|
+
}>;
|
|
223
261
|
/**
|
|
224
262
|
* Set to render an item placeholder when the user scrolls fast.
|
|
225
263
|
* See the `scrollSeekConfiguration` property for more details.
|
|
226
264
|
*/
|
|
227
|
-
ScrollSeekPlaceholder?: ComponentType<GridScrollSeekPlaceholderProps
|
|
265
|
+
ScrollSeekPlaceholder?: ComponentType<GridScrollSeekPlaceholderProps & {
|
|
266
|
+
context?: Context;
|
|
267
|
+
}>;
|
|
228
268
|
}
|
|
229
269
|
export interface GridComputeItemKey {
|
|
230
270
|
(index: number): Key;
|
|
231
271
|
}
|
|
232
|
-
export interface GridItemContent {
|
|
233
|
-
(index: number): ReactNode;
|
|
272
|
+
export interface GridItemContent<C> {
|
|
273
|
+
(index: number, context: C): ReactNode;
|
|
234
274
|
}
|
|
235
275
|
export interface WindowViewportInfo {
|
|
236
276
|
offsetTop: number;
|
|
@@ -35,6 +35,7 @@ export declare const listStateSystem: u.SystemSpec<[u.SystemSpec<[u.SystemSpec<n
|
|
|
35
35
|
firstItemIndex: u.StatefulStream<number>;
|
|
36
36
|
sizes: u.StatefulStream<SizeState>;
|
|
37
37
|
listRefresh: u.Stream<boolean>;
|
|
38
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
38
39
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
39
40
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
40
41
|
}>, u.SystemSpec<[u.SystemSpec<[u.SystemSpec<never[], () => {
|
|
@@ -55,6 +56,7 @@ export declare const listStateSystem: u.SystemSpec<[u.SystemSpec<[u.SystemSpec<n
|
|
|
55
56
|
firstItemIndex: u.StatefulStream<number>;
|
|
56
57
|
sizes: u.StatefulStream<SizeState>;
|
|
57
58
|
listRefresh: u.Stream<boolean>;
|
|
59
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
58
60
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
59
61
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
60
62
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -82,6 +84,7 @@ export declare const listStateSystem: u.SystemSpec<[u.SystemSpec<[u.SystemSpec<n
|
|
|
82
84
|
firstItemIndex: u.StatefulStream<number>;
|
|
83
85
|
sizes: u.StatefulStream<SizeState>;
|
|
84
86
|
listRefresh: u.Stream<boolean>;
|
|
87
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
85
88
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
86
89
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
87
90
|
}, {
|
|
@@ -151,6 +154,7 @@ export declare const listStateSystem: u.SystemSpec<[u.SystemSpec<[u.SystemSpec<n
|
|
|
151
154
|
firstItemIndex: u.StatefulStream<number>;
|
|
152
155
|
sizes: u.StatefulStream<SizeState>;
|
|
153
156
|
listRefresh: u.Stream<boolean>;
|
|
157
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
154
158
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
155
159
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
156
160
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -184,6 +188,7 @@ export declare const listStateSystem: u.SystemSpec<[u.SystemSpec<[u.SystemSpec<n
|
|
|
184
188
|
firstItemIndex: u.StatefulStream<number>;
|
|
185
189
|
sizes: u.StatefulStream<SizeState>;
|
|
186
190
|
listRefresh: u.Stream<boolean>;
|
|
191
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
187
192
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
188
193
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
189
194
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -214,6 +219,7 @@ export declare const listStateSystem: u.SystemSpec<[u.SystemSpec<[u.SystemSpec<n
|
|
|
214
219
|
firstItemIndex: u.StatefulStream<number>;
|
|
215
220
|
sizes: u.StatefulStream<SizeState>;
|
|
216
221
|
listRefresh: u.Stream<boolean>;
|
|
222
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
217
223
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
218
224
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
219
225
|
}, {
|
|
@@ -256,6 +262,7 @@ export declare const listStateSystem: u.SystemSpec<[u.SystemSpec<[u.SystemSpec<n
|
|
|
256
262
|
firstItemIndex: u.StatefulStream<number>;
|
|
257
263
|
sizes: u.StatefulStream<SizeState>;
|
|
258
264
|
listRefresh: u.Stream<boolean>;
|
|
265
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
259
266
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
260
267
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
261
268
|
}, {
|
|
@@ -298,6 +305,7 @@ export declare const listStateSystem: u.SystemSpec<[u.SystemSpec<[u.SystemSpec<n
|
|
|
298
305
|
firstItemIndex: u.StatefulStream<number>;
|
|
299
306
|
sizes: u.StatefulStream<SizeState>;
|
|
300
307
|
listRefresh: u.Stream<boolean>;
|
|
308
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
301
309
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
302
310
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
303
311
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -328,6 +336,7 @@ export declare const listStateSystem: u.SystemSpec<[u.SystemSpec<[u.SystemSpec<n
|
|
|
328
336
|
firstItemIndex: u.StatefulStream<number>;
|
|
329
337
|
sizes: u.StatefulStream<SizeState>;
|
|
330
338
|
listRefresh: u.Stream<boolean>;
|
|
339
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
331
340
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
332
341
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
333
342
|
}, {
|
|
@@ -407,6 +416,7 @@ export declare const listStateSystem: u.SystemSpec<[u.SystemSpec<[u.SystemSpec<n
|
|
|
407
416
|
firstItemIndex: u.StatefulStream<number>;
|
|
408
417
|
sizes: u.StatefulStream<SizeState>;
|
|
409
418
|
listRefresh: u.Stream<boolean>;
|
|
419
|
+
statefulTotalCount: u.StatefulStream<number>;
|
|
410
420
|
trackItemSizes: u.StatefulStream<boolean>;
|
|
411
421
|
itemSize: u.StatefulStream<import("./sizeSystem").SizeFunction>;
|
|
412
422
|
}, {
|