@workday/canvas-kit-react 5.3.17 → 5.4.0-next.1

package/dist/commonjs/tabs/lib/overflow/useOverflowModel.d.ts

@@ -0,0 +1,69 @@
+import { ToModelConfig } from '@workday/canvas-kit-react/common';
+import { SelectionState, SelectionEvents, BaseSelectionModelConfig, selectionEventMap, SelectionModel } from '../selection';
+export declare type OverflowState<T = unknown> = SelectionState<T> & {
+    containerWidth: number;
+    overflowTargetWidth: number;
+    itemWidthCache: Record<string, number>;
+    hiddenIds: string[];
+};
+export declare type OverflowEvents<T = unknown> = SelectionEvents<T> & {
+    setContainerWidth(data: {
+        width?: number;
+    }): void;
+    setOverflowTargetWidth(data: {
+        width: number;
+    }): void;
+    addItemWidth(data: {
+        id: string;
+        width: number;
+    }): void;
+    removeItemWidth(data: {
+        id: string;
+    }): void;
+    addHiddenKey(data: {
+        id: string;
+    }): void;
+    removeHiddenKey(data: {
+        id: string;
+    }): void;
+};
+export interface OverflowModel<T = unknown> extends SelectionModel<T> {
+    state: OverflowState<T>;
+    events: OverflowEvents<T>;
+}
+export declare const overflowEventMap: {
+    guards: {
+        shouldSetContainerWidth: "setContainerWidth";
+        shouldSetOverflowTargetWidth: "setOverflowTargetWidth";
+        shouldAddItemWidth: "addItemWidth";
+        shouldRemoveItemWidth: "removeItemWidth";
+        shouldAddHiddenKey: "addHiddenKey";
+        shouldRemoveHiddenKey: "removeHiddenKey";
+        shouldSelect: "select";
+        shouldGoTo: "goTo";
+        shouldRegisterItem: "registerItem";
+        shouldUnregisterItem: "unregisterItem";
+        shouldUpdateItemPosition: "updateItemPosition";
+    };
+    callbacks: {
+        onSetContainerWidth: "setContainerWidth";
+        onSetOverflowTargetWidth: "setOverflowTargetWidth";
+        onAddItemWidth: "addItemWidth";
+        onRemoveItemWidth: "removeItemWidth";
+        onAddHiddenKey: "addHiddenKey";
+        onRemoveHiddenKey: "removeHiddenKey";
+        onSelect: "select";
+        onGoTo: "goTo";
+        onRegisterItem: "registerItem";
+        onUnregisterItem: "unregisterItem";
+        onUpdateItemPosition: "updateItemPosition";
+    };
+};
+export declare type BaseOverflowModelConfig<T> = BaseSelectionModelConfig<T> & {
+    initialHiddenIds?: string[];
+    containerWidth?: number;
+};
+export declare type OverflowModelConfig<T> = BaseOverflowModelConfig<T> & Partial<ToModelConfig<OverflowState<T>, OverflowEvents<T>, typeof selectionEventMap>>;
+export declare function getHiddenIds(containerWidth: number, overflowTargetWidth: number, itemWidthCache: Record<string, number>, selectedIds: string[] | 'all'): string[];
+export declare const useOverflowModel: <T extends unknown>(config?: OverflowModelConfig<T>) => OverflowModel<T>;
+//# sourceMappingURL=useOverflowModel.d.ts.map

package/dist/commonjs/tabs/lib/overflow/useOverflowModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOverflowModel.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/overflow/useOverflowModel.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAiB,aAAa,EAAc,MAAM,kCAAkC,CAAC;AAC5F,OAAO,EACL,cAAc,EACd,eAAe,EACf,wBAAwB,EAGxB,iBAAiB,EACjB,cAAc,EACf,MAAM,cAAc,CAAC;AAEtB,oBAAY,aAAa,CAAC,CAAC,GAAG,OAAO,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG;IAC3D,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC;AAEF,oBAAY,cAAc,CAAC,CAAC,GAAG,OAAO,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG;IAC7D,iBAAiB,CAAC,IAAI,EAAE;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IAChD,sBAAsB,CAAC,IAAI,EAAE;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IACpD,YAAY,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IACtD,eAAe,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IAC1C,YAAY,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IACvC,eAAe,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;CAC3C,CAAC;AAEF,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,cAAc,CAAC,CAAC,CAAC;IACnE,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACxB,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;CAC3B;AAED,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmB3B,CAAC;AAEH,oBAAY,uBAAuB,CAAC,CAAC,IAAI,wBAAwB,CAAC,CAAC,CAAC,GAAG;IACrE,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,oBAAY,mBAAmB,CAAC,CAAC,IAAI,uBAAuB,CAAC,CAAC,CAAC,GAC7D,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,iBAAiB,CAAC,CAAC,CAAC;AAExF,wBAAgB,YAAY,CAC1B,cAAc,EAAE,MAAM,EACtB,mBAAmB,EAAE,MAAM,EAC3B,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACtC,WAAW,EAAE,MAAM,EAAE,GAAG,KAAK,GAC5B,MAAM,EAAE,CAwCV;AAED,eAAO,MAAM,gBAAgB,0EAgG5B,CAAC"}

package/dist/commonjs/tabs/lib/overflow/useOverflowModel.js

@@ -0,0 +1,126 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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");
+var selection_1 = require("../selection");
+exports.overflowEventMap = common_1.createEventMap()({
+    guards: __assign(__assign({}, selection_1.selectionEventMap.guards), { shouldSetContainerWidth: 'setContainerWidth', shouldSetOverflowTargetWidth: 'setOverflowTargetWidth', shouldAddItemWidth: 'addItemWidth', shouldRemoveItemWidth: 'removeItemWidth', shouldAddHiddenKey: 'addHiddenKey', shouldRemoveHiddenKey: 'removeHiddenKey' }),
+    callbacks: __assign(__assign({}, selection_1.selectionEventMap.callbacks), { onSetContainerWidth: 'setContainerWidth', onSetOverflowTargetWidth: 'setOverflowTargetWidth', onAddItemWidth: 'addItemWidth', onRemoveItemWidth: 'removeItemWidth', onAddHiddenKey: 'addHiddenKey', onRemoveHiddenKey: 'removeHiddenKey' }),
+});
+function getHiddenIds(containerWidth, overflowTargetWidth, itemWidthCache, selectedIds) {
+    /** Allows us to prioritize showing the selected item */
+    var selectedKey;
+    /** Tally of combined item widths. We'll add items that fit until the container is full */
+    var itemWidth = 0;
+    /** Tally ids that won't fit inside the container. These will be used by components to hide
+     * elements that won't fit in the container */
+    var hiddenIds = [];
+    if (selectedIds !== 'all' && selectedIds.length) {
+        selectedKey = selectedIds[0];
+    }
+    if (Object.keys(itemWidthCache).reduce(function (sum, key) { return sum + itemWidthCache[key]; }, 0) <= containerWidth) {
+        // All items fit, return empty array
+        return [];
+    }
+    else if (selectedKey) {
+        if (itemWidthCache[selectedKey] + overflowTargetWidth > containerWidth) {
+            // If the selected item doesn't fit, only show overflow (all items hidden)
+            return Object.keys(itemWidthCache);
+        }
+        else {
+            // at least the selected item and overflow target fit. Update our itemWidth with the sum
+            itemWidth += itemWidthCache[selectedKey] + overflowTargetWidth;
+        }
+    }
+    else {
+        itemWidth += overflowTargetWidth;
+    }
+    for (var key in itemWidthCache) {
+        if (key !== selectedKey) {
+            itemWidth += itemWidthCache[key];
+            if (itemWidth > containerWidth) {
+                hiddenIds.push(key);
+            }
+        }
+    }
+    return hiddenIds;
+}
+exports.getHiddenIds = getHiddenIds;
+exports.useOverflowModel = function (config) {
+    if (config === void 0) { config = {}; }
+    var _a = react_1.default.useState(config.initialHiddenIds || []), hiddenIds = _a[0], setHiddenIds = _a[1];
+    var _b = react_1.default.useState({}), itemWidthCache = _b[0], setItemWidthCache = _b[1];
+    var _c = react_1.default.useState(0), containerWidth = _c[0], setContainerWidth = _c[1];
+    var containerWidthRef = react_1.default.useRef(0);
+    var itemWidthCacheRef = react_1.default.useRef(itemWidthCache);
+    var _d = react_1.default.useState(0), overflowTargetWidth = _d[0], setOverflowTargetWidth = _d[1];
+    var overflowTargetWidthRef = react_1.default.useRef(0);
+    // Cursors skip over disabled ids, but know nothing of hidden ids. We'll go ahead and disable
+    // hidden ids as well
+    var nonInteractiveIds = (config.nonInteractiveIds || []).concat(hiddenIds);
+    var model = selection_1.useSelectionModel(__assign(__assign({}, config), { nonInteractiveIds: nonInteractiveIds }));
+    var state = __assign(__assign({}, model.state), { hiddenIds: hiddenIds,
+        itemWidthCache: itemWidthCache,
+        containerWidth: containerWidth,
+        overflowTargetWidth: overflowTargetWidth });
+    var events = common_1.useEventMap(exports.overflowEventMap, state, config, __assign(__assign({}, model.events), { select: function (data) {
+            var selectedIds = model.selection.select(data.id, state).selectedIds;
+            var ids = getHiddenIds(containerWidthRef.current, overflowTargetWidthRef.current, itemWidthCacheRef.current, selectedIds);
+            model.events.select(data);
+            setHiddenIds(ids);
+        },
+        setContainerWidth: function (_a) {
+            var width = _a.width;
+            containerWidthRef.current = width || 0;
+            setContainerWidth(width || 0);
+            var ids = getHiddenIds(containerWidthRef.current, overflowTargetWidthRef.current, itemWidthCacheRef.current, state.selectedIds);
+            setHiddenIds(ids);
+        },
+        setOverflowTargetWidth: function (_a) {
+            var width = _a.width;
+            overflowTargetWidthRef.current = width;
+            setOverflowTargetWidth(width);
+        },
+        addItemWidth: function (_a) {
+            var _b;
+            var id = _a.id, width = _a.width;
+            itemWidthCacheRef.current = __assign(__assign({}, itemWidthCacheRef.current), (_b = {}, _b[id] = width, _b));
+            setItemWidthCache(itemWidthCacheRef.current);
+            var ids = getHiddenIds(containerWidthRef.current, overflowTargetWidthRef.current, itemWidthCacheRef.current, state.selectedIds);
+            setHiddenIds(ids);
+        },
+        removeItemWidth: function (_a) {
+            var id = _a.id;
+            var newCache = __assign({}, itemWidthCacheRef.current);
+            delete newCache[id];
+            itemWidthCacheRef.current = newCache;
+            setItemWidthCache(itemWidthCacheRef.current);
+            var ids = getHiddenIds(containerWidthRef.current, overflowTargetWidthRef.current, itemWidthCacheRef.current, state.selectedIds !== 'all'
+                ? state.selectedIds.filter(function (sId) { return id !== sId; })
+                : state.selectedIds);
+            setHiddenIds(ids);
+        },
+        addHiddenKey: function (_a) {
+            var id = _a.id;
+            setHiddenIds(function (ids) { return ids.concat(id); });
+        },
+        removeHiddenKey: function (_a) {
+            var id = _a.id;
+            setHiddenIds(function (ids) { return ids.filter(function (key) { return key !== id; }); });
+        } }));
+    return { state: state, events: events, selection: model.selection, getId: model.getId };
+};

package/dist/commonjs/tabs/lib/overflow/useOverflowTarget.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { OverflowModel } from './useOverflowModel';
+export declare const useOverflowTarget: <P extends {}, R>(model: OverflowModel<unknown>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | React.RefObject<R> | null | undefined) => {
+    ref: (instance: HTMLButtonElement | null) => void;
+    'aria-hidden': boolean;
+    tabIndex: number;
+    style: {};
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: React.Ref<R>;
+} : {});
+//# sourceMappingURL=useOverflowTarget.d.ts.map

package/dist/commonjs/tabs/lib/overflow/useOverflowTarget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOverflowTarget.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/overflow/useOverflowTarget.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,OAAO,EAAC,aAAa,EAAC,MAAM,oBAAoB,CAAC;AAQjD,eAAO,MAAM,iBAAiB;;;;;;;OA6B7B,CAAC"}

package/dist/commonjs/tabs/lib/overflow/useOverflowTarget.js

@@ -0,0 +1,35 @@
+"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");
+// use a hidden style instead of `hidden` attribute for measurement purposes. `hidden` elements have no dimensions
+var hiddenStyle = {
+    position: 'absolute',
+    left: -99999,
+};
+exports.useOverflowTarget = common_1.createHook(function (model, ref) {
+    var _a = common_1.useLocalRef(ref), elementRef = _a.elementRef, localRef = _a.localRef;
+    // track first render to force correct size calculations
+    var firstRender = react_1.default.useRef(true);
+    common_1.useMountLayout(function () {
+        firstRender.current = false;
+        if (localRef.current) {
+            var styles = getComputedStyle(localRef.current);
+            model.events.setOverflowTargetWidth({
+                width: localRef.current.offsetWidth +
+                    parseFloat(styles.marginLeft) +
+                    parseFloat(styles.marginRight),
+            });
+        }
+    });
+    var isHidden = !model.state.hiddenIds.length;
+    return {
+        ref: elementRef,
+        'aria-hidden': isHidden,
+        tabIndex: isHidden ? -1 : 0,
+        style: isHidden ? hiddenStyle : {},
+    };
+});

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

@@ -0,0 +1,4 @@
+export * from './useSelectionModel';
+export * from './useSelectionItem';
+export * from './useResetCursorOnBlur';
+//# sourceMappingURL=index.d.ts.map

package/dist/commonjs/tabs/lib/selection/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/selection/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC"}

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

@@ -0,0 +1,8 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./useSelectionModel"));
+__export(require("./useSelectionItem"));
+__export(require("./useResetCursorOnBlur"));

package/dist/commonjs/tabs/lib/selection/useResetCursorOnBlur.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { SelectionModel } from './useSelectionModel';
+/**
+ * Reset the cursor to the selected item when the list looses focus
+ */
+export declare const useResetCursorOnBlur: <P extends {}, R>(model: SelectionModel<unknown>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | React.RefObject<R> | null | undefined) => {
+    onKeyDown(event: React.KeyboardEvent<Element>): void;
+    onFocus(): void;
+    onBlur(): void;
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: React.Ref<R>;
+} : {});
+//# sourceMappingURL=useResetCursorOnBlur.d.ts.map

package/dist/commonjs/tabs/lib/selection/useResetCursorOnBlur.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useResetCursorOnBlur.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/selection/useResetCursorOnBlur.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,OAAO,EAAC,cAAc,EAAC,MAAM,qBAAqB,CAAC;AAEnD;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;OAkB/B,CAAC"}

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

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

package/dist/commonjs/tabs/lib/selection/useSelectionItem.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { SelectionModel } from './useSelectionModel';
+export declare const useSelectionItem: <P extends {}, R>(model: SelectionModel<unknown>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | React.RefObject<R> | null | undefined) => {
+    onClick: (event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: React.Ref<R>;
+} : {});
+//# sourceMappingURL=useSelectionItem.d.ts.map

package/dist/commonjs/tabs/lib/selection/useSelectionItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSelectionItem.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/selection/useSelectionItem.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,OAAO,EAAC,cAAc,EAAC,MAAM,qBAAqB,CAAC;AAEnD,eAAO,MAAM,gBAAgB;;;;OAmB5B,CAAC"}

package/dist/commonjs/tabs/lib/selection/useSelectionItem.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var common_1 = require("@workday/canvas-kit-react/common");
+exports.useSelectionItem = common_1.createHook(function (_a, _, elemProps) {
+    var state = _a.state, events = _a.events;
+    if (elemProps === void 0) { elemProps = {}; }
+    var name = elemProps.name || '';
+    var onClick = function (event) {
+        if (state.nonInteractiveIds.includes(name) ||
+            event.currentTarget.hasAttribute('aria-disabled')) {
+            return;
+        }
+        events.select({ id: name });
+    };
+    return { onClick: onClick };
+});

package/dist/commonjs/tabs/lib/selection/useSelectionModel.d.ts

@@ -0,0 +1,62 @@
+import { ToModelConfig } from '@workday/canvas-kit-react/common';
+import { CursorState, CursorEvents, BaseCursorModelConfig, CursorModel } from '../cursor/useCursorModel';
+export declare type Orientation = 'horizontal' | 'vertical';
+export declare type SelectionState<T = unknown> = CursorState<T> & {
+    selectedIds: 'all' | string[];
+    unselectedIds: string[];
+};
+export declare type SelectionEvents<T = unknown> = CursorEvents<T> & {
+    /** Select a specific item by its identifier. */
+    select(data: {
+        id: string;
+    }): void;
+    /** Select all items. This will set `selectedIds` to `'all'` and remove all `unselectedIds`.
+     * This is especially useful for virtual lists where not all items are loaded in memory.
+     */
+    selectAll(): void;
+    unselectAll(): void;
+};
+export interface SelectionModel<T = unknown> extends CursorModel<T> {
+    state: SelectionState<T>;
+    events: SelectionEvents<T>;
+    selection: SelectionManager;
+}
+export declare const selectionEventMap: {
+    guards: {
+        /** Should a cursor position be set? Use only in advance use-cases */
+        shouldSelect: "select";
+        shouldGoTo: "goTo";
+        shouldRegisterItem: "registerItem";
+        shouldUnregisterItem: "unregisterItem";
+        shouldUpdateItemPosition: "updateItemPosition";
+    };
+    callbacks: {
+        /**
+         * Called when a cursor position has been changed. Useful to set state or perform side effects.
+         * This is called during state change batching, so calling state setters will not invoke extra
+         * renders.
+         */
+        onSelect: "select";
+        onGoTo: "goTo";
+        onRegisterItem: "registerItem";
+        onUnregisterItem: "unregisterItem";
+        onUpdateItemPosition: "updateItemPosition";
+    };
+};
+/**
+ * A SelectionManager is used
+ */
+export interface SelectionManager {
+    select(id: string, prevState: Pick<SelectionState, 'selectedIds' | 'unselectedIds'>): Pick<SelectionState, 'selectedIds' | 'unselectedIds'>;
+}
+export declare const isSelected: (id: string, { selectedIds, unselectedIds }: Pick<SelectionState<unknown>, "selectedIds" | "unselectedIds">) => boolean;
+export declare const singleSelectionManager: SelectionManager;
+export declare const multiSelectionManager: SelectionManager;
+export declare type BaseSelectionModelConfig<T> = BaseCursorModelConfig<T> & {
+    initialSelectedIds?: string[];
+    initialUnselectedIds?: string[];
+    selection?: SelectionManager;
+};
+export declare type SelectionModelConfig<T> = BaseSelectionModelConfig<T> & Partial<ToModelConfig<SelectionState<T>, SelectionEvents<T>, typeof selectionEventMap>>;
+export declare const useSelectionModel: <T extends unknown>(config?: SelectionModelConfig<T>) => SelectionModel<T>;
+//# sourceMappingURL=useSelectionModel.d.ts.map

package/dist/commonjs/tabs/lib/selection/useSelectionModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSelectionModel.d.ts","sourceRoot":"","sources":["../../../../../tabs/lib/selection/useSelectionModel.tsx"],"names":[],"mappings":"AACA,OAAO,EAAiB,aAAa,EAAc,MAAM,kCAAkC,CAAC;AAC5F,OAAO,EACL,WAAW,EACX,YAAY,EACZ,qBAAqB,EAIrB,WAAW,EACZ,MAAM,0BAA0B,CAAC;AAElC,oBAAY,WAAW,GAAG,YAAY,GAAG,UAAU,CAAC;AAEpD,oBAAY,cAAc,CAAC,CAAC,GAAG,OAAO,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG;IACzD,WAAW,EAAE,KAAK,GAAG,MAAM,EAAE,CAAC;IAC9B,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF,oBAAY,eAAe,CAAC,CAAC,GAAG,OAAO,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG;IAC3D,gDAAgD;IAChD,MAAM,CAAC,IAAI,EAAE;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI,CAAC;IACjC;;OAEG;IACH,SAAS,IAAI,IAAI,CAAC;IAClB,WAAW,IAAI,IAAI,CAAC;CACrB,CAAC;AAEF,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,WAAW,CAAC,CAAC,CAAC;IACjE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IACzB,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAC3B,SAAS,EAAE,gBAAgB,CAAC;CAC7B;AAED,eAAO,MAAM,iBAAiB;;QAG1B,qEAAqE;;;;;;;;QAKrE;;;;WAIG;;;;;;;CAGL,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,aAAa,GAAG,eAAe,CAAC,GAC/D,IAAI,CAAC,cAAc,EAAE,aAAa,GAAG,eAAe,CAAC,CAAC;CAC1D;AAED,eAAO,MAAM,UAAU,yHAQtB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,gBAIpC,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,gBAmBnC,CAAC;AAEF,oBAAY,wBAAwB,CAAC,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,GAAG;IACnE,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,SAAS,CAAC,EAAE,gBAAgB,CAAC;CAC9B,CAAC;AAEF,oBAAY,oBAAoB,CAAC,CAAC,IAAI,wBAAwB,CAAC,CAAC,CAAC,GAC/D,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,iBAAiB,CAAC,CAAC,CAAC;AAE1F,eAAO,MAAM,iBAAiB,4EAwB7B,CAAC"}

package/dist/commonjs/tabs/lib/selection/useSelectionModel.js

@@ -0,0 +1,80 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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");
+var useCursorModel_1 = require("../cursor/useCursorModel");
+exports.selectionEventMap = common_1.createEventMap()({
+    guards: __assign(__assign({}, useCursorModel_1.cursorEventMap.guards), { 
+        /** Should a cursor position be set? Use only in advance use-cases */
+        shouldSelect: 'select' }),
+    callbacks: __assign(__assign({}, useCursorModel_1.cursorEventMap.callbacks), { 
+        /**
+         * Called when a cursor position has been changed. Useful to set state or perform side effects.
+         * This is called during state change batching, so calling state setters will not invoke extra
+         * renders.
+         */
+        onSelect: 'select' }),
+});
+exports.isSelected = function (id, _a) {
+    var selectedIds = _a.selectedIds, unselectedIds = _a.unselectedIds;
+    if (selectedIds === 'all') {
+        return !unselectedIds.includes(id);
+    }
+    return selectedIds.includes(id);
+};
+exports.singleSelectionManager = {
+    select: function (id) {
+        return { selectedIds: [id], unselectedIds: [] };
+    },
+};
+exports.multiSelectionManager = {
+    select: function (id, _a) {
+        var selectedIds = _a.selectedIds, unselectedIds = _a.unselectedIds;
+        if (selectedIds === 'all') {
+            // If we have all selected, start adding/removing from `unselectedIds`
+            var existingKey = unselectedIds.includes(id);
+            return {
+                selectedIds: 'all',
+                unselectedIds: existingKey
+                    ? unselectedIds.filter(function (key) { return key !== id; })
+                    : unselectedIds.concat(id),
+            };
+        }
+        else {
+            var existingKey = selectedIds.includes(id);
+            return {
+                selectedIds: existingKey ? selectedIds.filter(function (key) { return key !== id; }) : selectedIds.concat(id),
+                unselectedIds: [],
+            };
+        }
+    },
+};
+exports.useSelectionModel = function (config) {
+    if (config === void 0) { config = {}; }
+    var cursor = useCursorModel_1.useCursorModel(config);
+    var _a = react_1.default.useState(config.initialSelectedIds || []), selectedIds = _a[0], setSelectedIds = _a[1];
+    var _b = react_1.default.useState(config.initialUnselectedIds || []), unselectedIds = _b[0], setUnselectedIds = _b[1];
+    var selection = config.selection || exports.singleSelectionManager;
+    var state = __assign(__assign({}, cursor.state), { selectedIds: selectedIds, unselectedIds: unselectedIds });
+    var events = common_1.useEventMap(exports.selectionEventMap, state, config, __assign(__assign({}, cursor.events), { select: function (data) {
+            var _a = selection.select(data.id, state), selectedIds = _a.selectedIds, unselectedIds = _a.unselectedIds;
+            setSelectedIds(selectedIds);
+            setUnselectedIds(unselectedIds);
+            events.goTo({ id: data.id });
+        } }));
+    return { state: state, events: events, selection: selection, getId: cursor.getId };
+};

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

@@ -1,70 +1,70 @@
-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;
+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;
     /**
      * A list of panels. Uses `ListModel`
      */
-    panels: Item[];
+    panels: T[];
     /**
      * 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['indexRef'];
+    panelIndexRef: ListState<T>['indexRef'];
+    orientation: Orientation;
+    getId: (item: T) => string;
 };
-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;
+export declare type TabsEvents<T = unknown> = OverflowEvents<T> & {
     /**
      * This event registers panels with state.panels. Called when a panel is mounted.
      */
-    registerPanel: ListEvents['registerItem'];
+    registerPanel: ListEvents<T>['registerItem'];
     /**
      * This event unregisters panels with state.panels. Called when a panel is unmounted.
      */
-    unregisterPanel: ListEvents['unregisterItem'];
+    unregisterPanel: ListEvents<T>['unregisterItem'];
 };
-export declare type TabsModel = Model<TabsState, TabsEvents>;
+export interface TabsModel<T = unknown> extends OverflowModel<T> {
+    state: TabsState<T>;
+    events: TabsEvents<T>;
+    menu: MenuModel<T>;
+}
 export declare const tabEventMap: {
     guards: {
-        /**
-         * Should the tab activate? Can prevent the tab from activating. Use this only for advanced
-         * use-cases.
+        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.
          */
-        shouldActivate: "activate";
         shouldGoTo: "goTo";
         shouldRegisterItem: "registerItem";
         shouldUnregisterItem: "unregisterItem";
         shouldUpdateItemPosition: "updateItemPosition";
     };
     callbacks: {
-        /**
-         * 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";
+        onSetContainerWidth: "setContainerWidth";
+        onSetOverflowTargetWidth: "setOverflowTargetWidth";
+        onAddItemWidth: "addItemWidth";
+        onRemoveItemWidth: "removeItemWidth";
+        onAddHiddenKey: "addHiddenKey";
+        onRemoveHiddenKey: "removeHiddenKey";
+        onSelect: "select";
         onGoTo: "goTo";
         onRegisterItem: "registerItem";
         onUnregisterItem: "unregisterItem";
         onUpdateItemPosition: "updateItemPosition";
     };
 };
-export declare type BaseTabsModelConfig = Omit<BaseCursorModelConfig, 'orientation'> & {
+export declare type BaseTabsModelConfig<T> = Omit<BaseOverflowModelConfig<T>, '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,7 +83,8 @@ export declare type BaseTabsModelConfig = Omit<BaseCursorModelConfig, 'orientati
      * @default 'horizontal'
      */
     orientation?: Orientation;
+    menuConfig?: MenuModelConfig<T>;
 };
-export declare type TabsModelConfig = BaseTabsModelConfig & Partial<ToModelConfig<TabsState, TabsEvents, typeof tabEventMap>>;
-export declare const useTabsModel: (config?: TabsModelConfig) => Model<TabsState, TabsEvents>;
+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>;
 //# 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,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"}
+{"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"}