@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
2,428 lines • 84.3 kB
TypeScript
import React from 'react';
import { Item } from './useBaseListModel';
export declare function getHiddenIds(containerSize: number, containerGap: number, overflowTargetSize: number, itemSizeCache: Record<string, number>, selectedIds: string[] | 'all', items: Item<any>[]): string[];
export declare const useOverflowListModel: (<TT_Special_Generic>(config?: (Partial<{
initialHiddenIds: string[];
containerWidth: number;
/**
* Determines if overflow should actually occur. For example, touch devices are better at
* side-scrolling than mouse devices. In these cases, it makes sense to disable overflowing.
* @default true
*/ shouldCalculateOverflow: boolean;
initialSelectedIds: import("./useSelectionListModel").SelectedIds;
initialUnselectedIds: string[];
selection: import("./useSelectionListModel").SelectionManager;
initialCursorId: string | string[];
columnCount: number;
navigation: import("./useCursorListModel").NavigationManager;
pageSize: number;
id: string;
getId: (item: any) => string;
getTextValue: (item: any) => string;
nonInteractiveIds: string[];
orientation: import("./useBaseListModel").Orientation;
defaultItemHeight: number;
shouldVirtualize: boolean;
items: any[];
}> & {
onSelect?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onSetContainerSize?: ((data: {
width?: number | undefined;
height?: number | undefined;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onSetContainerWidth?: ((data: {
width?: number | undefined;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onSetContainerGap?: ((data: {
size: number;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onSetOverflowTargetSize?: ((data: {
width: number;
height: number;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onSetOverflowTargetWidth?: ((data: {
width: number;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onAddItemWidth?: ((data: {
id: string;
width: number;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onAddItemSize?: ((data: {
id: string;
width: number;
height: number;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onRemoveItemSize?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onRemoveItemWidth?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onAddHiddenKey?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onRemoveHiddenKey?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onSelectAll?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onUnselectAll?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onSetSelectedIds?: ((data: string[] | "all", prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onRemove?: ((data: {
id: string;
nextId?: string | undefined;
event?: Event | React.SyntheticEvent<Element, Event> | undefined;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoTo?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoToNext?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoToPrevious?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoToPreviousRow?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoToNextRow?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoToFirst?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoToLast?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoToFirstOfRow?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoToLastOfRow?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoToNextPage?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onGoToPreviousPage?: ((data: undefined, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onRegisterItem?: ((data: {
id: string;
textValue: string;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onUnregisterItem?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
onUpdateItemHeight?: ((data: {
value: number;
}, prevState: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => void) | undefined;
} & {
shouldSelect?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldSetContainerSize?: ((data: {
width?: number | undefined;
height?: number | undefined;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldSetContainerWidth?: ((data: {
width?: number | undefined;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldSetContainerGap?: ((data: {
size: number;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldSetOverflowTargetSize?: ((data: {
width: number;
height: number;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldSetOverflowTargetWidth?: ((data: {
width: number;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldAddItemWidth?: ((data: {
id: string;
width: number;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldAddItemSize?: ((data: {
id: string;
width: number;
height: number;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldRemoveItemSize?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldRemoveItemWidth?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldAddHiddenKey?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldRemoveHiddenKey?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldSelectAll?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldUnselectAll?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldSetSelectedIds?: ((data: string[] | "all", state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldRemove?: ((data: {
id: string;
nextId?: string | undefined;
event?: Event | React.SyntheticEvent<Element, Event> | undefined;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoTo?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoToNext?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoToPrevious?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoToPreviousRow?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoToNextRow?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoToFirst?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoToLast?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoToFirstOfRow?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoToLastOfRow?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoToNextPage?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldGoToPreviousPage?: ((data: undefined, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldRegisterItem?: ((data: {
id: string;
textValue: string;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldUnregisterItem?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
shouldUpdateItemHeight?: ((data: {
value: number;
}, state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}) => boolean) | undefined;
}) | undefined) => {
state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
};
events: {
select(data: {
id: string;
}): void;
setContainerSize(data: {
width?: number;
height?: number;
}): void;
/**
* @deprecated Use `setContainerSize` instead and pass both `width` and `height`
*/
setContainerWidth(data: {
width?: number;
}): void;
setContainerGap(data: {
size: number;
}): void;
setOverflowTargetSize(data: {
width: number;
height: number;
}): void;
/**
*
* @deprecated `setOverflowTargetWidth` is deprecated. Please use `setOverflowTargetSize` and pass in the `width` and set `height` to `0`.
*/
setOverflowTargetWidth(data: {
width: number;
}): void;
/**
*
* @deprecated `addItemWidth` is deprecated. Please use `addItemSize` and set the `width`
*/
addItemWidth(data: {
id: string;
width: number;
}): void;
addItemSize(data: {
id: string;
width: number;
height: number;
}): void;
removeItemSize(data: {
id: string;
}): void;
/**
*
* @deprecated `removeItemWidth` is deprecated. Please use `removeItemSize`.
*/
removeItemWidth(data: {
id: string;
}): void;
addHiddenKey(data: {
id: string;
}): void;
removeHiddenKey(data: {
id: string;
}): void;
selectAll(): void;
unselectAll(): void;
setSelectedIds(ids: string[] | "all"): void;
remove(data: {
id: string;
nextId?: string | undefined;
event?: Event | React.SyntheticEvent<Element, Event> | undefined;
}): void;
goTo(data: {
id: string;
}): void;
goToNext(): void;
goToPrevious(): void;
goToPreviousRow(): void;
goToNextRow(): void;
goToFirst(): void;
goToLast(): void;
goToFirstOfRow(): void;
goToLastOfRow(): void;
goToNextPage(): void;
goToPreviousPage(): void;
registerItem(data: {
id: string;
textValue: string;
}): void;
unregisterItem(data: {
id: string;
}): void;
updateItemHeight(data: {
value: number;
}): void;
};
selection: import("./useSelectionListModel").SelectionManager;
navigation: import("./useCursorListModel").NavigationManager;
getId: (item: any) => string;
getTextValue: (item: any) => string;
}) & import("@workday/canvas-kit-react/common").ModelExtras<{
initialHiddenIds: string[];
containerWidth: number;
/**
* Determines if overflow should actually occur. For example, touch devices are better at
* side-scrolling than mouse devices. In these cases, it makes sense to disable overflowing.
* @default true
*/ shouldCalculateOverflow: boolean;
initialSelectedIds: import("./useSelectionListModel").SelectedIds;
initialUnselectedIds: string[];
selection: import("./useSelectionListModel").SelectionManager;
initialCursorId: string | string[];
columnCount: number;
navigation: import("./useCursorListModel").NavigationManager;
pageSize: number;
id: string;
getId: (item: any) => string;
getTextValue: (item: any) => string;
nonInteractiveIds: string[];
orientation: import("./useBaseListModel").Orientation;
defaultItemHeight: number;
shouldVirtualize: boolean;
items: any[];
}, {}, {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
}, {
select(data: {
id: string;
}): void;
setContainerSize(data: {
width?: number;
height?: number;
}): void;
/**
* @deprecated Use `setContainerSize` instead and pass both `width` and `height`
*/
setContainerWidth(data: {
width?: number;
}): void;
setContainerGap(data: {
size: number;
}): void;
setOverflowTargetSize(data: {
width: number;
height: number;
}): void;
/**
*
* @deprecated `setOverflowTargetWidth` is deprecated. Please use `setOverflowTargetSize` and pass in the `width` and set `height` to `0`.
*/
setOverflowTargetWidth(data: {
width: number;
}): void;
/**
*
* @deprecated `addItemWidth` is deprecated. Please use `addItemSize` and set the `width`
*/
addItemWidth(data: {
id: string;
width: number;
}): void;
addItemSize(data: {
id: string;
width: number;
height: number;
}): void;
removeItemSize(data: {
id: string;
}): void;
/**
*
* @deprecated `removeItemWidth` is deprecated. Please use `removeItemSize`.
*/
removeItemWidth(data: {
id: string;
}): void;
addHiddenKey(data: {
id: string;
}): void;
removeHiddenKey(data: {
id: string;
}): void;
selectAll(): void;
unselectAll(): void;
setSelectedIds(ids: string[] | "all"): void;
remove(data: {
id: string;
nextId?: string | undefined;
event?: Event | React.SyntheticEvent<Element, Event> | undefined;
}): void;
goTo(data: {
id: string;
}): void;
goToNext(): void;
goToPrevious(): void;
goToPreviousRow(): void;
goToNextRow(): void;
goToFirst(): void;
goToLast(): void;
goToFirstOfRow(): void;
goToLastOfRow(): void;
goToNextPage(): void;
goToPreviousPage(): void;
registerItem(data: {
id: string;
textValue: string;
}): void;
unregisterItem(data: {
id: string;
}): void;
updateItemHeight(data: {
value: number;
}): void;
}, {
state: {
hiddenIds: string[];
itemSizeCache: Record<string, number>;
/**
* @deprecated Use `itemSizeCache` instead
*/
itemWidthCache: Record<string, number>;
containerSize: number;
/**
* @deprecated Use `containerSize` instead
*/
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string | string[];
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
orientation: "horizontal" | "vertical";
indexRef: React.MutableRefObject<number>;
nonInteractiveIds: string[];
isVirtualized: boolean;
items: Item<any>[];
};
events: {
select(data: {
id: string;
}): void;
setContainerSize(data: {
width?: number;
height?: number;
}): void;
/**
* @deprecated Use `setContainerSize` instead and pass both `width` and `height`
*/
setContainerWidth(data: {
width?: number;
}): void;
setContainerGap(data: {
size: number;
}): void;
setOverflowTargetSize(data: {
width: number;
height: number;
}): void;
/**
*
* @deprecated `setOverflowTargetWidth` is deprecated. Please use `setOverflowTargetSize` and pass in the `width` and set `height` to `0`.
*/
setOverflowTargetWidth(data: {
width: number;
}): void;
/**
*
* @deprecated `addItemWidth` is deprecated. Please use `addItemSize` and set the `width`
*/
addItemWidth(data: {
id: string;
width: number;
}): void;
addItemSize(data: {
id: string;
width: number;
height: number;
}): void;
removeItemSize(data: {
id: string;
}): void;
/**
*
* @deprecated `removeItemWidth` is deprecated. Please use `removeItemSize`.
*/
removeItemWidth(data: {
id: string;
}): void;
addHiddenKey(data: {
id: string;
}): void;
removeHiddenKey(data: {
id: string;
}): void;
selectAll(): void;
unselectAll(): void;
setSelectedIds(ids: string[] | "all"): void;
remove(data: {
id: string;
nextId?: string | undefined;
event?: Event | React.SyntheticEvent<Element, Event> | undefined;
}): void;
goTo(data: {
id: string;
}): void;
goToNext(): void;
goToPrevious(): void;
goToPreviousRow(): void;
goToNextRow(): void;
goToFirst(): void;
goToLast(): void;
goToFirstOfRow(): void;
goToLastOfRow(): void;
goToNextPage(): void;
goToPreviousPage(): void;
registerItem(data: {
id: string;
textValue: string;
}): void;
unregisterItem(data: {
id: string;
}): void;
updateItemHeight(data: {
value: number;
}): void;
};
selection: import("./useSelectionListModel").SelectionManager;
navigation: import("./useCursorListModel").NavigationManager;
getId: (item: any) => string;
getTextValue: (item: any) => string;
}>;
//# sourceMappingURL=useOverflowListModel.d.ts.map