import * as React from 'react';
export interface BreadcrumbsProps {
/**
* The accessibility label for the nav element.
* It's required to be provided by a11y guidance.
*
*/
'aria-label': string;
/**
* The contents of the Breadcrumbs. Can be `Breadcrumbs` children or any valid elements.
*/
children: React.ReactNode;
}
/**
* `Breadcrumbs` is a container component that is responsible for creating a
* {@link BreadcrumbsModel} and sharing it with its subcomponents using React context. It also
* renders `nav` element, and `aria-label` attribute must be provided for this element.
*
* ```tsx
*
*
*
* Docs
*
*
* Components
*
*
* Breadcrumbs
*
*
*
* ```
*
* You may pass {@link BreadcrumbsModelConfig} directly to the `Breadcrumbs` component.
*
* ```tsx
*
* {Child components}
*
* ```
*
* Alternatively, you may pass in a model using the hoisted model pattern.
*
* ```tsx
* const model = useBreadcrumbsModel({
* items: [],
* });
*
*
* {Child components}
* ;
* ```
*
* Note that if you pass in a `model` configured with {@link useBreadcrumbsModel}, configuration
* props passed to `Breadcrumbs` will be ignored. `aria-label` attribute must be provided for `nav`
* element.
*/
export declare const Breadcrumbs: import("@workday/canvas-kit-react/common").ElementComponentM<"nav", BreadcrumbsProps & Partial<{
id: string;
orientation: import("../..").Orientation;
menuConfig: Partial<{
mode: "multiple" | "single";
shouldVirtualize: boolean;
returnFocusRef: React.RefObject | undefined;
initialFocusRef: React.RefObject | undefined;
id: string;
initialVisibility: import("../..").Visibility;
initialSelectedIds: import("../..").SelectedIds;
initialUnselectedIds: string[];
selection: import("../..").SelectionManager;
initialCursorId: string;
columnCount: number;
navigation: import("../..").NavigationManager;
pageSize: number;
getId: (item: any) => string;
getTextValue: (item: any) => string;
nonInteractiveIds: string[];
orientation: import("../..").Orientation; /**
* The last element in the list of `Breadcrumbs.Item`s. By default, this item is truncated with
* a tooltip at `350px`, But that can be customized with the `maxWidth` prop.
*
* ```tsx
*
* Current Item Text
*
* ```
*/
defaultItemHeight: number;
items: any[];
}>;
initialHiddenIds: string[];
containerWidth: number;
shouldCalculateOverflow: boolean;
initialSelectedIds: import("../..").SelectedIds;
initialUnselectedIds: string[];
selection: import("../..").SelectionManager;
initialCursorId: string;
columnCount: number;
navigation: import("../..").NavigationManager;
pageSize: number;
getId: (item: any) => string;
getTextValue: (item: any) => string;
nonInteractiveIds: string[];
defaultItemHeight: number;
shouldVirtualize: boolean;
items: any[];
}> & {
onSelect?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onSetContainerSize?: ((data: {
width?: number | undefined;
height?: number | undefined;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onSetContainerWidth?: ((data: {
width?: number | undefined;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onSetContainerGap?: ((data: {
size: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onSetOverflowTargetSize?: ((data: {
width: number;
height: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onSetOverflowTargetWidth?: ((data: {
width: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onAddItemWidth?: ((data: {
id: string;
width: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onAddItemSize?: ((data: {
id: string;
width: number;
height: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onRemoveItemSize?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onRemoveItemWidth?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onAddHiddenKey?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onRemoveHiddenKey?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onSelectAll?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onUnselectAll?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onSetSelectedIds?: ((data: string[] | "all", prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onRemove?: ((data: {
id: string;
nextId?: string | undefined;
event?: Event | React.SyntheticEvent | undefined;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoTo?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoToNext?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoToPrevious?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoToPreviousRow?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoToNextRow?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoToFirst?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoToLast?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoToFirstOfRow?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoToLastOfRow?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoToNextPage?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onGoToPreviousPage?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onRegisterItem?: ((data: {
id: string;
textValue: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onUnregisterItem?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
onUpdateItemHeight?: ((data: {
value: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => void) | undefined;
} & {
shouldSelect?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldSetContainerSize?: ((data: {
width?: number | undefined;
height?: number | undefined;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldSetContainerWidth?: ((data: {
width?: number | undefined;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldSetContainerGap?: ((data: {
size: number;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldSetOverflowTargetSize?: ((data: {
width: number;
height: number;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldSetOverflowTargetWidth?: ((data: {
width: number;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldAddItemWidth?: ((data: {
id: string;
width: number;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldAddItemSize?: ((data: {
id: string;
width: number;
height: number;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldRemoveItemSize?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldRemoveItemWidth?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldAddHiddenKey?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject;
isVirtualized: boolean;
items: import("../..").Item[];
}) => boolean) | undefined;
shouldRemoveHiddenKey?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("../..").Orientation;
itemSizeCache: Record;
itemWidthCache: Record;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("../..").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("../..").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject;
id: string;
indexRef: React.MutableRefObject