@workday/canvas-kit-react 6.0.0-beta.0-next.13 → 6.0.0

package/dist/es6/tabs/lib/cursor/index.js

@@ -1,2 +1,2 @@
-export * from './hooks';
+export * from './useRovingFocus';
 export * from './useCursorModel';

package/dist/es6/tabs/lib/cursor/useCursorModel.d.ts

@@ -1,14 +1,14 @@
-import { Model, ToModelConfig } from '@workday/canvas-kit-react/common';
-import { ListState, ListEvents, BaseListModelConfig, Item } from '../list/useListModel';
+import { ToModelConfig } from '@workday/canvas-kit-react/common';
+import { ListState, ListEvents, BaseListModelConfig, ListModel } from '../list/useListModel';
 export declare type Orientation = 'horizontal' | 'vertical';
-export declare type CursorState = ListState & {
+export declare type CursorState<T = unknown> = ListState<T> & {
     /** Orientation of the list. This property determines what "next" and "previous" mean. This should
      * be set to match the layout of UI components */
     orientation: Orientation;
     /** The id of the list item the cursor is pointing to */
     cursorId: string;
 };
-export declare type CursorEvents = ListEvents & {
+export declare type CursorEvents<T = unknown> = ListEvents<T> & {
     /** Directly sets the cursor to the list item by its identifier.  */
     goTo(data: {
         id: string;
@@ -24,7 +24,10 @@ export declare type CursorEvents = ListEvents & {
     /** Set the cursor to the last item in the list */
     last(): void;
 };
-export declare type CursorModel = Model<CursorState, CursorEvents>;
+export interface CursorModel<T = unknown> extends ListModel<T> {
+    state: CursorState<T>;
+    events: CursorEvents<T>;
+}
 export declare const cursorEventMap: {
     guards: {
         /** Should a cursor position be set? Use only in advance use-cases */
@@ -45,19 +48,26 @@ export declare const cursorEventMap: {
         onUpdateItemPosition: "updateItemPosition";
     };
 };
-export declare type BaseCursorModelConfig = BaseListModelConfig & {
+export declare type BaseCursorModelConfig<T> = BaseListModelConfig<T> & {
     /**
      * The orientation of a list of items. Values are either `vertical` or `horizontal`. This value will
-     * effect which keys activate progression through a list. For example, `horizontal` will activate with
+     * effect which ids activate progression through a list. For example, `horizontal` will activate with
      * left and right arrows while `vertical` will activate with up and down arrows.
      * @default 'vertical'
      */
     orientation?: Orientation;
+    /**
+     * Initial cursor position. If not provided, the cursor will point to the first item in the list
+     */
+    initialCursorId?: string;
+};
+export declare type CursorModelConfig<T> = BaseCursorModelConfig<T> & Partial<ToModelConfig<CursorState<T>, CursorEvents<T>, typeof cursorEventMap>>;
+export declare const useCursorNavigation: <T extends unknown>(state: CursorState<T>, getId: (item: T) => string) => {
+    getFirst: () => T;
+    getLast: () => T;
+    getItem: (id: string) => T;
+    getNext: (id: string, tries?: number) => T;
+    getPrevious: (id: string, tries?: number) => T;
 };
-export declare type CursorModelConfig = BaseCursorModelConfig & Partial<ToModelConfig<CursorState, CursorEvents, typeof cursorEventMap>>;
-export declare const getItem: (id: string, items: Item[]) => Item;
-export declare const hasItems: (items: Item[]) => boolean;
-export declare const getNext: (id: string, items: Item[]) => Item;
-export declare const getPrevious: (id: string, items: Item[]) => Item;
-export declare const useCursorModel: (config?: CursorModelConfig) => Model<CursorState, CursorEvents>;
+export declare const useCursorModel: <T extends unknown>(config?: CursorModelConfig<T>) => CursorModel<T>;
 //# sourceMappingURL=useCursorModel.d.ts.map

package/dist/es6/tabs/lib/cursor/useCursorModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCursorModel.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/cursor/useCursorModel.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,EACL,aAAa,EAGd,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EACL,SAAS,EACT,UAAU,EACV,mBAAmB,EAGnB,IAAI,EAEL,MAAM,sBAAsB,CAAC;AAE9B,oBAAY,WAAW,GAAG,YAAY,GAAG,UAAU,CAAC;AAEpD,oBAAY,WAAW,GAAG,SAAS,GAAG;IACpC;qDACiD;IACjD,WAAW,EAAE,WAAW,CAAC;IACzB,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,oBAAY,YAAY,GAAG,UAAU,GAAG;IACtC,oEAAoE;IACpE,IAAI,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IAC/B;gCAC4B;IAC5B,IAAI,IAAI,IAAI,CAAC;IACb;uCACmC;IACnC,QAAQ,IAAI,IAAI,CAAC;IACjB,mDAAmD;IACnD,KAAK,IAAI,IAAI,CAAC;IACd,kDAAkD;IAClD,IAAI,IAAI,IAAI,CAAC;CACd,CAAC;AAEF,oBAAY,WAAW,GAAG,KAAK,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;AAE3D,eAAO,MAAM,cAAc;;QAGvB,qEAAqE;;;;;;;QAKrE;;;;WAIG;;;;;;CAGL,CAAC;AAEH,oBAAY,qBAAqB,GAAG,mBAAmB,GAAG;IACxD;;;;;OAKG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF,oBAAY,iBAAiB,GAAG,qBAAqB,GACnD,OAAO,CAAC,aAAa,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,cAAc,CAAC,CAAC,CAAC;AAU3E,eAAO,MAAM,OAAO,qCAInB,CAAC;AAqBF,eAAO,MAAM,QAAQ,4BAA0D,CAAC;AAEhF,eAAO,MAAM,OAAO,qCAAmB,CAAC;AACxC,eAAO,MAAM,WAAW,qCAAoB,CAAC;AAE7C,eAAO,MAAM,cAAc,kEA2C1B,CAAC"}
+{"version":3,"file":"useCursorModel.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/cursor/useCursorModel.tsx"],"names":[],"mappings":"AACA,OAAO,EAAiB,aAAa,EAAsB,MAAM,kCAAkC,CAAC;AAEpG,OAAO,EACL,SAAS,EACT,UAAU,EACV,mBAAmB,EAInB,SAAS,EACV,MAAM,sBAAsB,CAAC;AAE9B,oBAAY,WAAW,GAAG,YAAY,GAAG,UAAU,CAAC;AAEpD,oBAAY,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG;IACpD;qDACiD;IACjD,WAAW,EAAE,WAAW,CAAC;IACzB,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,oBAAY,YAAY,CAAC,CAAC,GAAG,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG;IACtD,oEAAoE;IACpE,IAAI,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IAC/B;gCAC4B;IAC5B,IAAI,IAAI,IAAI,CAAC;IACb;uCACmC;IACnC,QAAQ,IAAI,IAAI,CAAC;IACjB,mDAAmD;IACnD,KAAK,IAAI,IAAI,CAAC;IACd,kDAAkD;IAClD,IAAI,IAAI,IAAI,CAAC;CACd,CAAC;AAEF,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IAC5D,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACtB,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;CACzB;AAED,eAAO,MAAM,cAAc;;QAGvB,qEAAqE;;;;;;;QAKrE;;;;WAIG;;;;;;CAGL,CAAC;AAEH,oBAAY,qBAAqB,CAAC,CAAC,IAAI,mBAAmB,CAAC,CAAC,CAAC,GAAG;IAC9D;;;;;OAKG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,oBAAY,iBAAiB,CAAC,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,GACzD,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,OAAO,cAAc,CAAC,CAAC,CAAC;AAEjF,eAAO,MAAM,mBAAmB;;;;;;CAkD/B,CAAC;AAEF,eAAO,MAAM,cAAc,sEAyC1B,CAAC"}

package/dist/es6/tabs/lib/cursor/useCursorModel.js

@@ -10,7 +10,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 import React from 'react';
-import { createEventMap, useEventMap, assert, } from '@workday/canvas-kit-react/common';
+import { createEventMap, useEventMap, assert } from '@workday/canvas-kit-react/common';
 import { listEventMap, useListModel, } from '../list/useListModel';
 export var cursorEventMap = createEventMap()({
     guards: __assign(__assign({}, listEventMap.guards), { 
@@ -24,78 +24,79 @@ export var cursorEventMap = createEventMap()({
          */
         onGoTo: 'goTo' }),
 });
-var getFirst = function (items) {
-    return items[0];
-};
-var getLast = function (items) {
-    return items[items.length - 1];
-};
-export var getItem = function (id, items) {
-    var item = id ? items.find(function (item) { return item.id === id; }) : getFirst(items); // no id, return first item
-    assert(item, "Item not found: " + id);
-    return item;
+export var useCursorNavigation = function (state, getId) {
+    // refs for performance so that new functions aren't created every render
+    var getIdRef = React.useRef(getId);
+    var itemsRef = React.useRef(state.items);
+    var nonInteractiveIdsRef = React.useRef(state.nonInteractiveIds);
+    itemsRef.current = state.items;
+    nonInteractiveIdsRef.current = state.nonInteractiveIds;
+    // return a memoized function to prevent recreation of functions every render
+    return React.useMemo(function () {
+        var getFirst = function () { return itemsRef.current[0]; };
+        var getLast = function () { return itemsRef.current[itemsRef.current.length - 1]; };
+        var getItem = function (id) {
+            var item = id ? itemsRef.current.find(function (item) { return getIdRef.current(item) === id; }) : getFirst(); // no id, return first item
+            assert(item, "Item not found: " + id);
+            return item;
+        };
+        var getOffsetItem = function (offset) { return function (id, tries) {
+            if (tries === void 0) { tries = itemsRef.current.length; }
+            var items = itemsRef.current;
+            var item = getItem(id);
+            var getId = getIdRef.current;
+            var currentIndex = items.findIndex(function (i) { return getId(item) === getId(i); });
+            var nextIndex = currentIndex + offset;
+            if (nextIndex < 0) {
+                nextIndex = items.length - 1;
+            }
+            else if (nextIndex >= items.length) {
+                nextIndex = 0;
+            }
+            if (nonInteractiveIdsRef.current.includes(getId(items[nextIndex])) && tries > 0) {
+                // The next item is disabled, try again, but only if we haven't already tried everything.
+                // Avoid an infinite loop with `tries`
+                return getOffsetItem(offset)(getId(items[nextIndex]), tries - 1);
+            }
+            return items[nextIndex];
+        }; };
+        var getNext = getOffsetItem(1);
+        var getPrevious = getOffsetItem(-1);
+        return { getFirst: getFirst, getLast: getLast, getItem: getItem, getNext: getNext, getPrevious: getPrevious };
+    }, []);
 };
-var getOffsetItem = function (offset) { return function (id, items) {
-    var _a;
-    var item = getItem(id, items);
-    var currentIndex = items.findIndex(function (_a) {
-        var id = _a.id;
-        return item.id === id;
-    });
-    var nextIndex = currentIndex + offset;
-    if (nextIndex < 0) {
-        nextIndex = items.length - 1;
-    }
-    else if (nextIndex >= items.length) {
-        nextIndex = 0;
-    }
-    var disabledAttribute = (_a = items[nextIndex].ref.current) === null || _a === void 0 ? void 0 : _a.getAttribute('disabled');
-    if (disabledAttribute !== null || disabledAttribute === 'false') {
-        // The next item is disabled, try again
-        return getOffsetItem(offset)(items[nextIndex].id, items);
-    }
-    return items[nextIndex];
-}; };
-export var hasItems = function (items) { return items.some(function (item) { return item.ref.current; }); };
-export var getNext = getOffsetItem(1);
-export var getPrevious = getOffsetItem(-1);
 export var useCursorModel = function (config) {
     if (config === void 0) { config = {}; }
+    var _a;
     var orientation = React.useState(config.orientation || 'vertical')[0];
-    var _a = React.useState(''), cursorId = _a[0], setCursorId = _a[1];
-    var initialCurrentRef = React.useRef('');
+    var _b = React.useState(''), cursorId = _b[0], setCursorId = _b[1];
     var list = useListModel(config);
+    var initialCurrentRef = React.useRef(config.initialCursorId || ((_a = config.items) === null || _a === void 0 ? void 0 : _a.length) ? list.getId(config.items[0]) : '');
     var state = __assign(__assign({}, list.state), { orientation: orientation, cursorId: cursorId });
+    var navigation = useCursorNavigation(state, list.getId);
     var events = useEventMap(cursorEventMap, state, config, __assign(__assign({}, list.events), { registerItem: function (data) {
             // point the cursor at the first item
             if (!initialCurrentRef.current) {
-                initialCurrentRef.current = data.item.id;
+                initialCurrentRef.current = list.getId(data.item);
                 setCursorId(initialCurrentRef.current);
             }
             list.events.registerItem(data);
         },
-        unregisterItem: function (data) {
-            // move the cursor forward if the the cursor is pointing to an item that is being removed
-            if (state.cursorId === data.id && state.items.some(function (i) { return i.ref.current !== null; })) {
-                events.next();
-            }
-            list.events.unregisterItem(data);
-        },
         goTo: function (_a) {
             var id = _a.id;
             setCursorId(id);
         },
         next: function () {
-            setCursorId(getNext(state.cursorId, state.items).id);
+            setCursorId(list.getId(navigation.getNext(state.cursorId)));
         },
         previous: function () {
-            setCursorId(getPrevious(state.cursorId, state.items).id);
+            setCursorId(list.getId(navigation.getPrevious(state.cursorId)));
         },
         first: function () {
-            setCursorId(getFirst(state.items).id);
+            setCursorId(list.getId(navigation.getFirst()));
         },
         last: function () {
-            setCursorId(getLast(state.items).id);
+            setCursorId(list.getId(navigation.getLast()));
         } }));
-    return { state: state, events: events };
+    return { state: state, events: events, getId: list.getId };
 };

package/dist/es6/tabs/lib/cursor/useRovingFocus.d.ts

@@ -0,0 +1,37 @@
+import React from 'react';
+import { CursorModel } from './useCursorModel';
+export declare const orientationKeyMap: {
+    readonly horizontal: {
+        readonly ArrowLeft: "previous";
+        readonly Left: "previous";
+        readonly ArrowRight: "next";
+        readonly Right: "next";
+        readonly Home: "first";
+        readonly End: "last";
+    };
+    readonly vertical: {
+        readonly ArrowUp: "previous";
+        readonly Up: "previous";
+        readonly ArrowDown: "next";
+        readonly Down: "next";
+        readonly Home: "first";
+        readonly End: "last";
+    };
+};
+/**
+ * Handles the roving focus behavior of a Cursor model. It should be added to the element
+ * representing a list item.
+ *
+ * @see https://www.w3.org/TR/wai-aria-practices/#kbd_roving_tabindex
+ */
+export declare const useRovingFocus: <P extends {}, R>(model: CursorModel<unknown>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | React.RefObject<R> | null | undefined) => {
+    onKeyDown(event: React.KeyboardEvent<Element>): void;
+    onFocus(): void;
+    onBlur(): void;
+    id: string;
+    tabIndex: number;
+    ref: ((instance: any) => void) | React.RefObject<any> | null | undefined;
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: React.Ref<R>;
+} : {});
+//# sourceMappingURL=useRovingFocus.d.ts.map

package/dist/es6/tabs/lib/cursor/useRovingFocus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRovingFocus.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/cursor/useRovingFocus.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAC,WAAW,EAAsB,MAAM,kBAAkB,CAAC;AAElE,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;CAiBpB,CAAC;AAWX;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;;;;;;;OAsD1B,CAAC"}

package/dist/es6/tabs/lib/cursor/useRovingFocus.js

@@ -0,0 +1,84 @@
+import React from 'react';
+import { useIsRTL, createHook } from '@workday/canvas-kit-react/common';
+import { useCursorNavigation } from './useCursorModel';
+export var orientationKeyMap = {
+    horizontal: {
+        ArrowLeft: 'previous',
+        Left: 'previous',
+        ArrowRight: 'next',
+        Right: 'next',
+        Home: 'first',
+        End: 'last',
+    },
+    vertical: {
+        ArrowUp: 'previous',
+        Up: 'previous',
+        ArrowDown: 'next',
+        Down: 'next',
+        Home: 'first',
+        End: 'last',
+    },
+};
+var rightToLeftMap = {
+    ArrowLeft: 'ArrowRight',
+    Left: 'Right',
+    ArrowRight: 'ArrowLeft',
+    Right: 'Left',
+    Home: 'End',
+    End: 'Home',
+};
+/**
+ * Handles the roving focus behavior of a Cursor model. It should be added to the element
+ * representing a list item.
+ *
+ * @see https://www.w3.org/TR/wai-aria-practices/#kbd_roving_tabindex
+ */
+export var useRovingFocus = createHook(function (_a, ref, elemProps) {
+    var state = _a.state, events = _a.events, getId = _a.getId;
+    if (elemProps === void 0) { elemProps = {}; }
+    // Tracks when this element has focus. If this item is removed while still focused, we have to
+    // inform the model to move the cursor to the next item.
+    var focusRef = React.useRef(false);
+    var getIdRef = React.useRef(getId);
+    // Create a ref out of state. We don't want to watch state on unmount, so we use a ref to get the
+    // current value at the time of unmounting. Otherwise, `state.items` would be a cached value of an
+    // empty array
+    var stateRef = React.useRef(state);
+    stateRef.current = state;
+    var keyDownRef = React.useRef(false);
+    var isRTL = useIsRTL();
+    var navigation = useCursorNavigation(state, getId);
+    React.useEffect(function () {
+        var _a;
+        if (keyDownRef.current) {
+            var item = navigation.getItem(state.cursorId);
+            (_a = document.querySelector("#" + state.id + "-" + getIdRef.current(item))) === null || _a === void 0 ? void 0 : _a.focus();
+            keyDownRef.current = false;
+        }
+    }, [state.cursorId, state.id, navigation]);
+    return {
+        onKeyDown: function (event) {
+            Object.keys(orientationKeyMap[state.orientation]).forEach(function (key) {
+                var _a;
+                if (isRTL ? event.key === rightToLeftMap[key] : event.key === key) {
+                    var event_1 = orientationKeyMap[state.orientation][key];
+                    keyDownRef.current = true;
+                    (_a = events[event_1]) === null || _a === void 0 ? void 0 : _a.call(events);
+                }
+            });
+        },
+        onFocus: function () {
+            focusRef.current = true;
+        },
+        onBlur: function () {
+            focusRef.current = false;
+        },
+        id: state.id + "-" + elemProps.name,
+        tabIndex: !state.cursorId
+            ? 0 // cursor isn't known yet, be safe and mark this as focusable
+            : !!elemProps.name && state.cursorId === elemProps.name
+                ? 0 // A name is known and cursor is here
+                : -1,
+        ref: ref,
+    };
+});

package/dist/es6/tabs/lib/list/index.d.ts

@@ -1,3 +1,4 @@
-export * from './hooks';
+export * from './useListRegisterItem';
 export * from './useListModel';
+export * from './renderItem';
 //# sourceMappingURL=index.d.ts.map

package/dist/es6/tabs/lib/list/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/list/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/list/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC"}

package/dist/es6/tabs/lib/list/index.js

@@ -1,2 +1,3 @@
-export * from './hooks';
+export * from './useListRegisterItem';
 export * from './useListModel';
+export * from './renderItem';

package/dist/es6/tabs/lib/list/renderItem.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { ListModel } from './useListModel';
+export declare function useRenderItems<T>(model: ListModel<T>, children: ((item: T) => React.ReactNode) | React.ReactNode): {} | null | undefined;
+//# sourceMappingURL=renderItem.d.ts.map

package/dist/es6/tabs/lib/list/renderItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderItem.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/list/renderItem.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AAEzC,wBAAgB,cAAc,CAAC,CAAC,EAC9B,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EACnB,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,SAAS,yBAY3D"}

package/dist/es6/tabs/lib/list/renderItem.js

@@ -0,0 +1,12 @@
+import React from 'react';
+export function useRenderItems(model, children) {
+    var items = React.useMemo(function () {
+        return typeof children === 'function'
+            ? model.state.items.map(function (item) { return React.cloneElement(children(item), { key: model.getId(item) }); })
+            : null;
+        // If we added `children` as a dependency, this memo would be useless. If the user wants the
+        // item to rerender, the item and items array needs to be updated.
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [model.state.items]);
+    return items || children;
+}

package/dist/es6/tabs/lib/list/useListModel.d.ts

@@ -1,22 +1,25 @@
 import React from 'react';
 import { Model, ToModelConfig } from '@workday/canvas-kit-react/common';
-export declare type Item = {
-    /** IDREF of the list. Children ids can be derived from this id */
-    id: string;
-    ref: React.RefObject<HTMLElement>;
-};
-export declare type ListState = {
+export declare type ListState<T = unknown> = {
     /** IDREF of the list. Children ids can be derived from this id */
     id: string;
     /** Used as an auto-incrementing ID for accessibility */
     indexRef: React.RefObject<number>;
-    items: Item[];
+    items: T[];
+    /**
+     * An array of ids of non-interactive elements. Non-interactive elements usually have `disabled`
+     * applied to them and thus are not focusable by the browser. Lists need to know about these so
+     * that keyboard navigation properly skips over these items. Interactive elements that are
+     * disabled should use `[aria-disabled]` instead and should still receive focus.
+     * @see https://www.w3.org/TR/wai-aria-practices-1.1/#kbd_disabled_controls
+     */
+    nonInteractiveIds: string[];
 };
-export declare type ListEvents = {
+export declare type ListEvents<T = unknown> = {
     /** 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: Item;
+        item: T;
         index?: number;
     }): void;
     /** Unregister an item by its identifier. This should be called when the component is unmounted */
@@ -29,7 +32,9 @@ export declare type ListEvents = {
         index: number;
     }): void;
 };
-export declare type ListModel = Model<ListState, ListEvents>;
+export interface ListModel<T = unknown> extends Model<ListState<T>, ListEvents<T>> {
+    getId: (item: T) => string;
+}
 export declare const listEventMap: {
     guards: {
         /**
@@ -72,10 +77,17 @@ export declare const listEventMap: {
         onUpdateItemPosition: "updateItemPosition";
     };
 };
-export declare type BaseListModelConfig = {
+export declare type BaseListModelConfig<T = unknown> = {
     /** IDREF of the list. Children ids can be derived from this id */
     id?: string;
+    items?: T[];
+    getId?: (item: T) => string;
+    /**
+     * Array of all ids which are currently disabled
+     */
+    nonInteractiveIds?: string[];
 };
-export declare type ListModelConfig = BaseListModelConfig & Partial<ToModelConfig<ListState, ListEvents, typeof listEventMap>>;
-export declare const useListModel: (config?: ListModelConfig) => Model<ListState, ListEvents>;
+export declare type ListModelConfig<T> = BaseListModelConfig<T> & Partial<ToModelConfig<ListState<T>, ListEvents<T>, typeof listEventMap>>;
+export declare const defaultGetId: (item: any) => string;
+export declare const useListModel: <T extends unknown>(config?: ListModelConfig<T>) => ListModel<T>;
 //# sourceMappingURL=useListModel.d.ts.map

package/dist/es6/tabs/lib/list/useListModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useListModel.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/list/useListModel.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAEL,KAAK,EACL,aAAa,EAGd,MAAM,kCAAkC,CAAC;AAE1C,oBAAY,IAAI,GAAG;IACjB,kEAAkE;IAClE,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;CACnC,CAAC;AAEF,oBAAY,SAAS,GAAG;IACtB,kEAAkE;IAClE,EAAE,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAClC,KAAK,EAAE,IAAI,EAAE,CAAC;CACf,CAAC;AAEF,oBAAY,UAAU,GAAG;IACvB;yBACqB;IACrB,YAAY,CAAC,IAAI,EAAE;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IACvD,kGAAkG;IAClG,cAAc,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IACzC,yGAAyG;IACzG,kBAAkB,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;CAC7D,CAAC;AAEF,oBAAY,SAAS,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AAErD,eAAO,MAAM,YAAY;;QAErB;;;aAGK;;QAEL;;;WAGG;;QAEH;;;WAGG;;;;QAIH;;;;;WAKG;;QAEH;;;;;WAKG;;QAEH;;;;;WAKG;;;CAGL,CAAC;AAEH,oBAAY,mBAAmB,GAAG;IAChC,kEAAkE;IAClE,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,oBAAY,eAAe,GAAG,mBAAmB,GAC/C,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,YAAY,CAAC,CAAC,CAAC;AAErE,eAAO,MAAM,YAAY,4DAsCxB,CAAC"}
+{"version":3,"file":"useListModel.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/list/useListModel.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAEL,KAAK,EACL,aAAa,EAId,MAAM,kCAAkC,CAAC;AAE1C,oBAAY,SAAS,CAAC,CAAC,GAAG,OAAO,IAAI;IACnC,kEAAkE;IAClE,EAAE,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAClC,KAAK,EAAE,CAAC,EAAE,CAAC;IACX;;;;;;OAMG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B,CAAC;AAEF,oBAAY,UAAU,CAAC,CAAC,GAAG,OAAO,IAAI;IACpC;yBACqB;IACrB,YAAY,CAAC,IAAI,EAAE;QAAC,IAAI,EAAE,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IACpD,kGAAkG;IAClG,cAAc,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IACzC,yGAAyG;IACzG,kBAAkB,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;CAC7D,CAAC;AAEF,MAAM,WAAW,SAAS,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAChF,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;CAC5B;AAKD,eAAO,MAAM,YAAY;;QAErB;;;aAGK;;QAEL;;;WAGG;;QAEH;;;WAGG;;;;QAIH;;;;;WAKG;;QAEH;;;;;WAKG;;QAEH;;;;;WAKG;;;CAGL,CAAC;AAEH,oBAAY,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI;IAC7C,kEAAkE;IAClE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;IACZ,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B,CAAC;AAEF,oBAAY,eAAe,CAAC,CAAC,IAAI,mBAAmB,CAAC,CAAC,CAAC,GACrD,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,YAAY,CAAC,CAAC,CAAC;AAE3E,eAAO,MAAM,YAAY,uBAGxB,CAAC;AAEF,eAAO,MAAM,YAAY,kEA4CxB,CAAC"}

package/dist/es6/tabs/lib/list/useListModel.js

@@ -6,7 +6,10 @@ var __spreadArrays = (this && this.__spreadArrays) || function () {
     return r;
 };
 import React from 'react';
-import { createEventMap, useEventMap, useUniqueId, } from '@workday/canvas-kit-react/common';
+import { createEventMap, useEventMap, useUniqueId, assert, } from '@workday/canvas-kit-react/common';
+// We don't have a way of knowing what the generic could be, so we leave it as `unknown`. It will
+// probably need to be cast to the generic in use inside extending models. This will not effect the
+// use of the model in an application, only in models composing this model.
 export var listEventMap = createEventMap()({
     guards: {
         /**
@@ -49,12 +52,22 @@ export var listEventMap = createEventMap()({
         onUpdateItemPosition: 'updateItemPosition',
     },
 });
+export var defaultGetId = function (item) {
+    assert(item.id, 'A list item must have an `id` field or a `getId` function defined');
+    return item.id;
+};
 export var useListModel = function (config) {
     if (config === void 0) { config = {}; }
     var id = useUniqueId(config.id);
     var indexRef = React.useRef(0);
-    var _a = React.useState([]), items = _a[0], setItems = _a[1];
-    var state = { id: id, items: items, indexRef: indexRef };
+    var _a = React.useState(config.items || []), items = _a[0], setItems = _a[1];
+    var getId = config.getId || defaultGetId;
+    var state = {
+        id: id,
+        items: config.items || items,
+        indexRef: indexRef,
+        nonInteractiveIds: config.nonInteractiveIds || [],
+    };
     var events = useEventMap(listEventMap, state, config, {
         registerItem: function (_a) {
             var item = _a.item, index = _a.index;
@@ -71,8 +84,8 @@ export var useListModel = function (config) {
         unregisterItem: function (_a) {
             var id = _a.id;
             setItems(function (items) {
-                if (items.find(function (item) { return item.id === id; })) {
-                    return items.filter(function (item) { return item.id !== id; });
+                if (items.find(function (item) { return getId(item) === id; })) {
+                    return items.filter(function (item) { return getId(item) !== id; });
                 }
                 else {
                     return items;
@@ -82,11 +95,11 @@ export var useListModel = function (config) {
         updateItemPosition: function (_a) {
             var id = _a.id, index = _a.index;
             setItems(function (items) {
-                var copy = items.filter(function (item) { return item.id !== id; });
-                copy.splice(index, 0, items.find(function (item) { return item.id === id; }));
+                var copy = items.filter(function (item) { return getId(item) !== id; });
+                copy.splice(index, 0, items.find(function (item) { return getId(item) === id; }));
                 return copy;
             });
         },
     });
-    return { state: state, events: events };
+    return { state: state, events: events, getId: getId };
 };

package/dist/es6/tabs/lib/list/useListRegisterItem.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import { ListModel } from './useListModel';
+/**
+ * Registers an item with a list. It will return elemProps with a `name` which can be used by other
+ * hooks to identify the item in the list.
+ */
+export declare const useListRegisterItem: <P extends {}, R>(model: ListModel<unknown>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | React.RefObject<R> | null | undefined) => {
+    'data-name': string;
+    name: string;
+    disabled: boolean | undefined;
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: React.Ref<R>;
+} : {});
+//# sourceMappingURL=useListRegisterItem.d.ts.map

package/dist/es6/tabs/lib/list/useListRegisterItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useListRegisterItem.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/list/useListRegisterItem.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;OA0C/B,CAAC"}

package/dist/es6/tabs/lib/list/useListRegisterItem.js

@@ -0,0 +1,41 @@
+import React from 'react';
+import { useMountLayout, createHook } from '@workday/canvas-kit-react/common';
+/**
+ * Registers an item with a list. It will return elemProps with a `name` which can be used by other
+ * hooks to identify the item in the list.
+ */
+export var useListRegisterItem = createHook(function (_a, _, elemProps) {
+    var state = _a.state, events = _a.events, getId = _a.getId;
+    if (elemProps === void 0) { elemProps = {}; }
+    var _b = React.useState(elemProps.name || ''), localId = _b[0], setLocalId = _b[1];
+    var firstRender = React.useRef(true);
+    React.useLayoutEffect(function () {
+        if (elemProps.index !== undefined && !firstRender.current) {
+            events.updateItemPosition({ id: localId, index: elemProps.index });
+        }
+        // we only care about the index changing
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [elemProps.index]);
+    useMountLayout(function () {
+        var defaultId = state.indexRef.current;
+        var itemId = elemProps.name || String(defaultId);
+        // bail early if item already exists. This happens if items were already provided.
+        if (state.items.find(function (item) { return getId(item) === elemProps.name; })) {
+            return;
+        }
+        events.registerItem({
+            item: { id: itemId },
+            index: elemProps.index,
+        });
+        setLocalId(itemId);
+        firstRender.current = false;
+        return function () {
+            events.unregisterItem({ id: itemId });
+        };
+    });
+    return {
+        'data-name': localId,
+        name: localId,
+        disabled: elemProps.disabled || state.nonInteractiveIds.includes(localId) ? true : undefined,
+    };
+});