@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
1,133 lines • 111 kB
TypeScript
import React from 'react';
export declare const useActionBarModel: (<TT_Special_Generic>(config?: (Partial<{
/**
* Optional id for the whole `ActionBar` group. If not provided, a unique id will be created.
* @default useUniqueId()
*/
id: string;
/**
* The default ActionBar sub-components only handle rendering of button group in a horizontal orientation,
* but the sub-components could be replaced to handle vertical orientations.
* @default 'horizontal'
*/
orientation: import("@workday/canvas-kit-react/collection").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("@workday/canvas-kit-react/collection").SelectedIds;
initialUnselectedIds: string[];
selection: import("@workday/canvas-kit-react/collection").SelectionManager;
initialCursorId: 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[];
}>;
/**
* The maximum number of actions that can be visible.
* Must be greater than 1 and less than items.length.
* @default 3
*/
maximumVisible: number;
initialHiddenIds: string[];
containerWidth: number;
shouldCalculateOverflow: boolean;
initialSelectedIds: import("@workday/canvas-kit-react/collection").SelectedIds;
initialUnselectedIds: string[];
selection: import("@workday/canvas-kit-react/collection").SelectionManager;
initialCursorId: string;
columnCount: number;
navigation: import("@workday/canvas-kit-react/collection").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("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onSetContainerSize?: ((data: {
width?: number | undefined;
height?: number | undefined;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onSetContainerWidth?: ((data: {
width?: number | undefined;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onSetContainerGap?: ((data: {
size: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onSetOverflowTargetSize?: ((data: {
width: number;
height: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onSetOverflowTargetWidth?: ((data: {
width: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onAddItemWidth?: ((data: {
id: string;
width: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onAddItemSize?: ((data: {
id: string;
width: number;
height: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onRemoveItemSize?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onRemoveItemWidth?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onAddHiddenKey?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onRemoveHiddenKey?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onSelectAll?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onUnselectAll?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onSetSelectedIds?: ((data: string[] | "all", prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").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("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoTo?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoToNext?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoToPrevious?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoToPreviousRow?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoToNextRow?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoToFirst?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoToLast?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoToFirstOfRow?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoToLastOfRow?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoToNextPage?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onGoToPreviousPage?: ((data: undefined, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onRegisterItem?: ((data: {
id: string;
textValue: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onUnregisterItem?: ((data: {
id: string;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
onUpdateItemHeight?: ((data: {
value: number;
}, prevState: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => void) | undefined;
} & {
shouldSelect?: ((data: {
id: string;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => boolean) | undefined;
shouldSetContainerSize?: ((data: {
width?: number | undefined;
height?: number | undefined;
}, state: {
hiddenIds: string[];
nonInteractiveIds: string[];
orientation: import("@workday/canvas-kit-react/collection").Orientation;
itemSizeCache: Record<string, number>;
itemWidthCache: Record<string, number>;
containerSize: number;
containerWidth: number;
containerGap: number;
overflowTargetWidth: number;
selectedIds: string[] | "all";
unselectedIds: string[];
cursorId: string;
columnCount: number;
pageSizeRef: React.MutableRefObject<number>;
cursorIndexRef: {
readonly current: number;
};
UNSTABLE_virtual: {
virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
totalSize: number;
scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
scrollToIndex: (index: number, options?: import("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
measure: () => void;
};
UNSTABLE_defaultItemHeight: number;
containerRef: React.RefObject<HTMLDivElement>;
id: string;
indexRef: React.MutableRefObject<number>;
isVirtualized: boolean;
items: import("@workday/canvas-kit-react/collection").Item<any>[];
}) => boolean) | undefined;
shouldSetContainerWidth?: ((data: {
width?: number | undefined;
}, state: {
hiddenIds: string[