@workday/canvas-kit-react 8.5.0-339-next.0 → 8.5.0-342-next.2

package/dist/es6/collection/lib/ListBox.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ListBox.d.ts","sourceRoot":"","sources":["../../../../collection/lib/ListBox.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,OAAO,EAAM,QAAQ,EAAC,MAAM,kCAAkC,CAAC;AAM/D,MAAM,WAAW,YAAa,SAAQ,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9D,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC;CAC/D;AAED,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMtB,CAAC;AAWH;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAKhB;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmBL,CAAC"}
+{"version":3,"file":"ListBox.d.ts","sourceRoot":"","sources":["../../../../collection/lib/ListBox.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B,OAAO,EAAM,QAAQ,EAAC,MAAM,kCAAkC,CAAC;AAM/D,MAAM,WAAW,YAAa,SAAQ,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC9D,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC;CAC/D;AAED,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMtB,CAAC;AAEH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAOrB,CAAC;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAKhB;;;;;;;;OAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmBL,CAAC"}

package/dist/es6/collection/lib/ListBox.js

@@ -33,7 +33,7 @@ export var ListBoxItem = createSubcomponent('li')({
 })(function (elemProps, Element) {
     return React.createElement(Box, __assign({ as: Element }, elemProps));
 });
-var useListBox = createElemPropsHook(useListModel)(function (model) {
+export var useListBox = createElemPropsHook(useListModel)(function (model) {
     return {
         style: {
             position: 'relative',
@@ -42,8 +42,17 @@ var useListBox = createElemPropsHook(useListModel)(function (model) {
     };
 });
 /**
- * Basic list box that supports virtualization. `ListBox.Item` contains a very simple list item
- * without much functionality. The `ListBox` contains two `Box` elements:
+ * The `ListBox` component that offers vertical rendering of a collection in the form of a
+ * 2-dimension list. It supports virtualization, rendering only visible items in the DOM while also
+ * providing aria attributes to allow screen readers to still navigate virtual lists. The `ListBox`
+ * contains a basic `ListBox.Item` that renders list items that render correctly with virtualization
+ * and adds `aria-setsize` and `aria-posinset` for screen readers.
+
+ * The `ListBox` is very basic and only adds enough functionality to render correctly. No additional
+ * behaviors are added to navigate or select. React Hooks are provided to add this functionality and
+ * are used by higher level components like `Menu` and `Menu.Item` which utilize `ListBox`. The
+ * `ListBox` contains two `Box` elements:
+ *
  * - Outer Box: Presentational container element responsible for overflow and height. `height` and
  *   `maxHeight` props will be applied here.
  * - Inner Box: The element responsible for the virtual container. Height is controlled by the model
@@ -55,9 +64,13 @@ export var ListBox = createContainer('ul')({
     elemPropsHook: useListBox,
     subComponents: {
         /**
-         * Extremely simple ListBox item that contains no functionality other than registering items and
-         * adding aria virtualization attributes. If you need more functionality, create your own
-         * component using list item hooks.
+         * The `ListBox.Item` is a simple placeholder for listbox items. The functionality of a
+         * collection item varies between components. For example, a `Tabs.Item` and a `Menu.Item` have
+         * shared functionality, but have different behavior. All collection-based components should
+         * implement a custom `Item` subcomponent using the collection-based behavior hooks. The [Roving
+         * Tabindex](#roving-tabindex) example uses the `elemPropsHook` to provide additional
+         * functionality. `elemPropsHook` is provided on all compound components and is useful in the
+         * example to add additional functionality without making a new component.
          */
         Item: ListBoxItem,
     },

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

@@ -65,7 +65,7 @@ export declare const useBaseListModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -84,7 +84,7 @@ export declare const useBaseListModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -103,7 +103,7 @@ export declare const useBaseListModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -124,7 +124,7 @@ export declare const useBaseListModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -143,7 +143,7 @@ export declare const useBaseListModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -162,7 +162,7 @@ export declare const useBaseListModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -180,7 +180,7 @@ export declare const useBaseListModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -216,7 +216,7 @@ export declare const useBaseListModel: (<TT_Special_Generic>(config?: (Partial<{
         }): void;
     };
     getId: (item: Generic) => string;
-}) & import("../../common").ModelExtras<{
+}) & import("@workday/canvas-kit-react/common").ModelExtras<{
     /** IDREF of the list. Children ids can be derived from this id */
     id: string;
     /**
@@ -265,7 +265,7 @@ export declare const useBaseListModel: (<TT_Special_Generic>(config?: (Partial<{
     UNSTABLE_defaultItemHeight: number;
     containerRef: React.RefObject<HTMLDivElement>;
     id: string;
-    orientation: Orientation;
+    orientation: "horizontal" | "vertical";
     indexRef: React.MutableRefObject<number>;
     nonInteractiveIds: string[];
     isVirtualized: boolean;
@@ -310,7 +310,7 @@ export declare const useBaseListModel: (<TT_Special_Generic>(config?: (Partial<{
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;

package/dist/es6/collection/lib/useBaseListModel.js

@@ -111,7 +111,7 @@ export var useBaseListModel = createModelHook({
         parentRef: containerRef,
         estimateSize: React.useCallback(function () { return UNSTABLE_defaultItemHeight; }, [UNSTABLE_defaultItemHeight]),
         horizontal: config.orientation === 'horizontal',
-        overscan: 3,
+        overscan: 3, // overscan of 3 helps rapid navigation
     });
     // Force Typescript to recognize the `Generic` symbol
     var genericState = {

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

@@ -2,6 +2,11 @@ import React from 'react';
 import { Generic } from '@workday/canvas-kit-react/common';
 import { Item } from './useBaseListModel';
 declare type NavigationInput = Pick<ReturnType<typeof useCursorListModel>, 'state'>;
+/**
+ * The list and grid models accept a `navigation` config. If one is not provided, a default will be
+ * chosen. It is possible to create a custom navigation manager to hand to the model if the default
+ * doesn't work.
+ */
 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. */
@@ -56,8 +61,10 @@ export interface NavigationManager {
  * ```
  */
 export declare const createNavigationManager: (manager: NavigationManager) => NavigationManager;
-/** Function type to make it easier to define navigation functions */
-export declare type NavigationRequestor = (id: string, { state }: NavigationInput) => Item<Generic>;
+/**
+ * Given an id and a model, return an item from the collection
+ */
+export declare type NavigationRequestor = (id: string, model: NavigationInput) => Item<Generic>;
 /**
  * Get the first item in a list regardless of column count
  */
@@ -132,7 +139,9 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
     orientation: import("./useBaseListModel").Orientation;
     defaultItemHeight: number;
     shouldVirtualize: boolean;
-    items: any[];
+    items: any[]; /** 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 */
 }> & {
     onRegisterItem?: ((data: {
         item: any;
@@ -156,7 +165,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -183,7 +192,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -208,7 +217,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -233,7 +242,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -258,7 +267,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -283,7 +292,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -308,7 +317,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -333,7 +342,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -358,7 +367,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -383,7 +392,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -408,7 +417,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -433,7 +442,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -460,7 +469,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -487,7 +496,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -516,7 +525,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -543,7 +552,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -568,7 +577,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -593,7 +602,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -618,7 +627,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -643,7 +652,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -668,7 +677,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -693,7 +702,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -718,7 +727,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -743,7 +752,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -768,7 +777,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -793,7 +802,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -820,7 +829,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -847,7 +856,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -873,7 +882,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;
@@ -935,7 +944,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
     };
     navigation: NavigationManager;
     getId: (item: any) => string;
-}) & import("../../common").ModelExtras<{
+}) & import("@workday/canvas-kit-react/common").ModelExtras<{
     /**
      * Initial cursor position. If not provided, the cursor will point to the first item in the list
      */
@@ -965,7 +974,9 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
     orientation: import("./useBaseListModel").Orientation;
     defaultItemHeight: number;
     shouldVirtualize: boolean;
-    items: any[];
+    items: any[]; /** 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 */
 }, {}, {
     /** The id of the list item the cursor is pointing to */
     cursorId: string;
@@ -985,7 +996,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
     UNSTABLE_defaultItemHeight: number;
     containerRef: React.RefObject<HTMLDivElement>;
     id: string;
-    orientation: import("./useBaseListModel").Orientation;
+    orientation: "horizontal" | "vertical";
     indexRef: React.MutableRefObject<number>;
     nonInteractiveIds: string[];
     isVirtualized: boolean;
@@ -1063,7 +1074,7 @@ export declare const useCursorListModel: (<TT_Special_Generic>(config?: (Partial
         UNSTABLE_defaultItemHeight: number;
         containerRef: React.RefObject<HTMLDivElement>;
         id: string;
-        orientation: import("./useBaseListModel").Orientation;
+        orientation: "horizontal" | "vertical";
         indexRef: React.MutableRefObject<number>;
         nonInteractiveIds: string[];
         isVirtualized: boolean;

package/dist/es6/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;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"}
+{"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;;;;GAIG;AACH,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;;GAEG;AACH,oBAAY,mBAAmB,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC;AAExF;;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;;;;;;;;;kBAjRL;;yEAEqE;;;;;;QA8RnE,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;;;;;;;;;kBAjRL;;yEAEqE;;IA8RnE,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"}