@workday/canvas-kit-react 5.3.0 → 5.3.4

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

@@ -1,14 +1,14 @@
-import { ToModelConfig } from '@workday/canvas-kit-react/common';
-import { ListState, ListEvents, BaseListModelConfig, ListModel } from '../list/useListModel';
+import { Model, ToModelConfig } from '@workday/canvas-kit-react/common';
+import { ListState, ListEvents, BaseListModelConfig, Item } from '../list/useListModel';
 export declare type Orientation = 'horizontal' | 'vertical';
-export declare type CursorState<T = unknown> = ListState<T> & {
+export declare type CursorState = ListState & {
     /** 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<T = unknown> = ListEvents<T> & {
+export declare type CursorEvents = ListEvents & {
     /** Directly sets the cursor to the list item by its identifier.  */
     goTo(data: {
         id: string;
@@ -24,10 +24,7 @@ export declare type CursorEvents<T = unknown> = ListEvents<T> & {
     /** Set the cursor to the last item in the list */
     last(): void;
 };
-export interface CursorModel<T = unknown> extends ListModel<T> {
-    state: CursorState<T>;
-    events: CursorEvents<T>;
-}
+export declare type CursorModel = Model<CursorState, CursorEvents>;
 export declare const cursorEventMap: {
     guards: {
         /** Should a cursor position be set? Use only in advance use-cases */
@@ -48,26 +45,19 @@ export declare const cursorEventMap: {
         onUpdateItemPosition: "updateItemPosition";
     };
 };
-export declare type BaseCursorModelConfig<T> = BaseListModelConfig<T> & {
+export declare type BaseCursorModelConfig = BaseListModelConfig & {
     /**
      * The orientation of a list of items. Values are either `vertical` or `horizontal`. This value will
-     * effect which ids activate progression through a list. For example, `horizontal` will activate with
+     * effect which keys 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 const useCursorModel: <T extends unknown>(config?: CursorModelConfig<T>) => CursorModel<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>;
 //# sourceMappingURL=useCursorModel.d.ts.map

package/dist/commonjs/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,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"}
+{"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"}

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

@@ -29,79 +29,78 @@ exports.cursorEventMap = common_1.createEventMap()({
          */
         onGoTo: 'goTo' }),
 });
-exports.useCursorNavigation = function (state, getId) {
-    // refs for performance so that new functions aren't created every render
-    var getIdRef = react_1.default.useRef(getId);
-    var itemsRef = react_1.default.useRef(state.items);
-    var nonInteractiveIdsRef = react_1.default.useRef(state.nonInteractiveIds);
-    itemsRef.current = state.items;
-    nonInteractiveIdsRef.current = state.nonInteractiveIds;
-    // return a memoized function to prevent recreation of functions every render
-    return react_1.default.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
-            common_1.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 getFirst = function (items) {
+    return items[0];
+};
+var getLast = function (items) {
+    return items[items.length - 1];
+};
+exports.getItem = function (id, items) {
+    var item = id ? items.find(function (item) { return item.id === id; }) : getFirst(items); // no id, return first item
+    common_1.assert(item, "Item not found: " + id);
+    return item;
 };
+var getOffsetItem = function (offset) { return function (id, items) {
+    var _a;
+    var item = exports.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];
+}; };
+exports.hasItems = function (items) { return items.some(function (item) { return item.ref.current; }); };
+exports.getNext = getOffsetItem(1);
+exports.getPrevious = getOffsetItem(-1);
 exports.useCursorModel = function (config) {
     if (config === void 0) { config = {}; }
-    var _a;
     var orientation = react_1.default.useState(config.orientation || 'vertical')[0];
-    var _b = react_1.default.useState(''), cursorId = _b[0], setCursorId = _b[1];
+    var _a = react_1.default.useState(''), cursorId = _a[0], setCursorId = _a[1];
+    var initialCurrentRef = react_1.default.useRef('');
     var list = useListModel_1.useListModel(config);
-    var initialCurrentRef = react_1.default.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 = exports.useCursorNavigation(state, list.getId);
     var events = common_1.useEventMap(exports.cursorEventMap, state, config, __assign(__assign({}, list.events), { registerItem: function (data) {
             // point the cursor at the first item
             if (!initialCurrentRef.current) {
-                initialCurrentRef.current = list.getId(data.item);
+                initialCurrentRef.current = data.item.id;
                 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(list.getId(navigation.getNext(state.cursorId)));
+            setCursorId(exports.getNext(state.cursorId, state.items).id);
         },
         previous: function () {
-            setCursorId(list.getId(navigation.getPrevious(state.cursorId)));
+            setCursorId(exports.getPrevious(state.cursorId, state.items).id);
         },
         first: function () {
-            setCursorId(list.getId(navigation.getFirst()));
+            setCursorId(getFirst(state.items).id);
         },
         last: function () {
-            setCursorId(list.getId(navigation.getLast()));
+            setCursorId(getLast(state.items).id);
         } }));
-    return { state: state, events: events, getId: list.getId };
+    return { state: state, events: events };
 };

package/dist/commonjs/tabs/lib/hooks.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+/**
+ * Reset the cursor to the active tab when the tab list looses focus
+ */
+export declare const useResetCursorOnBlur: ({ state, events }: import("../../common").Model<import("./useTabsModel").TabsState, import("./useTabsModel").TabsEvents>, elemProps?: {}) => {
+    onKeyDown(event: React.KeyboardEvent<Element>): void;
+    onFocus(): void;
+    onBlur(): void;
+};
+//# sourceMappingURL=hooks.d.ts.map

package/dist/commonjs/tabs/lib/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../tabs/lib/hooks.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;CAqBhC,CAAC"}

package/dist/commonjs/tabs/lib/{selection/useResetCursorOnBlur.js → hooks.js}

@@ -5,17 +5,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var react_1 = __importDefault(require("react"));
 var common_1 = require("@workday/canvas-kit-react/common");
-var cursor_1 = require("../cursor");
+var hooks_1 = require("./cursor/hooks");
 /**
- * Reset the cursor to the selected item when the list looses focus
+ * Reset the cursor to the active tab when the tab list looses focus
  */
-exports.useResetCursorOnBlur = common_1.createHook(function (_a) {
+exports.useResetCursorOnBlur = function (_a, elemProps) {
     var state = _a.state, events = _a.events;
+    if (elemProps === void 0) { elemProps = {}; }
     var programmaticFocusRef = react_1.default.useRef(false);
-    return {
+    return common_1.mergeProps({
         onKeyDown: function (event) {
             // Programmatic focus only on any focus change via keyboard
-            if (Object.keys(cursor_1.orientationKeyMap[state.orientation]).indexOf(event.key) !== -1) {
+            if (Object.keys(hooks_1.orientationKeyMap[state.orientation]).indexOf(event.key) !== -1) {
                 programmaticFocusRef.current = true;
             }
         },
@@ -24,8 +25,8 @@ exports.useResetCursorOnBlur = common_1.createHook(function (_a) {
         },
         onBlur: function () {
             if (!programmaticFocusRef.current) {
-                events.goTo({ id: state.selectedIds[0] });
+                events.goTo({ id: state.activeTab });
             }
         },
-    };
-});
+    }, elemProps);
+};

package/dist/commonjs/tabs/lib/list/hooks.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+/**
+ * Handle list registration. Returns an identifier used to identify this item in the list
+ * @param model A ListModel
+ * @param localRef A RefObject that will be used to register an item
+ * @param id Desired identifier for the List Model. If not provided, it will fall back to the index
+ * in the list
+ * @param index (Optional) Specify the position of the item if the order is expected to change
+ */
+export declare const useRegisterItem: ({ state, events }: import("../../../common").Model<import("./useListModel").ListState, import("./useListModel").ListEvents>, localRef: React.RefObject<any>, id?: string, index?: number | undefined) => string;
+//# sourceMappingURL=hooks.d.ts.map

package/dist/commonjs/tabs/lib/list/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/list/hooks.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAM1B;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,kNA8B3B,CAAC"}

package/dist/commonjs/tabs/lib/list/hooks.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = __importDefault(require("react"));
+var common_1 = require("@workday/canvas-kit-react/common");
+/**
+ * Handle list registration. Returns an identifier used to identify this item in the list
+ * @param model A ListModel
+ * @param localRef A RefObject that will be used to register an item
+ * @param id Desired identifier for the List Model. If not provided, it will fall back to the index
+ * in the list
+ * @param index (Optional) Specify the position of the item if the order is expected to change
+ */
+exports.useRegisterItem = function (_a, localRef, id, index) {
+    var state = _a.state, events = _a.events;
+    if (id === void 0) { id = ''; }
+    var _b = react_1.default.useState(id), localId = _b[0], setLocalId = _b[1];
+    var firstRender = react_1.default.useRef(true);
+    react_1.default.useLayoutEffect(function () {
+        if (index !== undefined && !firstRender.current) {
+            events.updateItemPosition({ id: localId, index: index });
+        }
+        // we only care about the index changing
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [index]);
+    common_1.useMountLayout(function () {
+        var defaultId = state.indexRef.current;
+        var itemId = id || String(defaultId);
+        events.registerItem({ item: { id: itemId, ref: localRef }, index: index });
+        setLocalId(itemId);
+        firstRender.current = false;
+        return function () {
+            events.unregisterItem({ id: itemId });
+        };
+    });
+    return localId;
+};

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

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

package/dist/commonjs/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,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/list/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC"}

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

@@ -3,6 +3,5 @@ function __export(m) {
     for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
 }
 Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./useListRegisterItem"));
+__export(require("./hooks"));
 __export(require("./useListModel"));
-__export(require("./renderItem"));

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

@@ -1,25 +1,22 @@
 import React from 'react';
 import { Model, ToModelConfig } from '@workday/canvas-kit-react/common';
-export declare type ListState<T = unknown> = {
+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 = {
     /** 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: 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[];
+    items: Item[];
 };
-export declare type ListEvents<T = unknown> = {
+export declare type ListEvents = {
     /** 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: T;
+        item: Item;
         index?: number;
     }): void;
     /** Unregister an item by its identifier. This should be called when the component is unmounted */
@@ -32,9 +29,7 @@ export declare type ListEvents<T = unknown> = {
         index: number;
     }): void;
 };
-export interface ListModel<T = unknown> extends Model<ListState<T>, ListEvents<T>> {
-    getId: (item: T) => string;
-}
+export declare type ListModel = Model<ListState, ListEvents>;
 export declare const listEventMap: {
     guards: {
         /**
@@ -77,17 +72,10 @@ export declare const listEventMap: {
         onUpdateItemPosition: "updateItemPosition";
     };
 };
-export declare type BaseListModelConfig<T = unknown> = {
+export declare type BaseListModelConfig = {
     /** 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<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>;
+export declare type ListModelConfig = BaseListModelConfig & Partial<ToModelConfig<ListState, ListEvents, typeof listEventMap>>;
+export declare const useListModel: (config?: ListModelConfig) => Model<ListState, ListEvents>;
 //# sourceMappingURL=useListModel.d.ts.map

package/dist/commonjs/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,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"}
+{"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"}

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

@@ -12,9 +12,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var react_1 = __importDefault(require("react"));
 var common_1 = require("@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.
 exports.listEventMap = common_1.createEventMap()({
     guards: {
         /**
@@ -57,22 +54,12 @@ exports.listEventMap = common_1.createEventMap()({
         onUpdateItemPosition: 'updateItemPosition',
     },
 });
-exports.defaultGetId = function (item) {
-    common_1.assert(item.id, 'A list item must have an `id` field or a `getId` function defined');
-    return item.id;
-};
 exports.useListModel = function (config) {
     if (config === void 0) { config = {}; }
     var id = common_1.useUniqueId(config.id);
     var indexRef = react_1.default.useRef(0);
-    var _a = react_1.default.useState(config.items || []), items = _a[0], setItems = _a[1];
-    var getId = config.getId || exports.defaultGetId;
-    var state = {
-        id: id,
-        items: config.items || items,
-        indexRef: indexRef,
-        nonInteractiveIds: config.nonInteractiveIds || [],
-    };
+    var _a = react_1.default.useState([]), items = _a[0], setItems = _a[1];
+    var state = { id: id, items: items, indexRef: indexRef };
     var events = common_1.useEventMap(exports.listEventMap, state, config, {
         registerItem: function (_a) {
             var item = _a.item, index = _a.index;
@@ -89,8 +76,8 @@ exports.useListModel = function (config) {
         unregisterItem: function (_a) {
             var id = _a.id;
             setItems(function (items) {
-                if (items.find(function (item) { return getId(item) === id; })) {
-                    return items.filter(function (item) { return getId(item) !== id; });
+                if (items.find(function (item) { return item.id === id; })) {
+                    return items.filter(function (item) { return item.id !== id; });
                 }
                 else {
                     return items;
@@ -100,11 +87,11 @@ exports.useListModel = function (config) {
         updateItemPosition: function (_a) {
             var id = _a.id, index = _a.index;
             setItems(function (items) {
-                var copy = items.filter(function (item) { return getId(item) !== id; });
-                copy.splice(index, 0, items.find(function (item) { return getId(item) === id; }));
+                var copy = items.filter(function (item) { return item.id !== id; });
+                copy.splice(index, 0, items.find(function (item) { return item.id === id; }));
                 return copy;
             });
         },
     });
-    return { state: state, events: events, getId: getId };
+    return { state: state, events: events };
 };

package/dist/commonjs/tabs/lib/useTabsModel.d.ts

@@ -1,70 +1,70 @@
-import { ToModelConfig } from '@workday/canvas-kit-react/common';
-import { Orientation } from './cursor';
-import { ListEvents, ListState } from './list';
-import { MenuModel, MenuModelConfig } from './menu';
-import { OverflowEvents, OverflowState, BaseOverflowModelConfig, OverflowModel } from './overflow';
-export declare type TabsState<T> = OverflowState<T> & {
-    /** IDREF of the list. Children ids can be derived from this id */
-    id: string;
+import { Model, ToModelConfig } from '@workday/canvas-kit-react/common';
+import { CursorState, CursorEvents, BaseCursorModelConfig, Orientation } from './cursor/useCursorModel';
+import { Item, ListEvents, ListState } from './list/useListModel';
+export declare type TabsState = CursorState & {
+    /**
+     * The name of the active tab provided to the `Tabs.Item` component. If no name is provided, it
+     * will be a string of the index position.
+     */
+    activeTab: string;
     /**
      * A list of panels. Uses `ListModel`
      */
-    panels: T[];
+    panels: Item[];
     /**
      * A React.Ref of the current item index. A ref is used to allow for updating outside the normal
      * React state cycle to ensure accurate index tracking as items are registered within the same
      * state setting phase.
      */
-    panelIndexRef: ListState<T>['indexRef'];
-    orientation: Orientation;
-    getId: (item: T) => string;
+    panelIndexRef: ListState['indexRef'];
 };
-export declare type TabsEvents<T = unknown> = OverflowEvents<T> & {
+export declare type TabsEvents = CursorEvents & {
+    /**
+     * This event will set the `activeTab` in the state. Called when a user activates a tab
+     */
+    activate(data: {
+        /**
+         * The name of the tab provided to the `Tabs.Item` component. If no name is provided, it will
+         * be a string of the index position
+         */
+        tab: string;
+    }): void;
     /**
      * This event registers panels with state.panels. Called when a panel is mounted.
      */
-    registerPanel: ListEvents<T>['registerItem'];
+    registerPanel: ListEvents['registerItem'];
     /**
      * This event unregisters panels with state.panels. Called when a panel is unmounted.
      */
-    unregisterPanel: ListEvents<T>['unregisterItem'];
+    unregisterPanel: ListEvents['unregisterItem'];
 };
-export interface TabsModel<T = unknown> extends OverflowModel<T> {
-    state: TabsState<T>;
-    events: TabsEvents<T>;
-    menu: MenuModel<T>;
-}
+export declare type TabsModel = Model<TabsState, TabsEvents>;
 export declare const tabEventMap: {
     guards: {
-        shouldSetContainerWidth: "setContainerWidth";
-        shouldSetOverflowTargetWidth: "setOverflowTargetWidth";
-        shouldAddItemWidth: "addItemWidth";
-        shouldRemoveItemWidth: "removeItemWidth";
-        shouldAddHiddenKey: "addHiddenKey";
-        shouldRemoveHiddenKey: "removeHiddenKey";
-        shouldSelect: "select"; /**
-         * This event unregisters panels with state.panels. Called when a panel is unmounted.
+        /**
+         * Should the tab activate? Can prevent the tab from activating. Use this only for advanced
+         * use-cases.
          */
+        shouldActivate: "activate";
         shouldGoTo: "goTo";
         shouldRegisterItem: "registerItem";
         shouldUnregisterItem: "unregisterItem";
         shouldUpdateItemPosition: "updateItemPosition";
     };
     callbacks: {
-        onSetContainerWidth: "setContainerWidth";
-        onSetOverflowTargetWidth: "setOverflowTargetWidth";
-        onAddItemWidth: "addItemWidth";
-        onRemoveItemWidth: "removeItemWidth";
-        onAddHiddenKey: "addHiddenKey";
-        onRemoveHiddenKey: "removeHiddenKey";
-        onSelect: "select";
+        /**
+         * This callback will fire whenever a tab is activated. The data will contain the tab's named
+         * passed to the `Tabs.Item` component. If no name was passed, it will be the index of the tab
+         * as a string.
+         */
+        onActivate: "activate";
         onGoTo: "goTo";
         onRegisterItem: "registerItem";
         onUnregisterItem: "unregisterItem";
         onUpdateItemPosition: "updateItemPosition";
     };
 };
-export declare type BaseTabsModelConfig<T> = Omit<BaseOverflowModelConfig<T>, 'orientation'> & {
+export declare type BaseTabsModelConfig = Omit<BaseCursorModelConfig, 'orientation'> & {
     /**
      * Optional id for the whole `Tabs` group. The `aria-controls` of the `Tab.Item` and `id` of the
      * `Tab.Panel` will automatically derived from this id. If not provided, a unique id will be
@@ -83,8 +83,7 @@ export declare type BaseTabsModelConfig<T> = Omit<BaseOverflowModelConfig<T>, 'o
      * @default 'horizontal'
      */
     orientation?: Orientation;
-    menuConfig?: MenuModelConfig<T>;
 };
-export declare type TabsModelConfig<T> = BaseTabsModelConfig<T> & Partial<ToModelConfig<TabsState<T>, TabsEvents<T>, typeof tabEventMap>>;
-export declare const useTabsModel: <T extends unknown>(config?: TabsModelConfig<T>) => TabsModel<T>;
+export declare type TabsModelConfig = BaseTabsModelConfig & Partial<ToModelConfig<TabsState, TabsEvents, typeof tabEventMap>>;
+export declare const useTabsModel: (config?: TabsModelConfig) => Model<TabsState, TabsEvents>;
 //# sourceMappingURL=useTabsModel.d.ts.map

package/dist/commonjs/tabs/lib/useTabsModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useTabsModel.d.ts","sourceRoot":"","sources":["../../../../tabs/lib/useTabsModel.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,aAAa,EAGd,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAC,WAAW,EAAC,MAAM,UAAU,CAAC;AACrC,OAAO,EAAe,UAAU,EAAE,SAAS,EAAe,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAC,SAAS,EAAE,eAAe,EAAe,MAAM,QAAQ,CAAC;AAChE,OAAO,EAEL,cAAc,EACd,aAAa,EAEb,uBAAuB,EAEvB,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB,oBAAY,SAAS,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG;IAC5C,kEAAkE;IAClE,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,MAAM,EAAE,CAAC,EAAE,CAAC;IACZ;;;;OAIG;IACH,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IACxC,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC;CAC5B,CAAC;AAEF,oBAAY,UAAU,CAAC,CAAC,GAAG,OAAO,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG;IACxD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;IAC7C;;OAEG;IACH,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,WAAW,SAAS,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;IAC9D,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACpB,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IACtB,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;CACpB;AAED,eAAO,MAAM,WAAW;;;;;;;;gCAZtB;;WAEG;;;;;;;;;;;;;;;;;;;CAiBH,CAAC;AAEH,oBAAY,mBAAmB,CAAC,CAAC,IAAI,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,GAAG;IACrF;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,UAAU,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;CACjC,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,WAAW,CAAC,CAAC,CAAC;AAE1E,eAAO,MAAM,YAAY,kEAwExB,CAAC"}
+{"version":3,"file":"useTabsModel.d.ts","sourceRoot":"","sources":["../../../../tabs/lib/useTabsModel.tsx"],"names":[],"mappings":"AACA,OAAO,EAAiB,KAAK,EAAE,aAAa,EAAc,MAAM,kCAAkC,CAAC;AACnG,OAAO,EACL,WAAW,EACX,YAAY,EAGZ,qBAAqB,EACrB,WAAW,EAGZ,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAe,MAAM,qBAAqB,CAAC;AAE9E,oBAAY,SAAS,GAAG,WAAW,GAAG;IACpC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,IAAI,EAAE,CAAC;IACf;;;;OAIG;IACH,aAAa,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;CACtC,CAAC;AAEF,oBAAY,UAAU,GAAG,YAAY,GAAG;IACtC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE;QACb;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;KACb,GAAG,IAAI,CAAC;IACT;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;IAC1C;;OAEG;IACH,eAAe,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;CAC/C,CAAC;AAEF,oBAAY,SAAS,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AAErD,eAAO,MAAM,WAAW;;QAGpB;;;WAGG;;;;;;;;QAKH;;;;WAIG;;;;;;;CAGL,CAAC;AAEH,oBAAY,mBAAmB,GAAG,IAAI,CAAC,qBAAqB,EAAE,aAAa,CAAC,GAAG;IAC7E;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF,oBAAY,eAAe,GAAG,mBAAmB,GAC/C,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,WAAW,CAAC,CAAC,CAAC;AAEpE,eAAO,MAAM,YAAY,4DA8CxB,CAAC"}