@workday/canvas-kit-react/dist/commonjs/breadcrumbs/lib/Breadcrumbs.d.ts

The parent module that contains all Workday Canvas Kit React components

import * as React from 'react';
import { CSProps } from '@workday/canvas-kit-styling';
export interface BreadcrumbsProps extends CSProps {
    /**
     * 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
 * <Breadcrumbs aria-label="Breadcrumbs">
 *   <Breadcrumbs.List>
 *     <Breadcrumbs.Item>
 *       <Breadcrumbs.Link href="/docs">Docs</Breadcrumbs.Link>
 *     <Breadcrumbs.Item>
 *     <Breadcrumbs.Item>
 *       <Breadcrumbs.Link href="/docs/components">Components</Breadcrumbs.Link>
 *     <Breadcrumbs.Item>
 *     <Breadcrumbs.CurrentItem>
 *       <Breadcrumbs.Link href="/docs/components/breadcrumbs">Breadcrumbs</Breadcrumbs.Link>
 *     <Breadcrumbs.CurrentItem>
 *   <Breadcrumbs.List>
 * </Breadcrumbs>
 * ```
 *
 * You may pass {@link BreadcrumbsModelConfig} directly to the `Breadcrumbs` component.
 *
 * ```tsx
 * <Breadcrumbs items={[]} aria-label="Breadcrumbs">
 *   {Child components}
 * </Breadcrumbs>
 * ```
 *
 * Alternatively, you may pass in a model using the hoisted model pattern.
 *
 * ```tsx
 * const model = useBreadcrumbsModel({
 *   items: [],
 * });
 *
 * <Breadcrumbs model={model} aria-label="Breadcrumbs">
 *   {Child components}
 * </Breadcrumbs>;
 * ```
 *
 * 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<any> | undefined;
        initialFocusRef: React.RefObject<any> | undefined;
        id: string;
        initialVisibility: import("../..").Visibility;
        initialSelectedIds: import("../..").SelectedIds;
        initialUnselectedIds: string[];
        selection: import("../..").SelectionManager;
        initialCursorId: string | string[];
        columnCount: number;
        navigation: import("../..").NavigationManager;
        pageSize: number;
        getId: (item: any) => string;
        getTextValue: (item: any) => string;
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        defaultItemHeight: number;
        items: any[];
        UNSTABLE_parentModel: {
            state: {
                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: import("../..").Item<any>[];
            };
            events: {
                select(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("../..").SelectionManager;
            navigation: import("../..").NavigationManager;
            getId: (item: any) => string;
            getTextValue: (item: any) => string;
        } | undefined;
    }>;
    initialHiddenIds: string[];
    containerWidth: number;
    shouldCalculateOverflow: boolean;
    initialSelectedIds: import("../..").SelectedIds;
    initialUnselectedIds: string[];
    selection: import("../..").SelectionManager;
    initialCursorId: string | 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<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onSetContainerSize?: ((data: {
        width?: number | undefined;
        height?: number | undefined;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onSetContainerWidth?: ((data: {
        width?: number | undefined;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onSetContainerGap?: ((data: {
        size: number;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onSetOverflowTargetSize?: ((data: {
        width: number;
        height: number;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onSetOverflowTargetWidth?: ((data: {
        width: number;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onAddItemWidth?: ((data: {
        id: string;
        width: number;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onAddItemSize?: ((data: {
        id: string;
        width: number;
        height: number;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onRemoveItemSize?: ((data: {
        id: string;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onRemoveItemWidth?: ((data: {
        id: string;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onAddHiddenKey?: ((data: {
        id: string;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onRemoveHiddenKey?: ((data: {
        id: string;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onSelectAll?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onUnselectAll?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onSetSelectedIds?: ((data: string[] | "all", prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onRemove?: ((data: {
        id: string;
        nextId?: string | undefined;
        event?: Event | React.SyntheticEvent<Element, Event> | undefined;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoTo?: ((data: {
        id: string;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoToNext?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoToPrevious?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoToPreviousRow?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoToNextRow?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoToFirst?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoToLast?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoToFirstOfRow?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoToLastOfRow?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoToNextPage?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onGoToPreviousPage?: ((data: undefined, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onRegisterItem?: ((data: {
        id: string;
        textValue: string;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onUnregisterItem?: ((data: {
        id: string;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
    onUpdateItemHeight?: ((data: {
        value: number;
    }, prevState: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => void) | undefined;
} & {
    shouldSelect?: ((data: {
        id: string;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldSetContainerSize?: ((data: {
        width?: number | undefined;
        height?: number | undefined;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldSetContainerWidth?: ((data: {
        width?: number | undefined;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldSetContainerGap?: ((data: {
        size: number;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldSetOverflowTargetSize?: ((data: {
        width: number;
        height: number;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldSetOverflowTargetWidth?: ((data: {
        width: number;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldAddItemWidth?: ((data: {
        id: string;
        width: number;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldAddItemSize?: ((data: {
        id: string;
        width: number;
        height: number;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldRemoveItemSize?: ((data: {
        id: string;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldRemoveItemWidth?: ((data: {
        id: string;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldAddHiddenKey?: ((data: {
        id: string;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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;
        indexRef: React.MutableRefObject<number>;
        isVirtualized: boolean;
        items: import("../..").Item<any>[];
    }) => boolean) | undefined;
    shouldRemoveHiddenKey?: ((data: {
        id: string;
    }, state: {
        hiddenIds: string[];
        nonInteractiveIds: string[];
        orientation: import("../..").Orientation;
        itemSizeCache: Record<string, number>;
        itemWidthCache: Record<string, number>;
        containerSize: number;
        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/vi