@workday/canvas-kit-react 8.0.0-alpha.253-next.22 → 8.0.0-alpha.428-next.2

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

@@ -1,3 +1,7 @@
+/**
+ * The Grid model extends the `ListModel` and changes some config. For example, the `columnCount` is
+ * required on the grid model's configuration and `orientation` is removed.
+ */
 export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     /**
      * Controls the state changes when the user sends navigation events to the model. For example,
@@ -14,6 +18,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     initialUnselectedIds: string[];
     selection: import("./useSelectionListModel").SelectionManager;
     initialCursorId: string;
+    pageSize: number;
     id: string;
     getId: (item: any) => string;
     getTextValue: (item: any) => string;
@@ -30,10 +35,14 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     onSelect?: ((data: {
         id: string;
     }, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -44,17 +53,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
     onSelectAll?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -65,17 +78,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
     onUnselectAll?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -86,20 +103,23 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("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: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -110,19 +130,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoTo?: ((data: {
-        id: string;
-    }, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onGoToNext?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -133,17 +155,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToNext?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onGoToPrevious?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -154,17 +180,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToPrevious?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onGoToPreviousRow?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -175,17 +205,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToPreviousRow?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onGoToNextRow?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -196,17 +230,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToNextRow?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onGoToFirst?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -217,17 +255,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToFirst?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onGoToLast?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -238,17 +280,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToLast?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onGoToFirstOfRow?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -259,17 +305,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToFirstOfRow?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onGoToLastOfRow?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -280,17 +330,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToLastOfRow?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onGoToNextPage?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -301,17 +355,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToNextPage?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onGoToPreviousPage?: ((data: undefined, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -322,17 +380,24 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => void) | undefined;
-    onGoToPreviousPage?: ((data: undefined, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    onRegisterItem?: ((data: {
+        item: any;
+        textValue: string;
+    }, prevState: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -343,7 +408,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -352,10 +417,14 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     onUnregisterItem?: ((data: {
         id: string;
     }, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -366,7 +435,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -375,10 +444,14 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     onUpdateItemHeight?: ((data: {
         value: number;
     }, prevState: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -389,7 +462,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -399,10 +472,14 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     shouldSelect?: ((data: {
         id: string;
     }, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -413,17 +490,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
     shouldSelectAll?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -434,17 +515,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
     shouldUnselectAll?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -455,20 +540,23 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("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: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -479,19 +567,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoTo?: ((data: {
-        id: string;
-    }, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldGoToNext?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -502,17 +592,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToNext?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldGoToPrevious?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -523,17 +617,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToPrevious?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldGoToPreviousRow?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -544,17 +642,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToPreviousRow?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldGoToNextRow?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -565,17 +667,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToNextRow?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldGoToFirst?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -586,17 +692,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToFirst?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldGoToLast?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -607,17 +717,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToLast?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldGoToFirstOfRow?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -628,17 +742,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToFirstOfRow?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldGoToLastOfRow?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -649,17 +767,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToLastOfRow?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldGoToNextPage?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -670,17 +792,21 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToNextPage?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldGoToPreviousPage?: ((data: undefined, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -691,17 +817,24 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
         items: import("./useBaseListModel").Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToPreviousPage?: ((data: undefined, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+    shouldRegisterItem?: ((data: {
+        item: any;
+        textValue: string;
+    }, state: {
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -712,7 +845,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -721,10 +854,14 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     shouldUnregisterItem?: ((data: {
         id: string;
     }, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -735,7 +872,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -744,10 +881,14 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     shouldUpdateItemHeight?: ((data: {
         value: number;
     }, state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -758,7 +899,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -766,10 +907,14 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     }) => boolean) | undefined;
 }) | undefined) => {
     state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -780,7 +925,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -792,10 +937,6 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         }): void;
         selectAll(): void;
         unselectAll(): void;
-        registerItem(data: {
-            item: any;
-            textValue: string;
-        }): void;
         goTo(data: {
             id: string;
         }): void;
@@ -809,6 +950,10 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         goToLastOfRow(): void;
         goToNextPage(): void;
         goToPreviousPage(): void;
+        registerItem(data: {
+            item: any;
+            textValue: string;
+        }): void;
         unregisterItem(data: {
             id: string;
         }): void;
@@ -819,7 +964,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     selection: import("./useSelectionListModel").SelectionManager;
     navigation: import("./useCursorListModel").NavigationManager;
     getId: (item: any) => string;
-}) & import("../../common").ModelExtras<{
+}) & import("@workday/canvas-kit-react/common").ModelExtras<{
     /**
      * Controls the state changes when the user sends navigation events to the model. For example,
      * when the user hits the "right" arrow, a behavior hook will determine directionality
@@ -835,6 +980,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     initialUnselectedIds: string[];
     selection: import("./useSelectionListModel").SelectionManager;
     initialCursorId: string;
+    pageSize: number;
     id: string;
     getId: (item: any) => string;
     getTextValue: (item: any) => string;
@@ -848,10 +994,14 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
      */
     columnCount: number;
 }, {
-    selectedIds: import("./useSelectionListModel").SelectedIds;
+    selectedIds: string[] | "all";
     unselectedIds: string[];
     cursorId: string;
     columnCount: number;
+    pageSizeRef: import("react").MutableRefObject<number>;
+    cursorIndexRef: {
+        readonly current: number;
+    };
     UNSTABLE_virtual: {
         virtualItems: import("./react-virtual").VirtualItem[];
         totalSize: number;
@@ -862,7 +1012,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     UNSTABLE_defaultItemHeight: number;
     containerRef: import("react").RefObject<HTMLDivElement>;
     id: string;
-    orientation: import("./useBaseListModel").Orientation;
+    orientation: "horizontal" | "vertical";
     indexRef: import("react").MutableRefObject<number>;
     nonInteractiveIds: string[];
     isVirtualized: boolean;
@@ -873,10 +1023,6 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     }): void;
     selectAll(): void;
     unselectAll(): void;
-    registerItem(data: {
-        item: any;
-        textValue: string;
-    }): void;
     goTo(data: {
         id: string;
     }): void;
@@ -890,6 +1036,10 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     goToLastOfRow(): void;
     goToNextPage(): void;
     goToPreviousPage(): void;
+    registerItem(data: {
+        item: any;
+        textValue: string;
+    }): void;
     unregisterItem(data: {
         id: string;
     }): void;
@@ -898,10 +1048,14 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
     }): void;
 }, {
     state: {
-        selectedIds: import("./useSelectionListModel").SelectedIds;
+        selectedIds: string[] | "all";
         unselectedIds: string[];
         cursorId: string;
         columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -912,7 +1066,7 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: import("react").RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: import("react").MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -924,10 +1078,6 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         }): void;
         selectAll(): void;
         unselectAll(): void;
-        registerItem(data: {
-            item: any;
-            textValue: string;
-        }): void;
         goTo(data: {
             id: string;
         }): void;
@@ -941,6 +1091,10 @@ export declare const useGridModel: (<TT_Special_Generic>(config?: (Partial<{
         goToLastOfRow(): void;
         goToNextPage(): void;
         goToPreviousPage(): void;
+        registerItem(data: {
+            item: any;
+            textValue: string;
+        }): void;
         unregisterItem(data: {
             id: string;
         }): void;