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

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

@@ -6,10 +6,26 @@ export declare type ListItemProps = {
     'data-id'?: string;
 };
 /**
- * Create a list model that includes item registration, cursors for focus, and selection. You can
- * inject navigation and selection managers to change how a user navigates or how selection works.
+ * The List model contains the the state and events necessary to track items, selection, and a cursor.
+ * Various hooks can be used for a List model to create common behaviors associated with lists, such as
+ * navigating a list with a keyboard, selection (single and multiple), and virtualization.
  *
- * @example
+ * A list also has a "cursor". A cursor is often represented by focus, but it is not always a 1:1
+ * mapping. Think of the cursor as the focus item within the list. If the list has browser focus, the
+ * cursor will map to browser focus. Behaviors such as `useListRovingFocus` will map the cursor to the
+ * active tab stop of the list. For more information, see
+ * [Roving Tabindex](https://w3c.github.io/aria-practices/#kbd_roving_tabindex). `useListRovingFocus`
+ * adds keyboard events that map to navigation events. A [Navigation Manager](#navigation-manager) is
+ * used to map new cursor ids to these events. The `ListModel` takes an optional `navigation`
+ * configuration to change the default navigation behavior. The default navigation manager is a
+ * [wrappingNavigationManager](#wrappingnavigationmanager) meaning the cursor will wrap around the
+ * beginning and the ends. The cursor also provides a [navigationManager](#navigationmanager) that does
+ * not wrap. This is the default navigation for grids.
+ *
+ * The cursor also adds the concept of `orientation` which defaults to `'vertical'`. A Tab list is an
+ * example of a `'horizontal'` list.
+ *
+ * ```tsx
  * const list = useListModel({
  *   // custom handling for selection. single and multi select are provided
  *   selection: mySelectionManager,
@@ -18,6 +34,7 @@ export declare type ListItemProps = {
  *   items: [{ id: '1', text: 'First'}, { id: '2', text: 'Second' }],
  *   getId: item => item.id, // get the unique identifier of your item
  * })
+ * ```
  */
 export declare const useListModel: (<TT_Special_Generic>(config?: (Partial<{
     initialSelectedIds: import("./useSelectionListModel").SelectedIds;
@@ -26,6 +43,7 @@ export declare const useListModel: (<TT_Special_Generic>(config?: (Partial<{
     initialCursorId: string;
     columnCount: number;
     navigation: import("./useCursorListModel").NavigationManager;
+    pageSize: number;
     id: string;
     getId: (item: any) => string;
     getTextValue: (item: any) => string;
@@ -38,10 +56,14 @@ export declare const useListModel: (<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;
@@ -52,17 +74,21 @@ export declare const useListModel: (<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;
@@ -73,17 +99,21 @@ export declare const useListModel: (<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;
@@ -94,20 +124,23 @@ export declare const useListModel: (<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;
@@ -118,19 +151,21 @@ export declare const useListModel: (<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;
@@ -141,17 +176,21 @@ export declare const useListModel: (<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;
@@ -162,17 +201,21 @@ export declare const useListModel: (<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;
@@ -183,17 +226,21 @@ export declare const useListModel: (<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;
@@ -204,17 +251,21 @@ export declare const useListModel: (<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;
@@ -225,17 +276,21 @@ export declare const useListModel: (<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;
@@ -246,17 +301,21 @@ export declare const useListModel: (<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;
@@ -267,17 +326,21 @@ export declare const useListModel: (<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;
@@ -288,17 +351,21 @@ export declare const useListModel: (<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;
@@ -309,17 +376,21 @@ export declare const useListModel: (<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;
@@ -330,17 +401,24 @@ export declare const useListModel: (<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;
@@ -351,7 +429,7 @@ export declare const useListModel: (<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;
@@ -360,10 +438,14 @@ export declare const useListModel: (<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;
@@ -374,7 +456,7 @@ export declare const useListModel: (<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;
@@ -383,10 +465,14 @@ export declare const useListModel: (<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;
@@ -397,7 +483,7 @@ export declare const useListModel: (<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;
@@ -407,10 +493,14 @@ export declare const useListModel: (<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;
@@ -421,17 +511,21 @@ export declare const useListModel: (<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;
@@ -442,17 +536,21 @@ export declare const useListModel: (<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;
@@ -463,20 +561,23 @@ export declare const useListModel: (<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;
@@ -487,19 +588,21 @@ export declare const useListModel: (<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;
@@ -510,17 +613,21 @@ export declare const useListModel: (<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;
@@ -531,17 +638,21 @@ export declare const useListModel: (<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;
@@ -552,17 +663,21 @@ export declare const useListModel: (<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;
@@ -573,17 +688,21 @@ export declare const useListModel: (<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;
@@ -594,17 +713,21 @@ export declare const useListModel: (<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;
@@ -615,17 +738,21 @@ export declare const useListModel: (<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;
@@ -636,17 +763,21 @@ export declare const useListModel: (<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;
@@ -657,17 +788,21 @@ export declare const useListModel: (<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;
@@ -678,17 +813,21 @@ export declare const useListModel: (<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;
@@ -699,17 +838,24 @@ export declare const useListModel: (<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;
@@ -720,7 +866,7 @@ export declare const useListModel: (<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;
@@ -729,10 +875,14 @@ export declare const useListModel: (<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;
@@ -743,7 +893,7 @@ export declare const useListModel: (<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;
@@ -752,10 +902,14 @@ export declare const useListModel: (<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;
@@ -766,7 +920,7 @@ export declare const useListModel: (<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;
@@ -774,10 +928,14 @@ export declare const useListModel: (<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;
@@ -788,7 +946,7 @@ export declare const useListModel: (<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;
@@ -800,10 +958,6 @@ export declare const useListModel: (<TT_Special_Generic>(config?: (Partial<{
         }): void;
         selectAll(): void;
         unselectAll(): void;
-        registerItem(data: {
-            item: any;
-            textValue: string;
-        }): void;
         goTo(data: {
             id: string;
         }): void;
@@ -817,6 +971,10 @@ export declare const useListModel: (<TT_Special_Generic>(config?: (Partial<{
         goToLastOfRow(): void;
         goToNextPage(): void;
         goToPreviousPage(): void;
+        registerItem(data: {
+            item: any;
+            textValue: string;
+        }): void;
         unregisterItem(data: {
             id: string;
         }): void;
@@ -827,13 +985,14 @@ export declare const useListModel: (<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<{
     initialSelectedIds: import("./useSelectionListModel").SelectedIds;
     initialUnselectedIds: string[];
     selection: import("./useSelectionListModel").SelectionManager;
     initialCursorId: string;
     columnCount: number;
     navigation: import("./useCursorListModel").NavigationManager;
+    pageSize: number;
     id: string;
     getId: (item: any) => string;
     getTextValue: (item: any) => string;
@@ -843,10 +1002,14 @@ export declare const useListModel: (<TT_Special_Generic>(config?: (Partial<{
     shouldVirtualize: boolean;
     items: any[];
 }, {}, {
-    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;
@@ -857,7 +1020,7 @@ export declare const useListModel: (<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;
@@ -868,10 +1031,6 @@ export declare const useListModel: (<TT_Special_Generic>(config?: (Partial<{
     }): void;
     selectAll(): void;
     unselectAll(): void;
-    registerItem(data: {
-        item: any;
-        textValue: string;
-    }): void;
     goTo(data: {
         id: string;
     }): void;
@@ -885,6 +1044,10 @@ export declare const useListModel: (<TT_Special_Generic>(config?: (Partial<{
     goToLastOfRow(): void;
     goToNextPage(): void;
     goToPreviousPage(): void;
+    registerItem(data: {
+        item: any;
+        textValue: string;
+    }): void;
     unregisterItem(data: {
         id: string;
     }): void;
@@ -893,10 +1056,14 @@ export declare const useListModel: (<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;
@@ -907,7 +1074,7 @@ export declare const useListModel: (<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;
@@ -919,10 +1086,6 @@ export declare const useListModel: (<TT_Special_Generic>(config?: (Partial<{
         }): void;
         selectAll(): void;
         unselectAll(): void;
-        registerItem(data: {
-            item: any;
-            textValue: string;
-        }): void;
         goTo(data: {
             id: string;
         }): void;
@@ -936,6 +1099,10 @@ export declare const useListModel: (<TT_Special_Generic>(config?: (Partial<{
         goToLastOfRow(): void;
         goToNextPage(): void;
         goToPreviousPage(): void;
+        registerItem(data: {
+            item: any;
+            textValue: string;
+        }): void;
         unregisterItem(data: {
             id: string;
         }): void;