@workday/canvas-kit-react 8.0.0 → 8.0.1

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

@@ -3,17 +3,40 @@ import { Generic } from '@workday/canvas-kit-react/common';
 import { Item } from './useBaseListModel';
 declare type NavigationInput = Pick<ReturnType<typeof useCursorListModel>, 'state'>;
 export interface NavigationManager {
+    /** Get the first item in a collection. This will be called when the `Home` key is pressed for
+     * Lists and `Ctrl+Home` for Grids. */
     getFirst: NavigationRequestor;
+    /** Get the last item in a collection. This will be called when the `End` key is pressed for Lists
+     * and `Ctrl+End` for Grids. */
     getLast: NavigationRequestor;
+    /** Get an item with the provided `id`. */
     getItem: NavigationRequestor;
+    /** Get the next item after the provided `id`. This will be called when the `Right` arrow key is
+     * pressed for RTL languages and when the `Left` arrow is pressed for LTR languages. */
     getNext: NavigationRequestor;
+    /** **For Grids:** Get the cell in the next row from the provided `id`. This will be called when
+     * the `Down` arrow is pressed.  */
     getNextRow: NavigationRequestor;
+    /** Get the previous item before the provided `id`. This will be called when the `Left` arrow key
+     * is pressed for RTL languages and when the `Right` arrow is pressed for LTR languages. */
     getPrevious: NavigationRequestor;
+    /** **For Grids:** Get the cell in the previous row from the provided `id`. This will be called
+     * when the `Up` arrow is pressed.  */
     getPreviousRow: NavigationRequestor;
+    /** **For Grids:** Get the first item in a row. This will be called when the `Home` key is
+     * pressed. */
     getFirstOfRow: NavigationRequestor;
+    /** **For Grids:** Get the last item in a row. This will be called when the `End` key is
+     * pressed. */
     getLastOfRow: NavigationRequestor;
-    getPreviousPage: NavigationRequestor;
+    /** Get the next "page". A "page" is application specific and usually means next visible screen.
+     * If the viewport is scrollable, it would scroll so that the last item visible is now the first
+     * item visible. This is called when the `PageDown` key is pressed */
     getNextPage: NavigationRequestor;
+    /** Get the next "page". A "page" is application specific and usually means previous visible
+     * screen. If the viewport is scrollable, it would scroll so that the first item visible is now
+     * the last item visible. This is called when the `PageUp` key is pressed */
+    getPreviousPage: NavigationRequestor;
 }
 /**
  * Factory function that does type checking to create navigation managers. Navigation managers
@@ -64,9 +87,15 @@ export declare const getNextPage: NavigationRequestor;
 export declare const getWrappingOffsetItem: (offset: number) => (id: string, { state }: NavigationInput, tries?: number) => Item<Generic>;
 export declare const getOffsetItem: (offset: number) => (id: string, { state }: NavigationInput, tries?: number) => Item<Generic>;
 /**
- * The default navigation manager of lists
+ * The default navigation manager of lists. This navigation manager will wrap around when the edge
+ * is hit. For example, if the user is the the right-most item in a list or right-most item in a
+ * row, the cursor will wrap around to the beginning or the next row.
  */
 export declare const wrappingNavigationManager: NavigationManager;
+/**
+ * The default navigation of grids. This navigation manager will not wrap, but will stop when an
+ * edge is detected. This could be the last item in a list or the last item of a row in a grid.
+ */
 export declare const navigationManager: NavigationManager;
 /**
  * A `CursorModel` extends a `ListModel` and adds a "cursor" to the list. A cursor is a pointer to a
@@ -89,9 +118,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
      * (left-to-right or right-to-left) and call the correct navigation method. In our example, a
      * left-to-right language would send a `getNext`. The navigation manager may return the next item
      * in the list. Different managers can be created for slightly different use cases. The default
-     * navigation manager will accept `orientation` and directionality to determine mapping. If
-     * `columnCount` is non-zero, it will use a grid mode where `orientation` is ignored and only
-     * directionality matters.
+     * navigation manager will accept `orientation` and directionality to determine mapping.
      *
      * An example override might be a tab list with an overflow menu that is meant to be transparent
      * to screen reader users. This would require the overflow menu to accept both up/down keys as
@@ -116,6 +143,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -123,9 +151,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -145,6 +170,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -152,9 +178,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -172,6 +195,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -179,9 +203,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -199,6 +220,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -206,9 +228,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -226,6 +245,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -233,9 +253,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -253,6 +270,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -260,9 +278,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -280,6 +295,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -287,9 +303,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -307,6 +320,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -314,9 +328,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -334,6 +345,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -341,9 +353,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -361,6 +370,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -368,9 +378,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -388,6 +395,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -395,9 +403,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -415,6 +420,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -422,9 +428,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -444,6 +447,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -451,9 +455,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -473,6 +474,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -480,9 +482,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -504,6 +503,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -511,9 +511,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -533,6 +530,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -540,9 +538,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -560,6 +555,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -567,9 +563,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -587,6 +580,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -594,9 +588,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -614,6 +605,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -621,9 +613,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -641,6 +630,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -648,9 +638,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -668,6 +655,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -675,9 +663,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -695,6 +680,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -702,9 +688,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -722,6 +705,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -729,9 +713,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -749,6 +730,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -756,9 +738,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -776,6 +755,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -783,9 +763,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -803,6 +780,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -810,9 +788,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -832,6 +807,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -839,9 +815,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -861,6 +834,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -868,9 +842,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -889,6 +860,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -896,9 +868,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;
@@ -982,9 +951,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
      * (left-to-right or right-to-left) and call the correct navigation method. In our example, a
      * left-to-right language would send a `getNext`. The navigation manager may return the next item
      * in the list. Different managers can be created for slightly different use cases. The default
-     * navigation manager will accept `orientation` and directionality to determine mapping. If
-     * `columnCount` is non-zero, it will use a grid mode where `orientation` is ignored and only
-     * directionality matters.
+     * navigation manager will accept `orientation` and directionality to determine mapping.
      *
      * An example override might be a tab list with an overflow menu that is meant to be transparent
      * to screen reader users. This would require the overflow menu to accept both up/down keys as
@@ -1005,6 +972,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
     /**
      * Any positive non-zero value treats the list like a grid with rows and columns
      * @default 0
+     * @private Use useGridModel instead to make a grid instead of a list
      */
     columnCount: number;
     UNSTABLE_virtual: {
@@ -1012,9 +980,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         totalSize: number;
         scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
         scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-        /**
-         * Get the last item in a list regardless of column count
-         */
         measure: () => void;
     };
     UNSTABLE_defaultItemHeight: number;
@@ -1085,6 +1050,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         /**
          * Any positive non-zero value treats the list like a grid with rows and columns
          * @default 0
+         * @private Use useGridModel instead to make a grid instead of a list
          */
         columnCount: number;
         UNSTABLE_virtual: {
@@ -1092,9 +1058,6 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
             totalSize: number;
             scrollToOffset: (index: number, options?: import("./react-virtual").ScrollToOffsetOptions | undefined) => void;
             scrollToIndex: (index: number, options?: import("./react-virtual").ScrollToIndexOptions | undefined) => void;
-            /**
-             * Get the last item in a list regardless of column count
-             */
             measure: () => void;
         };
         UNSTABLE_defaultItemHeight: number;

package/dist/commonjs/collection/lib/useCursorListModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCursorListModel.d.ts","sourceRoot":"","sources":["../../../../collection/lib/useCursorListModel.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAA0B,OAAO,EAAC,MAAM,kCAAkC,CAAC;AAElF,OAAO,EAAmB,IAAI,EAAwB,MAAM,oBAAoB,CAAC;AAEjF,aAAK,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,EAAE,OAAO,CAAC,CAAC;AAE5E,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,OAAO,EAAE,mBAAmB,CAAC;IAC7B,OAAO,EAAE,mBAAmB,CAAC;IAC7B,OAAO,EAAE,mBAAmB,CAAC;IAC7B,UAAU,EAAE,mBAAmB,CAAC;IAChC,WAAW,EAAE,mBAAmB,CAAC;IACjC,cAAc,EAAE,mBAAmB,CAAC;IACpC,aAAa,EAAE,mBAAmB,CAAC;IACnC,YAAY,EAAE,mBAAmB,CAAC;IAClC,eAAe,EAAE,mBAAmB,CAAC;IACrC,WAAW,EAAE,mBAAmB,CAAC;CAClC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,uBAAuB,YAAa,iBAAiB,sBAAY,CAAC;AAE/E,qEAAqE;AACrE,oBAAY,mBAAmB,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,EAAC,KAAK,EAAC,EAAE,eAAe,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC;AAE1F;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,mBAAoD,CAAC;AAC5E;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,mBAAyE,CAAC;AAEhG;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,mBAQ3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,mBAQ1B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,mBAO7B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,mBAQzB,CAAC;AAQF,eAAO,MAAM,qBAAqB,WAAY,MAAM,UAC9C,MAAM,aACD,eAAe,qBAEvB,KAAK,OAAO,CAmBd,CAAC;AAEF,eAAO,MAAM,aAAa,WAAY,MAAM,UACtC,MAAM,aACD,eAAe,qBAEvB,KAAK,OAAO,CAmCd,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB,mBAYpC,CAAC;AAEH,eAAO,MAAM,iBAAiB,mBAY5B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;IAG3B;;OAEG;;IAEH;;;OAGG;;IAEH;;;;;;;;;;;;;OAaG;;;;;;;;;;;;;;;QAcH,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;YAoOiB,MAAM;;QAzBtB,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;YAoOiB,MAAM;;QAzBtB,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;;QA2MC,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QAuNC;;;WAGG;;;;;QASH,mEAAmE;mBACxD;YAAC,EAAE,EAAE,MAAM,CAAA;SAAC;QAGvB;;;;;WAKG;;QAIH;;;WAGG;;QAIH;;;;;WAKG;;QAUH;;;;;WAKG;;QAIH,mDAAmD;;QAInD,kDAAkD;;;;;;;;;;;;;;;;IA5GlD;;OAEG;;IAEH;;;OAGG;;IAEH;;;;;;;;;;;;;OAaG;;;;;;;;;;;IAcH,wDAAwD;;IAExD;;;OAGG;;;;;;;QAlNP;;WAEG;;;;;;;;;;;;IAuNC;;;OAGG;;;;;IASH,mEAAmE;eACxD;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC;IAGvB;;;;;OAKG;;IAIH;;;OAGG;;IAIH;;;;;OAKG;;IAUH;;;;;OAKG;;IAIH,mDAAmD;;IAInD,kDAAkD;;;;;;;;;;;;;;QAxElD,wDAAwD;;QAExD;;;WAGG;;;;;;;YAlNP;;eAEG;;;;;;;;;;;;;QAuNC;;;WAGG;;;;;QASH,mEAAmE;mBACxD;YAAC,EAAE,EAAE,MAAM,CAAA;SAAC;QAGvB;;;;;WAKG;;QAIH;;;WAGG;;QAIH;;;;;WAKG;;QAUH;;;;;WAKG;;QAIH,mDAAmD;;QAInD,kDAAkD;;;;;;;;;;;;;;;EAyBpD,CAAC"}
+{"version":3,"file":"useCursorListModel.d.ts","sourceRoot":"","sources":["../../../../collection/lib/useCursorListModel.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAA0B,OAAO,EAAC,MAAM,kCAAkC,CAAC;AAElF,OAAO,EAAmB,IAAI,EAAwB,MAAM,oBAAoB,CAAC;AAEjF,aAAK,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,EAAE,OAAO,CAAC,CAAC;AAE5E,MAAM,WAAW,iBAAiB;IAChC;0CACsC;IACtC,QAAQ,EAAE,mBAAmB,CAAC;IAC9B;mCAC+B;IAC/B,OAAO,EAAE,mBAAmB,CAAC;IAC7B,0CAA0C;IAC1C,OAAO,EAAE,mBAAmB,CAAC;IAC7B;2FACuF;IACvF,OAAO,EAAE,mBAAmB,CAAC;IAC7B;uCACmC;IACnC,UAAU,EAAE,mBAAmB,CAAC;IAChC;+FAC2F;IAC3F,WAAW,EAAE,mBAAmB,CAAC;IACjC;0CACsC;IACtC,cAAc,EAAE,mBAAmB,CAAC;IACpC;kBACc;IACd,aAAa,EAAE,mBAAmB,CAAC;IACnC;kBACc;IACd,YAAY,EAAE,mBAAmB,CAAC;IAClC;;yEAEqE;IACrE,WAAW,EAAE,mBAAmB,CAAC;IACjC;;gFAE4E;IAC5E,eAAe,EAAE,mBAAmB,CAAC;CACtC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,uBAAuB,YAAa,iBAAiB,sBAAY,CAAC;AAE/E,qEAAqE;AACrE,oBAAY,mBAAmB,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,EAAC,KAAK,EAAC,EAAE,eAAe,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC;AAE1F;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,mBAAoD,CAAC;AAC5E;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,mBAAyE,CAAC;AAEhG;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,mBAQ3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,mBAY1B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,mBAO7B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,mBAQzB,CAAC;AAQF,eAAO,MAAM,qBAAqB,WAAY,MAAM,UAC9C,MAAM,aACD,eAAe,qBAEvB,KAAK,OAAO,CA6Cd,CAAC;AAEF,eAAO,MAAM,aAAa,WAAY,MAAM,UACtC,MAAM,aACD,eAAe,qBAEvB,KAAK,OAAO,CA6Cd,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,mBAYpC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,iBAAiB,mBAY5B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;IAG3B;;OAEG;;IAEH;;;OAGG;;IAEH;;;;;;;;;;;OAWG;;;;;;;;;;;;;;;QAeH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;YAmBa,MAAM;;QAzBtB,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;YAmBa,MAAM;;QAzBtB,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;;QANH,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QAMH;;;WAGG;;;;;QASH,mEAAmE;mBACxD;YAAC,EAAE,EAAE,MAAM,CAAA;SAAC;QAGvB;;;;;WAKG;;QAIH;;;WAGG;;QAIH;;;;;WAKG;;QAUH;;;;;WAKG;;QAIH,mDAAmD;;QAInD,kDAAkD;;;;;;;;;;;;;;;;IA3GlD;;OAEG;;IAEH;;;OAGG;;IAEH;;;;;;;;;;;OAWG;;;;;;;;;;;IAeH,wDAAwD;;IAExD;;;;OAIG;;;;;;;;;;;;;;;;;;IAMH;;;OAGG;;;;;IASH,mEAAmE;eACxD;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC;IAGvB;;;;;OAKG;;IAIH;;;OAGG;;IAIH;;;;;OAKG;;IAUH;;;;;OAKG;;IAIH,mDAAmD;;IAInD,kDAAkD;;;;;;;;;;;;;;QAxElD,wDAAwD;;QAExD;;;;WAIG;;;;;;;;;;;;;;;;;;;QAMH;;;WAGG;;;;;QASH,mEAAmE;mBACxD;YAAC,EAAE,EAAE,MAAM,CAAA;SAAC;QAGvB;;;;;WAKG;;QAIH;;;WAGG;;QAIH;;;;;WAKG;;QAUH;;;;;WAKG;;QAIH,mDAAmD;;QAInD,kDAAkD;;;;;;;;;;;;;;;EAyBpD,CAAC"}