react-virtuoso 2.4.1 → 2.6.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.
- package/README.md +7 -1
- package/dist/Grid.d.ts +10 -1
- package/dist/List.d.ts +154 -4
- package/dist/Table.d.ts +5729 -0
- package/dist/alignToBottomSystem.d.ts +12 -0
- package/dist/components.d.ts +5626 -1
- package/dist/followOutputSystem.d.ts +8 -0
- package/dist/gridSystem.d.ts +6 -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 +14 -0
- package/dist/initialScrollTopSystem.d.ts +12 -0
- package/dist/initialTopMostItemIndexSystem.d.ts +4 -0
- package/dist/interfaces.d.ts +40 -0
- package/dist/listStateSystem.d.ts +12 -0
- package/dist/listSystem.d.ts +134 -1
- package/dist/scrollIntoViewSystem.d.ts +16 -0
- package/dist/scrollToIndexSystem.d.ts +2 -0
- package/dist/sizeRangeSystem.d.ts +1 -0
- package/dist/sizeSystem.d.ts +1 -0
- package/dist/topItemCountSystem.d.ts +12 -0
- package/dist/totalListHeightSystem.d.ts +12 -0
- package/dist/upwardScrollFixSystem.d.ts +14 -0
- package/dist/windowScrollerSystem.d.ts +1 -0
- package/package.json +1 -2
package/README.md
CHANGED
|
@@ -2,12 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
[](//badge.fury.io/js/react-virtuoso)
|
|
4
4
|
|
|
5
|
-
**React Virtuoso** is the most powerful React virtual list component, full stop. Here's why:
|
|
5
|
+
**React Virtuoso** is the most powerful React virtual list/table component, full stop. Here's why:
|
|
6
6
|
|
|
7
7
|
- Variable sized items out of the box; no manual measurements or hard-coding item heights is necessary;
|
|
8
8
|
- Support for [reverse (bottom up) scrolling and prepending items](//virtuoso.dev/prepend-items/) (chat, feeds, etc);
|
|
9
9
|
- [Grouped mode with sticky headers](//virtuoso.dev/grouped-by-first-letter/);
|
|
10
10
|
- [Responsive grid layout](//virtuoso.dev/grid-responsive-columns/);
|
|
11
|
+
- [Table Support](//virtuoso.dev/hello-table/);
|
|
11
12
|
- [Automatic handling of content resize](//virtuoso.dev/auto-resizing/);
|
|
12
13
|
- [Custom Header, Footer, and empty list components](//virtuoso.dev/customize-structure/);
|
|
13
14
|
- [Pinned top items](//virtuoso.dev/top-items/);
|
|
@@ -57,6 +58,11 @@ The `GroupedVirtuoso` component is a variant of the "flat" `Virtuoso`, with the
|
|
|
57
58
|
The `VirtuosoGrid` component displays **same sized items** in multiple columns.
|
|
58
59
|
The layout and item sizing is controlled through CSS class properties, which allows you to use media queries, min-width, percentage, etc.
|
|
59
60
|
|
|
61
|
+
## [Table](//virtuoso.dev/hello-table/)
|
|
62
|
+
|
|
63
|
+
The `TableVirtuoso` component works just like `Virtuoso`, but with HTML tables.
|
|
64
|
+
It supports window scrolling, sticky headers, sticky columns, and works with React Table and MUI Table.
|
|
65
|
+
|
|
60
66
|
## Works With Your UI Library of Choice
|
|
61
67
|
|
|
62
68
|
You can customize the markup up to your requirements - check [the Material UI list demo](//virtuoso.dev/material-ui-endless-scrolling/).
|
package/dist/Grid.d.ts
CHANGED
|
@@ -12,6 +12,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
|
|
|
12
12
|
overscan?: import("./sizeRangeSystem").Overscan | undefined;
|
|
13
13
|
scrollSeekConfiguration?: false | import("./interfaces").ScrollSeekConfiguration | undefined;
|
|
14
14
|
useWindowScroll?: boolean | undefined;
|
|
15
|
+
customScrollParent?: HTMLElement | undefined;
|
|
15
16
|
totalCount?: number | undefined;
|
|
16
17
|
initialItemCount?: number | undefined;
|
|
17
18
|
scrollSeek?: any;
|
|
@@ -56,6 +57,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
|
|
|
56
57
|
listBoundary: u.Stream<import("./sizeRangeSystem").NumberTuple>;
|
|
57
58
|
overscan: u.StatefulStream<import("./sizeRangeSystem").Overscan>;
|
|
58
59
|
topListHeight: u.StatefulStream<number>;
|
|
60
|
+
fixedHeaderHeight: u.StatefulStream<number>;
|
|
59
61
|
increaseViewportBy: u.StatefulStream<import("./sizeRangeSystem").ViewportIncrease>;
|
|
60
62
|
visibleRange: u.StatefulStream<import("./sizeRangeSystem").NumberTuple>;
|
|
61
63
|
}>, u.SystemSpec<never[], () => {
|
|
@@ -198,13 +200,15 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
|
|
|
198
200
|
scrollingInProgress: u.StatefulStream<boolean>;
|
|
199
201
|
}]) => {
|
|
200
202
|
useWindowScroll: u.StatefulStream<boolean>;
|
|
203
|
+
customScrollParent: u.StatefulStream<HTMLElement | undefined>;
|
|
201
204
|
windowScrollContainerState: u.Stream<[number, number]>;
|
|
202
205
|
windowViewportRect: u.Stream<import("./interfaces").WindowViewportInfo>;
|
|
203
206
|
windowScrollTo: u.Stream<ScrollToOptions>;
|
|
204
|
-
}>], ([{ overscan, visibleRange, listBoundary }, { scrollTop, viewportHeight, scrollBy, scrollTo, smoothScrollTargetReached, scrollContainerState }, stateFlags, scrollSeek, { propsReady, didMount }, { windowViewportRect, windowScrollTo, useWindowScroll, windowScrollContainerState },]: [{
|
|
207
|
+
}>], ([{ overscan, visibleRange, listBoundary }, { scrollTop, viewportHeight, scrollBy, scrollTo, smoothScrollTargetReached, scrollContainerState }, stateFlags, scrollSeek, { propsReady, didMount }, { windowViewportRect, windowScrollTo, useWindowScroll, customScrollParent, windowScrollContainerState },]: [{
|
|
205
208
|
listBoundary: u.Stream<import("./sizeRangeSystem").NumberTuple>;
|
|
206
209
|
overscan: u.StatefulStream<import("./sizeRangeSystem").Overscan>;
|
|
207
210
|
topListHeight: u.StatefulStream<number>;
|
|
211
|
+
fixedHeaderHeight: u.StatefulStream<number>;
|
|
208
212
|
increaseViewportBy: u.StatefulStream<import("./sizeRangeSystem").ViewportIncrease>;
|
|
209
213
|
visibleRange: u.StatefulStream<import("./sizeRangeSystem").NumberTuple>;
|
|
210
214
|
}, {
|
|
@@ -241,6 +245,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
|
|
|
241
245
|
didMount: u.Stream<boolean>;
|
|
242
246
|
}, {
|
|
243
247
|
useWindowScroll: u.StatefulStream<boolean>;
|
|
248
|
+
customScrollParent: u.StatefulStream<HTMLElement | undefined>;
|
|
244
249
|
windowScrollContainerState: u.Stream<[number, number]>;
|
|
245
250
|
windowViewportRect: u.Stream<import("./interfaces").WindowViewportInfo>;
|
|
246
251
|
windowScrollTo: u.Stream<ScrollToOptions>;
|
|
@@ -277,6 +282,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
|
|
|
277
282
|
windowViewportRect: u.Stream<import("./interfaces").WindowViewportInfo>;
|
|
278
283
|
windowScrollTo: u.Stream<ScrollToOptions>;
|
|
279
284
|
useWindowScroll: u.StatefulStream<boolean>;
|
|
285
|
+
customScrollParent: u.StatefulStream<HTMLElement | undefined>;
|
|
280
286
|
windowScrollContainerState: u.Stream<[number, number]>;
|
|
281
287
|
deviation: u.StatefulStream<number>;
|
|
282
288
|
scrollContainerState: u.Stream<[number, number]>;
|
|
@@ -325,6 +331,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
|
|
|
325
331
|
windowViewportRect: u.Stream<import("./interfaces").WindowViewportInfo>;
|
|
326
332
|
windowScrollTo: u.Stream<ScrollToOptions>;
|
|
327
333
|
useWindowScroll: u.StatefulStream<boolean>;
|
|
334
|
+
customScrollParent: u.StatefulStream<HTMLElement | undefined>;
|
|
328
335
|
windowScrollContainerState: u.Stream<[number, number]>;
|
|
329
336
|
deviation: u.StatefulStream<number>;
|
|
330
337
|
scrollContainerState: u.Stream<[number, number]>;
|
|
@@ -389,6 +396,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
|
|
|
389
396
|
windowViewportRect: u.Stream<import("./interfaces").WindowViewportInfo>;
|
|
390
397
|
windowScrollTo: u.Stream<ScrollToOptions>;
|
|
391
398
|
useWindowScroll: u.StatefulStream<boolean>;
|
|
399
|
+
customScrollParent: u.StatefulStream<HTMLElement | undefined>;
|
|
392
400
|
windowScrollContainerState: u.Stream<[number, number]>;
|
|
393
401
|
deviation: u.StatefulStream<number>;
|
|
394
402
|
scrollContainerState: u.Stream<[number, number]>;
|
|
@@ -405,6 +413,7 @@ declare const Grid: React.ForwardRefExoticComponent<{} & {
|
|
|
405
413
|
listClassName: "listClassName";
|
|
406
414
|
itemClassName: "itemClassName";
|
|
407
415
|
useWindowScroll: "useWindowScroll";
|
|
416
|
+
customScrollParent: "customScrollParent";
|
|
408
417
|
scrollerRef: "scrollerRef";
|
|
409
418
|
item: "item";
|
|
410
419
|
ItemContainer: "ItemContainer";
|