react-virtuoso 4.0.4 → 4.0.6

package/dist/index.d.ts

@@ -1,13 +1,4 @@
-/// <reference types="react" />
-
-import { ComponentPropsWithRef } from 'react';
-import { ComponentType } from 'react';
-import { Context } from 'react';
-import { HTMLProps } from 'react';
-import { Key } from 'react';
-import { ReactElement } from 'react';
-import { ReactNode } from 'react';
-import { Ref } from 'react';
+import { default as React_2 } from 'react';
 
 /**
  * Customize the Virtuoso rendering by passing a set of custom components.
@@ -18,63 +9,63 @@ export declare interface Components<Data = unknown, Context = unknown> {
      *
      * The header remains above the top items and does not remain sticky.
      */
-    Header?: ComponentType<{
+    Header?: React_2.ComponentType<{
         context?: Context;
     }>;
     /**
      * Set to render a component at the bottom of the list.
      */
-    Footer?: ComponentType<{
+    Footer?: React_2.ComponentType<{
         context?: Context;
     }>;
     /**
      * Set to customize the item wrapping element. Use only if you would like to render list from elements different than a `div`.
      */
-    Item?: ComponentType<ItemProps<Data> & {
+    Item?: React_2.ComponentType<ItemProps<Data> & {
         context?: Context;
     }>;
     /**
      * Set to customize the group item wrapping element. Use only if you would like to render list from elements different than a `div`.
      */
-    Group?: ComponentType<GroupProps & {
+    Group?: React_2.ComponentType<GroupProps & {
         context?: Context;
     }>;
     /**
      * Set to customize the top list item wrapping element. Use if you would like to render list from elements different than a `div`
      * or you want to set a custom z-index for the sticky position.
      */
-    TopItemList?: ComponentType<TopItemListProps & {
+    TopItemList?: React_2.ComponentType<TopItemListProps & {
         context?: Context;
     }>;
     /**
      * Set to customize the outermost scrollable element. This should not be necessary in general,
      * as the component passes its HTML attribute props to it.
      */
-    Scroller?: ComponentType<ScrollerProps & {
+    Scroller?: React_2.ComponentType<ScrollerProps & {
         context?: Context;
     }>;
     /**
      * Set to customize the items wrapper. Use only if you would like to render list from elements different than a `div`.
      */
-    List?: ComponentType<ListProps & {
+    List?: React_2.ComponentType<ListProps & {
         context?: Context;
     }>;
     /**
      * Set to render a custom UI when the list is empty.
      */
-    EmptyPlaceholder?: ComponentType<{
+    EmptyPlaceholder?: React_2.ComponentType<{
         context?: Context;
     }>;
     /**
      * Set to render an item placeholder when the user scrolls fast.  See the `scrollSeek` property for more details.
      */
-    ScrollSeekPlaceholder?: ComponentType<ScrollSeekPlaceholderProps & {
+    ScrollSeekPlaceholder?: React_2.ComponentType<ScrollSeekPlaceholderProps & {
         context?: Context;
     }>;
 }
 
 export declare interface ComputeItemKey<D, C> {
-    (index: number, item: D, context: C): Key;
+    (index: number, item: D, context: C): React_2.Key;
 }
 
 /**
@@ -84,9 +75,9 @@ export declare interface FillerRowProps {
     height: number;
 }
 
-export declare type FixedFooterContent = (() => ReactNode) | null;
+export declare type FixedFooterContent = (() => React_2.ReactNode) | null;
 
-export declare type FixedHeaderContent = (() => ReactNode) | null;
+export declare type FixedHeaderContent = (() => React_2.ReactNode) | null;
 
 export declare interface FlatIndexLocationWithAlign extends LocationOptions {
     /**
@@ -109,20 +100,20 @@ export declare interface GridComponents<Context = any> {
     /**
      * Set to customize the item wrapping element. Use only if you would like to render list from elements different than a `div`.
      */
-    Item?: ComponentType<GridItemProps & {
+    Item?: React_2.ComponentType<GridItemProps & {
         context?: Context;
     }>;
     /**
      * Set to customize the outermost scrollable element. This should not be necessary in general,
      * as the component passes its HTML attribute props to it.
      */
-    Scroller?: ComponentType<ScrollerProps & {
+    Scroller?: React_2.ComponentType<ScrollerProps & {
         context?: Context;
     }>;
     /**
      * Set to customize the items wrapper. Use only if you would like to render list from elements different than a `div`.
      */
-    List?: ComponentType<GridListProps & {
+    List?: React_2.ComponentType<GridListProps & {
         context?: Context;
     }>;
     /**
@@ -130,26 +121,26 @@ export declare interface GridComponents<Context = any> {
      *
      * The header remains above the top items and does not remain sticky.
      */
-    Header?: ComponentType<{
+    Header?: React_2.ComponentType<{
         context?: Context;
     }>;
     /**
      * Set to render a component at the bottom of the list.
      */
-    Footer?: ComponentType<{
+    Footer?: React_2.ComponentType<{
         context?: Context;
     }>;
     /**
      * Set to render an item placeholder when the user scrolls fast.
      * See the `scrollSeekConfiguration` property for more details.
      */
-    ScrollSeekPlaceholder?: ComponentType<GridScrollSeekPlaceholderProps & {
+    ScrollSeekPlaceholder?: React_2.ComponentType<GridScrollSeekPlaceholderProps & {
         context?: Context;
     }>;
 }
 
 export declare interface GridComputeItemKey<D, C> {
-    (index: number, item: D, context: C): Key;
+    (index: number, item: D, context: C): React_2.Key;
 }
 
 export declare interface GridItem<D> {
@@ -158,7 +149,7 @@ export declare interface GridItem<D> {
 }
 
 export declare interface GridItemContent<D, C> {
-    (index: number, data: D, context: C): ReactNode;
+    (index: number, data: D, context: C): React_2.ReactNode;
 }
 
 export declare interface GridItemProps {
@@ -169,11 +160,11 @@ export declare interface GridItemProps {
 /**
  * Passed to the Components.List custom component
  */
-export declare type GridListProps = Pick<ComponentPropsWithRef<'div'>, 'style' | 'children' | 'ref' | 'className'> & {
+export declare type GridListProps = Pick<React_2.ComponentPropsWithRef<'div'>, 'style' | 'children' | 'ref' | 'className'> & {
     'data-test-id': string;
 };
 
-export declare type GridRootProps = Omit<HTMLProps<HTMLDivElement>, 'ref' | 'data'>;
+export declare type GridRootProps = Omit<React_2.HTMLProps<HTMLDivElement>, 'ref' | 'data'>;
 
 /**
  * Passed to the GridComponents.ScrollSeekPlaceholder custom component
@@ -185,7 +176,7 @@ export declare interface GridScrollSeekPlaceholderProps {
 }
 
 export declare interface GroupContent {
-    (index: number): ReactNode;
+    (index: number): React_2.ReactNode;
 }
 
 export declare interface GroupedScrollIntoViewLocation extends ScrollIntoViewLocationOptions {
@@ -193,8 +184,8 @@ export declare interface GroupedScrollIntoViewLocation extends ScrollIntoViewLoc
 }
 
 export declare const GroupedVirtuoso: <ItemData = any, Context = any>(props: GroupedVirtuosoProps<ItemData, Context> & {
-    ref?: Ref<GroupedVirtuosoHandle> | undefined;
-}) => ReactElement;
+    ref?: React_2.Ref<GroupedVirtuosoHandle> | undefined;
+}) => React_2.ReactElement;
 
 export declare interface GroupedVirtuosoHandle {
     scrollToIndex(location: number | IndexLocationWithAlign): void;
@@ -233,10 +224,10 @@ export declare interface GroupItem<D> extends Item<D> {
 }
 
 export declare interface GroupItemContent<D, C> {
-    (index: number, groupIndex: number, data: D, context: C): ReactNode;
+    (index: number, groupIndex: number, data: D, context: C): React_2.ReactNode;
 }
 
-export declare type GroupProps = Pick<ComponentPropsWithRef<'div'>, 'style' | 'children'> & {
+export declare type GroupProps = Pick<React_2.ComponentPropsWithRef<'div'>, 'style' | 'children'> & {
     'data-index': number;
     'data-item-index': number;
     'data-known-size': number;
@@ -252,10 +243,10 @@ export declare interface Item<D> {
 }
 
 export declare interface ItemContent<D, C> {
-    (index: number, data: D, context: C): ReactNode;
+    (index: number, data: D, context: C): React_2.ReactNode;
 }
 
-export declare type ItemProps<D> = Pick<ComponentPropsWithRef<'div'>, 'style' | 'children'> & {
+export declare type ItemProps<D> = Pick<React_2.ComponentPropsWithRef<'div'>, 'style' | 'children'> & {
     'data-index': number;
     'data-item-index': number;
     'data-item-group-index'?: number;
@@ -268,7 +259,7 @@ export declare type ListItem<D> = RecordItem<D> | GroupItem<D>;
 /**
  * Passed to the Components.List custom component
  */
-export declare type ListProps = Pick<ComponentPropsWithRef<'div'>, 'style' | 'children' | 'ref'> & {
+export declare type ListProps = Pick<React_2.ComponentPropsWithRef<'div'>, 'style' | 'children' | 'ref'> & {
     'data-test-id': string;
 };
 
@@ -277,7 +268,7 @@ export declare interface ListRange {
     endIndex: number;
 }
 
-export declare type ListRootProps = Omit<HTMLProps<HTMLDivElement>, 'ref' | 'data'>;
+export declare type ListRootProps = Omit<React_2.HTMLProps<HTMLDivElement>, 'ref' | 'data'>;
 
 export declare interface LocationOptions {
     /**
@@ -317,7 +308,7 @@ export declare interface ScrollContainerState {
 /**
  * Passed to the Components.Scroller custom component
  */
-export declare type ScrollerProps = Pick<ComponentPropsWithRef<'div'>, 'style' | 'children' | 'tabIndex' | 'ref'> & {
+export declare type ScrollerProps = Pick<React_2.ComponentPropsWithRef<'div'>, 'style' | 'children' | 'tabIndex' | 'ref'> & {
     'data-test-id'?: string;
     'data-virtuoso-scroller'?: boolean;
 };
@@ -365,7 +356,7 @@ export declare type SizeFunction = (el: HTMLElement, field: 'offsetHeight' | 'of
 /**
  * Passed to the Components.TableBody custom component
  */
-export declare type TableBodyProps = Pick<ComponentPropsWithRef<'tbody'>, 'style' | 'children' | 'ref' | 'className'> & {
+export declare type TableBodyProps = Pick<React_2.ComponentPropsWithRef<'tbody'>, 'style' | 'children' | 'ref' | 'className'> & {
     'data-test-id': string;
 };
 
@@ -377,68 +368,68 @@ export declare interface TableComponents<Data = unknown, Context = unknown> {
      * Set to customize the wrapping `table` element.
      *
      */
-    Table?: ComponentType<TableProps & {
+    Table?: React_2.ComponentType<TableProps & {
         context?: Context;
     }>;
     /**
      * Set to render a fixed header at the top of the table (`thead`). use [[fixedHeaderHeight]] to set the contents
      *
      */
-    TableHead?: ComponentType<Pick<ComponentPropsWithRef<'thead'>, 'style' | 'ref'> & {
+    TableHead?: React_2.ComponentType<Pick<React_2.ComponentPropsWithRef<'thead'>, 'style' | 'ref'> & {
         context?: Context;
     }>;
     /**
      * Set to render a fixed footer at the bottom of the table (`tfoot`). use [[fixedFooterContent]] to set the contents
      */
-    TableFoot?: ComponentType<Pick<ComponentPropsWithRef<'tfoot'>, 'style' | 'ref'> & {
+    TableFoot?: React_2.ComponentType<Pick<React_2.ComponentPropsWithRef<'tfoot'>, 'style' | 'ref'> & {
         context?: Context;
     }>;
     /**
      * Set to customize the item wrapping element. Default is `tr`.
      */
-    TableRow?: ComponentType<ItemProps<Data> & {
+    TableRow?: React_2.ComponentType<ItemProps<Data> & {
         context?: Context;
     }>;
     /**
      * Set to customize the outermost scrollable element. This should not be necessary in general,
      * as the component passes its HTML attribute props to it.
      */
-    Scroller?: ComponentType<ScrollerProps & {
+    Scroller?: React_2.ComponentType<ScrollerProps & {
         context?: Context;
     }>;
     /**
      * Set to customize the items wrapper. Default is `tbody`.
      */
-    TableBody?: ComponentType<TableBodyProps & {
+    TableBody?: React_2.ComponentType<TableBodyProps & {
         context?: Context;
     }>;
     /**
      * Set to render a custom UI when the list is empty.
      */
-    EmptyPlaceholder?: ComponentType<{
+    EmptyPlaceholder?: React_2.ComponentType<{
         context?: Context;
     }>;
     /**
      * Set to render an item placeholder when the user scrolls fast.  See the `scrollSeek` property for more details.
      */
-    ScrollSeekPlaceholder?: ComponentType<ScrollSeekPlaceholderProps & {
+    ScrollSeekPlaceholder?: React_2.ComponentType<ScrollSeekPlaceholderProps & {
         context?: Context;
     }>;
     /**
      * Set to render an empty item placeholder.
      */
-    FillerRow?: ComponentType<FillerRowProps & {
+    FillerRow?: React_2.ComponentType<FillerRowProps & {
         context?: Context;
     }>;
 }
 
-export declare type TableProps = Pick<ComponentPropsWithRef<'table'>, 'style' | 'children'>;
+export declare type TableProps = Pick<React_2.ComponentPropsWithRef<'table'>, 'style' | 'children'>;
 
-export declare type TableRootProps = Omit<HTMLProps<HTMLTableElement>, 'ref' | 'data'>;
+export declare type TableRootProps = Omit<React_2.HTMLProps<HTMLTableElement>, 'ref' | 'data'>;
 
 export declare const TableVirtuoso: <ItemData = any, Context = any>(props: TableVirtuosoProps<ItemData, Context> & {
-    ref?: Ref<TableVirtuosoHandle> | undefined;
-}) => ReactElement;
+    ref?: React_2.Ref<TableVirtuosoHandle> | undefined;
+}) => React_2.ReactElement;
 
 export declare interface TableVirtuosoHandle {
     scrollIntoView(location: number | FlatScrollIntoViewLocation): void;
@@ -456,6 +447,10 @@ export declare interface TableVirtuosoProps<D, C> extends Omit<VirtuosoProps<D,
      * Set the contents of the table header.
      */
     fixedHeaderContent?: FixedHeaderContent;
+    /**
+     * Set the contents of the table footer.
+     */
+    fixedFooterContent?: FixedFooterContent;
     /**
      * The total amount of items to be rendered.
      */
@@ -620,15 +615,15 @@ export declare interface TableVirtuosoProps<D, C> extends Omit<VirtuosoProps<D,
     atBottomThreshold?: number;
 }
 
-export declare type TopItemListProps = Pick<ComponentPropsWithRef<'div'>, 'style' | 'children'>;
+export declare type TopItemListProps = Pick<React_2.ComponentPropsWithRef<'div'>, 'style' | 'children'>;
 
 export declare const Virtuoso: <ItemData = any, Context = any>(props: VirtuosoProps<ItemData, Context> & {
-    ref?: Ref<VirtuosoHandle> | undefined;
-}) => ReactElement;
+    ref?: React_2.Ref<VirtuosoHandle> | undefined;
+}) => React_2.ReactElement;
 
-export declare const VirtuosoGrid: <Context = any>(props: VirtuosoGridProps<Context, unknown> & {
-    ref?: Ref<VirtuosoGridHandle> | undefined;
-}) => ReactElement;
+export declare const VirtuosoGrid: <ItemData = any, Context = any>(props: VirtuosoGridProps<ItemData, Context> & {
+    ref?: React_2.Ref<VirtuosoGridHandle> | undefined;
+}) => React_2.ReactElement;
 
 export declare interface VirtuosoGridHandle {
     scrollToIndex(location: number | IndexLocationWithAlign): void;
@@ -636,7 +631,7 @@ export declare interface VirtuosoGridHandle {
     scrollBy(location: ScrollToOptions): void;
 }
 
-export declare const VirtuosoGridMockContext: Context<VirtuosoGridMockContextValue | undefined>;
+export declare const VirtuosoGridMockContext: React_2.Context<VirtuosoGridMockContextValue | undefined>;
 
 export declare interface VirtuosoGridMockContextValue {
     viewportHeight: number;
@@ -654,6 +649,10 @@ export declare interface VirtuosoGridProps<D, C = unknown> extends GridRootProps
      * The data items to be rendered. If data is set, the total count will be inferred from the length of the array.
      */
     data?: readonly D[];
+    /**
+     * Additional context available in the custom components and content callbacks
+     */
+    context?: C;
     /**
      * Use for server-side rendering - if set, the list will render the specified amount of items
      * regardless of the container / item size.
@@ -757,7 +756,7 @@ export declare interface VirtuosoHandle {
     autoscrollToBottom(): void;
 }
 
-export declare const VirtuosoMockContext: Context<VirtuosoMockContextValue | undefined>;
+export declare const VirtuosoMockContext: React_2.Context<VirtuosoMockContextValue | undefined>;
 
 export declare interface VirtuosoMockContextValue {
     viewportHeight: number;