@workday/canvas-kit-react 7.1.4 → 7.2.0-427-next.2

package/dist/commonjs/collection/lib/useSelectionListModel.d.ts

@@ -5,9 +5,21 @@ export declare type Selection = {
     unselectedIds: string[];
 };
 /**
- * A SelectionManager is used
+ * The list and grid models accept a `selection` config. If one is not provided,
+ * `singleSelectManager` is used. You can provide a custom select manager to suite your needs. A
+ * selection manager is an object with a single `select` method that takes an id and previously
+ * selected ids and returns a new set of selected ids.
+ *
+ * The collection system provides two selection managers: `singleSelectManager` and
+ * `multiSelectionManager`.
  */
 export interface SelectionManager {
+    /**
+     * Sets a new `Selection` state based on the current ID passed and the previous state. Each
+     * selection manager can implement this differently. For example, a single select manager may
+     * unselect all other items and select only the passed in id. A multiselect manager may toggle the
+     * passed id.
+     */
     select(id: string, prevState: Selection): Selection;
 }
 export declare const isSelected: (id: string, { selectedIds, unselectedIds }: Selection) => boolean;
@@ -20,6 +32,7 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     initialCursorId: string;
     columnCount: number;
     navigation: import("./useCursorListModel").NavigationManager;
+    pageSize: number;
     id: string;
     getId: (item: any) => string;
     getTextValue: (item: any) => string;
@@ -32,10 +45,14 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     onSelect?: ((data: {
         id: string;
     }, prevState: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -46,17 +63,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
     onSelectAll?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -67,17 +88,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
     onUnselectAll?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -88,20 +113,23 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onRegisterItem?: ((data: {
-        item: any;
-        textValue: string;
+    onGoTo?: ((data: {
+        id: string;
     }, prevState: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -112,19 +140,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoTo?: ((data: {
-        id: string;
-    }, prevState: {
-        selectedIds: SelectedIds;
+    onGoToNext?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -135,17 +165,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToNext?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+    onGoToPrevious?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -156,17 +190,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToPrevious?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+    onGoToPreviousRow?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -177,17 +215,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToPreviousRow?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+    onGoToNextRow?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -198,17 +240,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToNextRow?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+    onGoToFirst?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -219,17 +265,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToFirst?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+    onGoToLast?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -240,17 +290,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToLast?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+    onGoToFirstOfRow?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -261,17 +315,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToFirstOfRow?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+    onGoToLastOfRow?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -282,17 +340,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToLastOfRow?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+    onGoToNextPage?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -303,17 +365,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToNextPage?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+    onGoToPreviousPage?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -324,17 +390,24 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToPreviousPage?: ((data: undefined, prevState: {
-        selectedIds: SelectedIds;
+    onRegisterItem?: ((data: {
+        item: any;
+        textValue: string;
+    }, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -345,7 +418,7 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -354,10 +427,14 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     onUnregisterItem?: ((data: {
         id: string;
     }, prevState: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -368,7 +445,7 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -377,10 +454,14 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     onUpdateItemHeight?: ((data: {
         value: number;
     }, prevState: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -391,7 +472,7 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -401,10 +482,14 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     shouldSelect?: ((data: {
         id: string;
     }, state: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -415,17 +500,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
     shouldSelectAll?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -436,17 +525,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
     shouldUnselectAll?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -457,20 +550,23 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldRegisterItem?: ((data: {
-        item: any;
-        textValue: string;
+    shouldGoTo?: ((data: {
+        id: string;
     }, state: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -481,19 +577,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoTo?: ((data: {
-        id: string;
-    }, state: {
-        selectedIds: SelectedIds;
+    shouldGoToNext?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -504,17 +602,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToNext?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+    shouldGoToPrevious?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -525,17 +627,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToPrevious?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+    shouldGoToPreviousRow?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -546,17 +652,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToPreviousRow?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+    shouldGoToNextRow?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -567,17 +677,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToNextRow?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+    shouldGoToFirst?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -588,17 +702,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToFirst?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+    shouldGoToLast?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -609,17 +727,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToLast?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+    shouldGoToFirstOfRow?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -630,17 +752,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToFirstOfRow?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+    shouldGoToLastOfRow?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -651,17 +777,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToLastOfRow?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+    shouldGoToNextPage?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -672,17 +802,21 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToNextPage?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+    shouldGoToPreviousPage?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -693,17 +827,24 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToPreviousPage?: ((data: undefined, state: {
-        selectedIds: SelectedIds;
+    shouldRegisterItem?: ((data: {
+        item: any;
+        textValue: string;
+    }, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -714,7 +855,7 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -723,10 +864,14 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     shouldUnregisterItem?: ((data: {
         id: string;
     }, state: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -737,7 +882,7 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -746,10 +891,14 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     shouldUpdateItemHeight?: ((data: {
         value: number;
     }, state: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -760,7 +909,7 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -768,10 +917,14 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     }) => boolean) | undefined;
 }) | undefined) => {
     state: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -782,7 +935,7 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -802,10 +955,6 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
          * Unselect all items.
          */
         unselectAll(): void;
-        registerItem(data: {
-            item: any;
-            textValue: string;
-        }): void;
         goTo(data: {
             id: string;
         }): void;
@@ -819,6 +968,10 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         goToLastOfRow(): void;
         goToNextPage(): void;
         goToPreviousPage(): void;
+        registerItem(data: {
+            item: any;
+            textValue: string;
+        }): void;
         unregisterItem(data: {
             id: string;
         }): void;
@@ -829,13 +982,14 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     selection: SelectionManager;
     navigation: import("./useCursorListModel").NavigationManager;
     getId: (item: any) => string;
-}) & import("../../common").ModelExtras<{
+}) & import("@workday/canvas-kit-react/common").ModelExtras<{
     initialSelectedIds: SelectedIds;
     initialUnselectedIds: string[];
     selection: SelectionManager;
     initialCursorId: string;
     columnCount: number;
     navigation: import("./useCursorListModel").NavigationManager;
+    pageSize: number;
     id: string;
     getId: (item: any) => string;
     getTextValue: (item: any) => string;
@@ -845,10 +999,14 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     shouldVirtualize: boolean;
     items: any[];
 }, {}, {
-    selectedIds: SelectedIds;
+    selectedIds: string[] | "all";
     unselectedIds: string[];
     cursorId: string;
     columnCount: number;
+    pageSizeRef: React.MutableRefObject<number>;
+    cursorIndexRef: {
+        readonly current: number;
+    };
     UNSTABLE_virtual: {
         virtualItems: import("./react-virtual").VirtualItem[];
         totalSize: number;
@@ -859,7 +1017,7 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     UNSTABLE_defaultItemHeight: number;
     containerRef: React.RefObject<HTMLDivElement>;
     id: string;
-    orientation: import("./useBaseListModel").Orientation;
+    orientation: "horizontal" | "vertical";
     indexRef: React.MutableRefObject<number>;
     nonInteractiveIds: string[];
     isVirtualized: boolean;
@@ -878,10 +1036,6 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
      * Unselect all items.
      */
     unselectAll(): void;
-    registerItem(data: {
-        item: any;
-        textValue: string;
-    }): void;
     goTo(data: {
         id: string;
     }): void;
@@ -895,6 +1049,10 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     goToLastOfRow(): void;
     goToNextPage(): void;
     goToPreviousPage(): void;
+    registerItem(data: {
+        item: any;
+        textValue: string;
+    }): void;
     unregisterItem(data: {
         id: string;
     }): void;
@@ -903,10 +1061,14 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
     }): void;
 }, {
     state: {
-        selectedIds: SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: React.MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -917,7 +1079,7 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -937,10 +1099,6 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
          * Unselect all items.
          */
         unselectAll(): void;
-        registerItem(data: {
-            item: any;
-            textValue: string;
-        }): void;
         goTo(data: {
             id: string;
         }): void;
@@ -954,6 +1112,10 @@ export declare const useSelectionListModel: (<TT_Special_Generic>(config?: (Part
         goToLastOfRow(): void;
         goToNextPage(): void;
         goToPreviousPage(): void;
+        registerItem(data: {
+            item: any;
+            textValue: string;
+        }): void;
         unregisterItem(data: {
             id: string;
         }): void;