@workday/canvas-kit-react/dist/es6/menu/lib/useMenuModel.d.ts

The parent module that contains all Workday Canvas Kit React components

export declare const useMenuModel: (<TT_Special_Generic>(config?: (Partial<{
    /** Determines the default selection manager used as well as if the menu closes when an item is selected */
    mode: "multiple" | "single";
    shouldVirtualize: boolean;
    returnFocusRef: import("react").RefObject<any> | undefined;
    initialFocusRef: import("react").RefObject<any> | undefined;
    id: string;
    initialVisibility: import("../..").Visibility;
    initialSelectedIds: import("@workday/canvas-kit-react/collection").SelectedIds;
    initialUnselectedIds: string[];
    selection: import("@workday/canvas-kit-react/collection").SelectionManager;
    initialCursorId: string | string[];
    columnCount: number;
    navigation: import("@workday/canvas-kit-react/collection").NavigationManager;
    pageSize: number;
    getId: (item: any) => string;
    getTextValue: (item: any) => string;
    nonInteractiveIds: string[];
    orientation: import("@workday/canvas-kit-react/collection").Orientation;
    defaultItemHeight: number;
    items: any[];
    UNSTABLE_parentModel: {
        state: {
            selectedIds: string[] | "all";
            unselectedIds: string[];
            cursorId: string | string[];
            columnCount: number;
            pageSizeRef: import("react").MutableRefObject<number>;
            cursorIndexRef: {
                readonly current: number;
            };
            UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
            UNSTABLE_defaultItemHeight: number;
            containerRef: import("react").RefObject<HTMLDivElement>;
            id: string;
            orientation: "horizontal" | "vertical";
            indexRef: import("react").MutableRefObject<number>;
            nonInteractiveIds: string[];
            isVirtualized: boolean;
            items: import("@workday/canvas-kit-react/collection").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 | import("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("@workday/canvas-kit-react/collection").SelectionManager;
        navigation: import("@workday/canvas-kit-react/collection").NavigationManager;
        getId: (item: any) => string;
        getTextValue: (item: any) => string;
    } | undefined;
}> & {
    onUpdatePlacement?: ((data: {
        placement: import("@popperjs/core").Placement;
    }, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onShow?: ((data: Event | import("react").SyntheticEvent<Element, Event> | undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onHide?: ((data: Event | import("react").SyntheticEvent<Element, Event> | undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onSelect?: ((data: {
        id: string;
    }, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onSelectAll?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onUnselectAll?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onSetSelectedIds?: ((data: string[] | "all", prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onRemove?: ((data: {
        id: string;
        nextId?: string | undefined;
        event?: Event | import("react").SyntheticEvent<Element, Event> | undefined;
    }, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoTo?: ((data: {
        id: string;
    }, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoToNext?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoToPrevious?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoToPreviousRow?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoToNextRow?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoToFirst?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoToLast?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoToFirstOfRow?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoToLastOfRow?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoToNextPage?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onGoToPreviousPage?: ((data: undefined, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onRegisterItem?: ((data: {
        id: string;
        textValue: string;
    }, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onUnregisterItem?: ((data: {
        id: string;
    }, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
    onUpdateItemHeight?: ((data: {
        value: number;
    }, prevState: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => void) | undefined;
} & {
    shouldUpdatePlacement?: ((data: {
        placement: import("@popperjs/core").Placement;
    }, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldShow?: ((data: Event | import("react").SyntheticEvent<Element, Event> | undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldHide?: ((data: Event | import("react").SyntheticEvent<Element, Event> | undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldSelect?: ((data: {
        id: string;
    }, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldSelectAll?: ((data: undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldUnselectAll?: ((data: undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldSetSelectedIds?: ((data: string[] | "all", state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldRemove?: ((data: {
        id: string;
        nextId?: string | undefined;
        event?: Event | import("react").SyntheticEvent<Element, Event> | undefined;
    }, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldGoTo?: ((data: {
        id: string;
    }, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldGoToNext?: ((data: undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldGoToPrevious?: ((data: undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldGoToPreviousRow?: ((data: undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldGoToNextRow?: ((data: undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldGoToFirst?: ((data: undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldGoToLast?: ((data: undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnFocusRef: import("react").RefObject<any> | undefined;
        placement: import("@popperjs/core").Placement;
        id: string;
        visibility: "hidden" | "visible";
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string | string[];
        columnCount: number;
        pageSizeRef: import("react").MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
        UNSTABLE_defaultItemHeight: number;
        containerRef: import("react").RefObject<HTMLDivElement>;
        orientation: "horizontal" | "vertical";
        indexRef: import("react").MutableRefObject<number>;
        nonInteractiveIds: string[];
        isVirtualized: boolean;
        items: import("@workday/canvas-kit-react/collection").Item<any>[];
        mode: "multiple" | "single";
    }) => boolean) | undefined;
    shouldGoToFirstOfRow?: ((data: undefined, state: {
        stackRef: import("react").RefObject<HTMLDivElement>;
        targetRef: import("react").RefObject<HTMLButtonElement>;
        initialFocusRef: import("react").RefObject<any> | undefined;
        returnF