@workday/canvas-kit-react 5.3.0-next.10 → 5.3.0-next.24

package/tabs/lib/useTabsModel.tsx

@@ -1,79 +1,67 @@
 import React from 'react';
-import {createEventMap, Model, ToModelConfig, useEventMap} from '@workday/canvas-kit-react/common';
 import {
-  CursorState,
-  CursorEvents,
-  cursorEventMap,
-  useCursorModel,
-  BaseCursorModelConfig,
-  Orientation,
-  CursorModelConfig,
-  getNext,
-} from './cursor/useCursorModel';
-import {Item, ListEvents, ListState, useListModel} from './list/useListModel';
+  createEventMap,
+  ToModelConfig,
+  useEventMap,
+  useUniqueId,
+} from '@workday/canvas-kit-react/common';
+import {Orientation} from './cursor';
+import {defaultGetId, ListEvents, ListState, useListModel} from './list';
+import {MenuModel, MenuModelConfig, useMenuModel} from './menu';
+import {
+  overflowEventMap,
+  OverflowEvents,
+  OverflowState,
+  OverflowModelConfig,
+  BaseOverflowModelConfig,
+  useOverflowModel,
+  OverflowModel,
+} from './overflow';
 
-export 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;
+export 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 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 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 type TabsModel = Model<TabsState, TabsEvents>;
+export interface TabsModel<T = unknown> extends OverflowModel<T> {
+  state: TabsState<T>;
+  events: TabsEvents<T>;
+  menu: MenuModel<T>;
+}
 
 export const tabEventMap = createEventMap<TabsEvents>()({
   guards: {
-    ...cursorEventMap.guards,
-    /**
-     * Should the tab activate? Can prevent the tab from activating. Use this only for advanced
-     * use-cases.
-     */
-    shouldActivate: 'activate',
+    ...overflowEventMap.guards,
   },
   callbacks: {
-    ...cursorEventMap.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',
+    ...overflowEventMap.callbacks,
   },
 });
 
-export type BaseTabsModelConfig = Omit<BaseCursorModelConfig, 'orientation'> & {
+export 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
@@ -92,55 +80,82 @@ export type BaseTabsModelConfig = Omit<BaseCursorModelConfig, 'orientation'> & {
    * @default 'horizontal'
    */
   orientation?: Orientation;
+  menuConfig?: MenuModelConfig<T>;
 };
 
-export type TabsModelConfig = BaseTabsModelConfig &
-  Partial<ToModelConfig<TabsState, TabsEvents, typeof tabEventMap>>;
+export type TabsModelConfig<T> = BaseTabsModelConfig<T> &
+  Partial<ToModelConfig<TabsState<T>, TabsEvents<T>, typeof tabEventMap>>;
 
-export const useTabsModel = (config: TabsModelConfig = {}): TabsModel => {
-  const initialTabRef = React.useRef(config.initialTab);
-  const [activeTab, setActiveTab] = React.useState(initialTabRef.current || '');
+export const useTabsModel = <T extends unknown>(config: TabsModelConfig<T> = {}): TabsModel<T> => {
+  const id = useUniqueId(config.id);
+  const initialSelectedRef = React.useRef(config.initialTab);
+  const getId = config.getId || defaultGetId;
 
-  const cursor = useCursorModel({
+  const items = config.items; // || (emptyItems as T[]);
+
+  const model = useOverflowModel<T>({
+    ...(config as OverflowModelConfig<T>),
+    id: `${id}-tabs`,
     orientation: config.orientation || 'horizontal',
-    ...(config as CursorModelConfig),
+    items,
+    onRegisterItem({data, prevState}) {
+      config?.onRegisterItem?.({data, prevState: prevState as TabsState<T>});
+      if (!initialSelectedRef.current) {
+        initialSelectedRef.current = getId(data.item);
+        events.select({id: initialSelectedRef.current});
+      }
+    },
+    initialSelectedIds: config.initialTab
+      ? [config.initialTab]
+      : config.items?.length
+      ? [getId(config.items![0])]
+      : [],
   });
-  const panels = useListModel();
 
-  const state = {
-    ...cursor.state,
-    activeTab,
+  const panels = useListModel<T>();
+
+  const state: TabsState<T> = {
+    ...model.state,
+    id,
+    getId,
+    orientation: config.orientation || 'horizontal',
     panels: panels.state.items,
     panelIndexRef: panels.state.indexRef,
   };
 
+  const overflowItems = React.useMemo(
+    () => (items ? items.filter(item => state.hiddenIds.includes(getId(item))) : undefined),
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [state.hiddenIds, items]
+  );
+
   const events = useEventMap(tabEventMap, state, config, {
-    ...cursor.events,
-    activate(data) {
-      setActiveTab(data.tab);
-      events.goTo({id: data.tab});
-    },
-    registerItem(data) {
-      if (!initialTabRef.current) {
-        initialTabRef.current = data.item.id;
-        setActiveTab(initialTabRef.current);
-      }
-      cursor.events.registerItem(data);
-    },
-    unregisterItem(data) {
-      // Activate the next tab if the current one is removed
-      if (state.activeTab === data.id && state.items.some(i => i.ref.current !== null)) {
-        const item = getNext(state.activeTab, state.items);
-        events.activate({tab: item.id});
-      }
-      cursor.events.unregisterItem(data);
-    },
+    ...model.events,
     registerPanel: panels.events.registerItem,
     unregisterPanel: panels.events.unregisterItem,
+  } as TabsEvents<T>);
+
+  const menu = useMenuModel({
+    id: `${id}-menu`,
+    items: overflowItems,
+    nonInteractiveIds: state.nonInteractiveIds.filter(key => !state.hiddenIds.includes(key)),
+    onSelect({data, prevState}) {
+      menu.events.hide();
+      events.select(data);
+      config.menuConfig?.onSelect?.({data, prevState});
+    },
+    onShow({data, prevState}) {
+      // Always select the first item when the menu is opened
+      menu.events.first();
+      config.menuConfig?.onShow?.({data, prevState});
+    },
   });
 
   return {
     state,
     events,
+    menu,
+    getId: model.getId,
+    selection: model.selection,
   };
 };

package/tokens/README.md

@@ -174,23 +174,16 @@ const buttonSyles = {
 
 ## Depth
 
-Five levels of depth are available. They are directly exported from `@workday/canvas-depth-web`.
-
-| Level            | Usage Recommendations             |
-| ---------------- | --------------------------------- |
-| Depth -1 (inset) | Inset card depth                  |
-| Depth 1          | Standard card depth               |
-| Depth 2          | Increased card depth on hover     |
-| Depth 3          | Active cards, popups              |
-| Depth 4          | Cards on white backgrounds, menus |
+Depth is the relative distance between surfaces in the z-axis. It provides delineation, focus, and priority with shadows and layering. There are five depth levels, `inset`, `1`, `2`, `3`, and `4`. Most levels only apply box-shadow styles, but `depth[4]` also applies border styles.
 
 ### Usage
 
 ```tsx
-import {depth} from '@workday/canvas-kit-react/tokens';
+import { depth } from '@workday/canvas-kit-react/tokens';
 
-depth.inset;
-depth['2'];
+const CustomCard = () => {
+  return <div css={depth[2]}>A standard-depth card</div>;
+}
 ```
 
 ## Type

package/tokens/index.ts

@@ -13,7 +13,7 @@ import {
 
 import {borderRadius, CanvasBorderRadius, CanvasBorderRadiusKeys, CanvasBorderRadiusValues} from './lib/radius';
 import {BrandingColor, CanvasColor} from './lib/colors.types';
-import depth, {CanvasDepth, CanvasDepthValue} from './lib/depth';
+import {depth, CanvasDepth, CanvasDepthValues} from './lib/depth';
 import {
   space,
   CanvasSpace,
@@ -64,7 +64,7 @@ export {
   monoFontFamily,
   BrandingColor,
   CanvasDepth,
-  CanvasDepthValue,
+  CanvasDepthValues,
   CSSProperties,
 };
 export default canvas;

package/tokens/lib/depth.ts

@@ -1,5 +1,127 @@
-import depth, {CanvasDepth, CanvasDepthValue} from '@workday/canvas-depth-web';
+export type CanvasDepth = {
+  /**
+   * ### Depth Inset
+   * 	Used for inset containers
+   *
+   * @example
+   * ```ts
+   * import { depth } from '@workday/canvas-kit-react/tokens';
+   *
+   * const insetCardStyles = {
+   *   ...depth.inset,
+   * };
+   * ```
+   */
+  inset: {
+    boxShadow: 'inset 0px 0px 8px 0 rgba(82, 97, 115, 0.09)';
+  };
+  /**
+   * ### Depth 1
+   * Used for minimal offset
+   *
+   * @example
+   * ```ts
+   * import { depth } from '@workday/canvas-kit-react/tokens';
+   *
+   * const cardStyles = {
+   *   ...depth[1],
+   * };
+   * ```
+   */
+  1: {
+    boxShadow: '0px 2px 4px 0 rgba(0, 0, 0, 0.08)';
+  };
+  /**
+   * ### Depth 2
+   * Used for Cards, Popups, and Menus — our most common depth
+   *
+   * @example
+   * ```ts
+   * import { depth } from '@workday/canvas-kit-react/tokens';
+   *
+   * const cardStyles = {
+   *   ...depth[2],
+   * };
+   * ```
+   */
+  2: {
+    boxShadow: '0px 4px 8px 0 rgba(0, 0, 0, 0.1)';
+  };
+  /**
+   * ### Depth 3
+   * Used for interactive Cards on hover
+   *
+   * @example
+   * ```ts
+   * import { depth } from '@workday/canvas-kit-react/tokens';
+   *
+   * const cardStyles = {
+   *   ...depth[3],
+   * };
+   * ```
+   */
+  3: {
+    boxShadow: '0px 8px 16px 0 rgba(0, 0, 0, 0.12)';
+  };
+  /**
+   * ### Depth 4
+   * Used for Cards on white backgrounds — adds border styles for more contrast
+   *
+   * @example
+   * ```ts
+   * import { depth } from '@workday/canvas-kit-react/tokens';
+   *
+   * const cardStyles = {
+   *   ...depth[4],
+   * };
+   * ```
+   */
+  4: {
+    border: '1px solid rgba(218, 226, 230, 1)';
+    boxShadow: '0px 8px 16px 0 rgba(0, 0, 0, 0.12)';
+  };
+};
 
-export {CanvasDepth, CanvasDepthValue};
+type ValueOf<T> = T[keyof T];
+export type CanvasDepthValues = ValueOf<CanvasDepth>;
 
-export default depth;
+/**
+ * ### Depth Tokens
+ *
+ * Depth is the relative distance between surfaces in the z-axis.
+ * It provides delineation, focus, and priority with shadows and layering.
+ * There are five depth levels, `inset`, `1`, `2`, `3`, and `4`.
+ * Most levels only apply box-shadow styles, but `depth[4]` also applies border styles.
+ *
+ * @example
+ * ```tsx
+ * import { depth } from '@workday/canvas-kit-react/tokens';
+ *
+ * const CustomCard = () => {
+ *   return (
+ *     <div css={depth[2]}>
+ *       A standard-depth card
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ */
+export const depth: CanvasDepth = {
+  inset: {
+    boxShadow: 'inset 0px 0px 8px 0 rgba(82, 97, 115, 0.09)',
+  },
+  1: {
+    boxShadow: '0px 2px 4px 0 rgba(0, 0, 0, 0.08)',
+  },
+  2: {
+    boxShadow: '0px 4px 8px 0 rgba(0, 0, 0, 0.1)',
+  },
+  3: {
+    boxShadow: '0px 8px 16px 0 rgba(0, 0, 0, 0.12)',
+  },
+  4: {
+    border: '1px solid rgba(218, 226, 230, 1)',
+    boxShadow: '0px 8px 16px 0 rgba(0, 0, 0, 0.12)',
+  },
+};

package/tooltip/lib/OverflowTooltip.tsx

@@ -10,7 +10,7 @@ import {useTooltip} from './useTooltip';
  * Look for an element within the tree for an overflow element (auto, scroll, clip, or hidden).
  * This could be the passed element, or a descendant. If no element is found, `null` is returned.
  */
-const findOverflowElement = (element: Element): Element | null => {
+export const findOverflowElement = (element: Element): Element | null => {
   const style = getComputedStyle(element);
   if (
     style.overflow === 'auto' ||
@@ -36,11 +36,12 @@ const findOverflowElement = (element: Element): Element | null => {
  * Look for an element within the tree for a `text-overflow` CSS property of `ellipsis`.
  * This could be the passed element, or a descendant. If no element is found, `null` is returned.
  */
-const findEllipsisElement = (element: Element): Element | null => {
+export const findEllipsisElement = (element: Element): Element | null => {
   const style = getComputedStyle(element);
   if (style.textOverflow === 'ellipsis' || Number(style.webkitLineClamp) > 0) {
     return element;
-  } else {
+  } else if (element.children) {
+    // `children` is not defined for SVGElement in IE11
     for (let i = 0; i < element.children.length; i++) {
       const overflowElement = findEllipsisElement(element.children[i]);
       if (overflowElement) {
@@ -49,6 +50,7 @@ const findEllipsisElement = (element: Element): Element | null => {
     }
     return null;
   }
+  return null;
 };
 
 const isOverflowed = (element: Element) => {

package/tooltip/lib/Tooltip.tsx

@@ -44,6 +44,14 @@ export interface TooltipProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
    * @default 'label'
    */
   type?: 'label' | 'describe' | 'muted';
+  /**
+   * Amount of time (in ms) to delay before showing the tooltip
+   */
+  showDelay?: number;
+  /**
+   * Amount of time (in ms) to delay before hiding the tooltip
+   */
+  hideDelay?: number;
 }
 
 function mergeCallbacks<T extends {[key: string]: any}>(
@@ -66,10 +74,17 @@ export const Tooltip = ({
   placement = 'top',
   title,
   children,
+  showDelay = 300,
+  hideDelay = 100,
   ...elemProps
 }: TooltipProps) => {
   const titleText = innerText(title);
-  const {targetProps, popperProps, tooltipProps} = useTooltip({type, titleText});
+  const {targetProps, popperProps, tooltipProps} = useTooltip({
+    type,
+    titleText,
+    showDelay,
+    hideDelay,
+  });
 
   return (
     <React.Fragment>

package/tooltip/lib/useTooltip.tsx

@@ -54,6 +54,8 @@ const isInteractiveElement = (element: Element) => {
 export function useTooltip<T extends Element = Element>({
   type = 'label',
   titleText = '',
+  showDelay = 300,
+  hideDelay = 100,
 }: {
   /**
    * Determines the tooltip type for accessibility.
@@ -76,17 +78,30 @@ export function useTooltip<T extends Element = Element>({
    * The content of the `aria-label` if `type` is `label.
    */
   titleText?: string;
+  /**
+   * Amount of time (in ms) to delay before showing the tooltip
+   */
+  showDelay?: number;
+  /**
+   * Amount of time (in ms) to delay before hiding the tooltip
+   */
+  hideDelay?: number;
 } = {}) {
   const mouseDownRef = React.useRef(false); // use to prevent newly focused from making tooltip flash
   const popupModel = usePopupModel();
   const [anchorElement, setAnchorElement] = React.useState<T | null>(null);
   const [id] = React.useState(() => uuid());
+  const intentTimerHide = useIntentTimer(popupModel.events.hide, hideDelay);
+  const intentTimerShow = useIntentTimer(popupModel.events.show, showDelay);
 
-  const intentTimer = useIntentTimer(popupModel.events.hide, 100);
+  const onHide = () => {
+    intentTimerHide.start();
+    intentTimerShow.clear();
+  };
 
   const onOpen = () => {
-    popupModel.events.show();
-    intentTimer.clear();
+    intentTimerShow.start();
+    intentTimerHide.clear();
   };
 
   const onOpenFromTarget = (event: React.SyntheticEvent) => {
@@ -122,10 +137,10 @@ export function useTooltip<T extends Element = Element>({
       // This will replace the accessible name of the target element
       'aria-label': type === 'label' ? titleText : undefined,
       onMouseEnter: onOpenFromTarget,
-      onMouseLeave: intentTimer.start,
+      onMouseLeave: onHide,
       onMouseDown,
       onFocus,
-      onBlur: intentTimer.start,
+      onBlur: onHide,
     },
     /** Mix these properties into the `Popper` component */
     popperProps: {
@@ -138,7 +153,7 @@ export function useTooltip<T extends Element = Element>({
       id: type === 'describe' && visible ? id : undefined,
       role: 'tooltip',
       onMouseEnter: onOpen,
-      onMouseLeave: intentTimer.start,
+      onMouseLeave: onHide,
     },
   };
 }

package/ts3.5/dist/commonjs/button/lib/PrimaryButton.d.ts

@@ -1,13 +1,20 @@
 import * as React from 'react';
 import { GrowthBehavior, Themeable, EmotionCanvasTheme } from '@workday/canvas-kit-react/common';
 import { CanvasSystemIcon } from '@workday/design-assets-types';
-import { ButtonColors } from './types';
+import { ButtonSizes, IconPositions } from './types';
 export interface PrimaryButtonProps extends Themeable, GrowthBehavior {
     /**
-     * The size of the Button.
+     * The variant of the PrimaryButton.
+     * @default undefined
+     */
+    variant?: 'inverse';
+    /**
+     * There are four button sizes: `extraSmall`, `small`, `medium`, and `large`.
+     * If no size is provided, it will default to `medium`.
+     *
      * @default 'medium'
      */
-    size?: 'small' | 'medium' | 'large';
+    size?: ButtonSizes;
     /**
      * The data label of the Button.
      * Note: not displayed at `small` size
@@ -19,10 +26,11 @@ export interface PrimaryButtonProps extends Themeable, GrowthBehavior {
      */
     icon?: CanvasSystemIcon;
     /**
-     * The position of the TertiaryButton icon.
+     * Button icon positions can either be `left` or `right`.
+     * If no value is provided, it defaults to `left`.
      * @default 'left'
      */
-    iconPosition?: 'left' | 'right';
+    iconPosition?: IconPositions;
     /**
      * If set to `true`, transform the icon's x-axis to mirror the graphic
      * @default false
@@ -31,5 +39,71 @@ export interface PrimaryButtonProps extends Themeable, GrowthBehavior {
     children?: React.ReactNode;
 }
 export declare const PrimaryButton: import("../../common").ElementComponent<"button", PrimaryButtonProps>;
-export declare const getPrimaryButtonColors: ({ canvas: { palette: { primary: themePrimary }, }, }: EmotionCanvasTheme) => ButtonColors;
+export declare const getPrimaryButtonColors: (variant: "inverse" | undefined, theme: EmotionCanvasTheme) => {
+    default: {
+        background: string;
+        icon: string;
+        label: string;
+        labelData?: undefined;
+    };
+    hover: {
+        background: string;
+        icon?: undefined;
+        label?: undefined;
+        labelData?: undefined;
+    };
+    active: {
+        background: string;
+        icon?: undefined;
+        label?: undefined;
+        labelData?: undefined;
+    };
+    focus: {
+        background: string;
+        border?: undefined;
+        icon?: undefined;
+        label?: undefined;
+        labelData?: undefined;
+        focusRing?: undefined;
+    };
+    disabled: {
+        background: string;
+        icon?: undefined;
+        label?: undefined;
+        labelData?: undefined;
+    };
+} | {
+    default: {
+        background: string;
+        icon: string;
+        label: string;
+        labelData: string;
+    };
+    hover: {
+        background: string;
+        icon: string;
+        label: string;
+        labelData: string;
+    };
+    active: {
+        background: string;
+        icon: string;
+        label: string;
+        labelData: string;
+    };
+    focus: {
+        background: string;
+        border: string;
+        icon: string;
+        label: string;
+        labelData: string;
+        focusRing: import("@emotion/serialize").CSSObject;
+    };
+    disabled: {
+        background: string;
+        icon: string;
+        label: string;
+        labelData: string;
+    };
+};
 //# sourceMappingURL=PrimaryButton.d.ts.map

package/ts3.5/dist/commonjs/button/lib/SecondaryButton.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { GrowthBehavior, Themeable, EmotionCanvasTheme } from '@workday/canvas-kit-react/common';
 import { CanvasSystemIcon } from '@workday/design-assets-types';
-import { ButtonColors } from './types';
+import { ButtonColors, ButtonSizes, IconPositions } from './types';
 export interface SecondaryButtonProps extends Themeable, GrowthBehavior {
     /**
      * The variant of the SecondaryButton.
@@ -9,10 +9,12 @@ export interface SecondaryButtonProps extends Themeable, GrowthBehavior {
      */
     variant?: 'inverse' | undefined;
     /**
-     * The size of the Button.
+     * There are four button sizes: `extraSmall`, `small`, `medium`, and `large`.
+     * If no size is provided, it will default to `medium`.
+     *
      * @default 'medium'
      */
-    size?: 'small' | 'medium' | 'large';
+    size?: ButtonSizes;
     /**
      * The data label of the Button.
      * Note: not displayed at `small` size
@@ -24,10 +26,11 @@ export interface SecondaryButtonProps extends Themeable, GrowthBehavior {
      */
     icon?: CanvasSystemIcon;
     /**
-     * The position of the TertiaryButton icon.
+     * Button icon positions can either be `left` or `right`.
+     * If no value is provided, it defaults to `left`.
      * @default 'left'
      */
-    iconPosition?: 'left' | 'right';
+    iconPosition?: IconPositions;
     /**
      * If set to `true`, transform the icon's x-axis to mirror the graphic
      * @default false