@workday/canvas-kit-react 9.0.0-alpha.415-next.17 → 9.0.0-alpha.417-next.19

package/dist/es6/collection/lib/useCursorListModel.d.ts

@@ -163,9 +163,8 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
     shouldVirtualize: boolean;
     items: any[];
 }> & {
-    onRegisterItem?: ((data: {
-        item: any;
-        textValue: string;
+    onGoTo?: ((data: {
+        id: string;
     }, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
@@ -180,6 +179,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -196,9 +205,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoTo?: ((data: {
-        id: string;
-    }, prevState: {
+    onGoToNext?: ((data: undefined, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -212,6 +219,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -228,7 +245,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoToNext?: ((data: undefined, prevState: {
+    onGoToPrevious?: ((data: undefined, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -242,6 +259,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -258,7 +285,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoToPrevious?: ((data: undefined, prevState: {
+    onGoToPreviousRow?: ((data: undefined, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -272,6 +299,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -288,7 +325,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoToPreviousRow?: ((data: undefined, prevState: {
+    onGoToNextRow?: ((data: undefined, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -302,6 +339,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -318,7 +365,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoToNextRow?: ((data: undefined, prevState: {
+    onGoToFirst?: ((data: undefined, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -332,6 +379,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -348,7 +405,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoToFirst?: ((data: undefined, prevState: {
+    onGoToLast?: ((data: undefined, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -362,6 +419,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -378,7 +445,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoToLast?: ((data: undefined, prevState: {
+    onGoToFirstOfRow?: ((data: undefined, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -392,6 +459,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -408,7 +485,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoToFirstOfRow?: ((data: undefined, prevState: {
+    onGoToLastOfRow?: ((data: undefined, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -422,6 +499,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -438,7 +525,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoToLastOfRow?: ((data: undefined, prevState: {
+    onGoToNextPage?: ((data: undefined, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -452,6 +539,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -468,7 +565,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoToNextPage?: ((data: undefined, prevState: {
+    onGoToPreviousPage?: ((data: undefined, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -482,6 +579,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -498,7 +605,10 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => void) | undefined;
-    onGoToPreviousPage?: ((data: undefined, prevState: {
+    onRegisterItem?: ((data: {
+        item: any;
+        textValue: string;
+    }, prevState: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -512,6 +622,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -544,6 +664,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -576,6 +706,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -593,9 +733,8 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         items: Item<any>[];
     }) => void) | undefined;
 } & {
-    shouldRegisterItem?: ((data: {
-        item: any;
-        textValue: string;
+    shouldGoTo?: ((data: {
+        id: string;
     }, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
@@ -610,6 +749,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -626,9 +775,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoTo?: ((data: {
-        id: string;
-    }, state: {
+    shouldGoToNext?: ((data: undefined, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -642,6 +789,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -658,7 +815,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToNext?: ((data: undefined, state: {
+    shouldGoToPrevious?: ((data: undefined, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -672,6 +829,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -688,7 +855,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToPrevious?: ((data: undefined, state: {
+    shouldGoToPreviousRow?: ((data: undefined, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -702,6 +869,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -718,7 +895,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToPreviousRow?: ((data: undefined, state: {
+    shouldGoToNextRow?: ((data: undefined, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -732,6 +909,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -748,7 +935,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToNextRow?: ((data: undefined, state: {
+    shouldGoToFirst?: ((data: undefined, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -762,6 +949,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -778,7 +975,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToFirst?: ((data: undefined, state: {
+    shouldGoToLast?: ((data: undefined, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -792,6 +989,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -808,7 +1015,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToLast?: ((data: undefined, state: {
+    shouldGoToFirstOfRow?: ((data: undefined, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -822,6 +1029,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -838,7 +1055,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToFirstOfRow?: ((data: undefined, state: {
+    shouldGoToLastOfRow?: ((data: undefined, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -852,6 +1069,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -868,7 +1095,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToLastOfRow?: ((data: undefined, state: {
+    shouldGoToNextPage?: ((data: undefined, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -882,6 +1109,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -898,7 +1135,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToNextPage?: ((data: undefined, state: {
+    shouldGoToPreviousPage?: ((data: undefined, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -912,6 +1149,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -928,7 +1175,10 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         isVirtualized: boolean;
         items: Item<any>[];
     }) => boolean) | undefined;
-    shouldGoToPreviousPage?: ((data: undefined, state: {
+    shouldRegisterItem?: ((data: {
+        item: any;
+        textValue: string;
+    }, state: {
         /** The id of the list item the cursor is pointing to */
         cursorId: string;
         /**
@@ -942,6 +1192,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -974,6 +1234,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -1006,6 +1276,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -1037,6 +1317,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -1054,14 +1344,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         items: Item<any>[];
     };
     events: {
-        /**
-         * Register an item to the list. Takes in an identifier, a React.Ref and an optional index. This
-         * should be called on component mount
-         */
-        registerItem(data: {
-            item: any;
-            textValue: string;
-        }): void;
         /** Directly sets the cursor to the list item by its identifier. */
         goTo(data: {
             id: string;
@@ -1100,6 +1382,10 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         goToLastOfRow(): void;
         goToNextPage(): void;
         goToPreviousPage(): void;
+        registerItem(data: {
+            item: any;
+            textValue: string;
+        }): void;
         unregisterItem(data: {
             id: string;
         }): void;
@@ -1176,6 +1462,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
      * based on the size of the list container and the number of items fitting within the container.
      */
     pageSizeRef: React.MutableRefObject<number>;
+    /**
+     * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+     * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+     * or the `items` change.
+     *
+     * @readonly
+     */
+    cursorIndexRef: {
+        readonly current: number;
+    };
     UNSTABLE_virtual: {
         virtualItems: import("./react-virtual").VirtualItem[];
         totalSize: number;
@@ -1192,14 +1488,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
     isVirtualized: boolean;
     items: Item<any>[];
 }, {
-    /**
-     * Register an item to the list. Takes in an identifier, a React.Ref and an optional index. This
-     * should be called on component mount
-     */
-    registerItem(data: {
-        item: any;
-        textValue: string;
-    }): void;
     /** Directly sets the cursor to the list item by its identifier. */
     goTo(data: {
         id: string;
@@ -1238,6 +1526,10 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
     goToLastOfRow(): void;
     goToNextPage(): void;
     goToPreviousPage(): void;
+    registerItem(data: {
+        item: any;
+        textValue: string;
+    }): void;
     unregisterItem(data: {
         id: string;
     }): void;
@@ -1259,6 +1551,16 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
          * based on the size of the list container and the number of items fitting within the container.
          */
         pageSizeRef: React.MutableRefObject<number>;
+        /**
+         * A readonly [React.Ref](https://react.dev/learn/referencing-values-with-refs) that tracks the
+         * index of the `state.cursorId`. This value is automatically updated when the `state.cursorId`
+         * or the `items` change.
+         *
+         * @readonly
+         */
+        cursorIndexRef: {
+            readonly current: number;
+        };
         UNSTABLE_virtual: {
             virtualItems: import("./react-virtual").VirtualItem[];
             totalSize: number;
@@ -1276,14 +1578,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         items: Item<any>[];
     };
     events: {
-        /**
-         * Register an item to the list. Takes in an identifier, a React.Ref and an optional index. This
-         * should be called on component mount
-         */
-        registerItem(data: {
-            item: any;
-            textValue: string;
-        }): void;
         /** Directly sets the cursor to the list item by its identifier. */
         goTo(data: {
             id: string;
@@ -1322,6 +1616,10 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         goToLastOfRow(): void;
         goToNextPage(): void;
         goToPreviousPage(): void;
+        registerItem(data: {
+            item: any;
+            textValue: string;
+        }): void;
         unregisterItem(data: {
             id: string;
         }): void;