@workday/canvas-kit-react 5.3.0-next.2 → 5.3.0

package/dist/es6/tooltip/lib/OverflowTooltip.js

@@ -29,7 +29,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.
  */
-var findOverflowElement = function (element) {
+export var findOverflowElement = function (element) {
     var style = getComputedStyle(element);
     if (style.overflow === 'auto' ||
         style.overflow === 'scroll' ||
@@ -53,12 +53,13 @@ var findOverflowElement = function (element) {
  * 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.
  */
-var findEllipsisElement = function (element) {
+export var findEllipsisElement = function (element) {
     var 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 (var i = 0; i < element.children.length; i++) {
             var overflowElement = findEllipsisElement(element.children[i]);
             if (overflowElement) {
@@ -67,6 +68,7 @@ var findEllipsisElement = function (element) {
         }
         return null;
     }
+    return null;
 };
 var isOverflowed = function (element) {
     var overflowElement = findEllipsisElement(element) || findOverflowElement(element);

package/dist/es6/tooltip/lib/useTooltip.d.ts

@@ -33,7 +33,7 @@ export declare function useTooltip<T extends Element = Element>({ type, titleTex
         onMouseEnter: (event: React.SyntheticEvent<Element, Event>) => void;
         onMouseLeave: () => void;
         onMouseDown: (event: React.MouseEvent<Element, MouseEvent>) => void;
-        onFocus: (event: React.FocusEvent<Element>) => void;
+        onFocus: (event: React.FocusEvent<Element, Element>) => void;
         onBlur: () => void;
     };
     /** Mix these properties into the `Popper` component */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-react",
-  "version": "5.3.0-next.2+eccb106b",
+  "version": "5.3.0",
   "description": "The parent module that contains all Workday Canvas Kit React components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -56,10 +56,9 @@
     "@emotion/styled": "^10.0.27",
     "@popperjs/core": "^2.5.4",
     "@workday/canvas-colors-web": "^2.0.0",
-    "@workday/canvas-depth-web": "^0.16.4",
-    "@workday/canvas-kit-labs-react": "^5.3.0-next.2+eccb106b",
-    "@workday/canvas-kit-popup-stack": "^5.3.0-next.2+eccb106b",
-    "@workday/canvas-kit-preview-react": "^5.3.0-next.2+eccb106b",
+    "@workday/canvas-kit-labs-react": "^5.3.0",
+    "@workday/canvas-kit-popup-stack": "^5.3.0",
+    "@workday/canvas-kit-preview-react": "^5.3.0",
     "@workday/canvas-system-icons-web": "1.0.41",
     "@workday/design-assets-types": "^0.2.4",
     "chroma-js": "^2.1.0",
@@ -68,12 +67,14 @@
     "lodash": "^4.17.14",
     "polished": "^4.1.3",
     "react-innertext": "^1.1.5",
+    "resize-observer-polyfill": "^1.5.1",
     "rtl-css-js": "^1.14.1",
+    "use-resize-observer": "~7.0.1",
     "uuid": "^3.3.3"
   },
   "devDependencies": {
     "@workday/canvas-accent-icons-web": "^1.0.0",
     "@workday/canvas-applet-icons-web": "^0.17.50"
   },
-  "gitHead": "eccb106b919fe5959334db591b44efd81e5e2aad"
+  "gitHead": "0cf3030eb73935b5679f8c9bb79fb6178a721a4a"
 }

package/page-header/README.md

@@ -1,4 +1,9 @@
-# Canvas Kit Page Header
+# Canvas Kit Page Header (Deprecated)
+
+> Note: As of Canvas Kit v6, PageHeader is being soft-deprecated. It will be hard-deprecated
+> (completely removed) in v7. Please see the
+> [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
+> for more information.
 
 A Canvas component that displays the header of a specific page within a website or application. It
 is generally used as a sub-header to the main application header
@@ -16,19 +21,19 @@ yarn add @workday/canvas-kit-react
 
 ```tsx
 import * as React from 'react';
-import {PageHeader} from '@workday/canvas-kit-react/page-header';
+import {DeprecatedPageHeader} from '@workday/canvas-kit-react/page-header';
 import {IconButton} from '@workday/canvas-kit-react/button';
 import {exportIcon, fullscreenIcon} from '@workday/canvas-system-icons-web';
 
-<PageHeader title="Product">
+<DeprecatedPageHeader title="Product">
   <IconButton icon={exportIcon} />
   <IconButton icon={fullscreenIcon} />
-</PageHeader>
+</DeprecatedPageHeader>
 
-<PageHeader title="With Cap Width" capWidth={true}>
+<DeprecatedPageHeader title="With Cap Width" capWidth={true}>
   <IconButton icon={exportIcon} />
   <IconButton icon={fullscreenIcon} />
-</PageHeader>
+</DeprecatedPageHeader>
 ```
 
 ## Static Properties

package/page-header/index.ts

@@ -1,5 +1,5 @@
-import PageHeader from './lib/PageHeader';
+import DeprecatedPageHeader from './lib/PageHeader';
 
-export default PageHeader;
-export {PageHeader};
+export default DeprecatedPageHeader;
+export {DeprecatedPageHeader};
 export * from './lib/PageHeader';

package/page-header/lib/PageHeader.tsx

@@ -3,7 +3,15 @@ import styled from '@emotion/styled';
 import {colors, gradients, space, type} from '@workday/canvas-kit-react/tokens';
 import {IconButton, IconButtonProps} from '@workday/canvas-kit-react/button';
 
-export interface PageHeaderProps {
+/**
+ * ### Deprecated Page Header Props
+ *
+ * As of Canvas Kit v6, PageHeader is being soft-deprecated.
+ * It will be hard-deprecated (completely removed) in v7. Please see the
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
+ * for more information.
+ */
+export interface DeprecatedPageHeaderProps {
   /**
    * The text of the PageHeader title.
    */
@@ -28,7 +36,7 @@ const Header = styled('header')({
   MozOsxFontSmoothing: 'grayscale',
 });
 
-const Container = styled('div')<Pick<PageHeaderProps, 'breakpoint' | 'capWidth'>>(
+const Container = styled('div')<Pick<DeprecatedPageHeaderProps, 'breakpoint' | 'capWidth'>>(
   {
     display: 'flex',
     alignItems: 'center',
@@ -68,7 +76,24 @@ const IconList = styled('div')({
   },
 });
 
-export default class PageHeader extends React.Component<PageHeaderProps> {
+/**
+ * ### Deprecated Page Header
+ *
+ * As of Canvas Kit v6, this component is being soft-deprecated.
+ * It will be hard-deprecated (completely removed) in v7. Please see the
+ * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
+ * for more information.
+ */
+export default class DeprecatedPageHeader extends React.Component<DeprecatedPageHeaderProps> {
+  componentDidMount() {
+    console.warn(
+      `This component is being deprecated and will be removed in Canvas Kit V7.\n
+      For more information, please see the V6 migration guide:\n
+      https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page
+      `
+    );
+  }
+
   private renderChildren(children: React.ReactNode): React.ReactNode {
     return React.Children.map(children, child => {
       if (!React.isValidElement(child)) {

package/pagination/lib/Pagination/GoTo/Label.tsx

@@ -7,6 +7,9 @@ import {PaginationModel} from '../types';
 
 export interface GoToLabelProps extends React.LabelHTMLAttributes<HTMLLabelElement> {
   model: PaginationModel;
+  /**
+   * Accepts child elements or a render prop.
+   */
   children?: (model: PaginationModel) => React.ReactNode | React.ReactNode;
 }
 

package/pagination/lib/Pagination/types.ts

@@ -1,17 +1,56 @@
 export interface PaginationState {
-  currentPage: number; // current page
-  firstPage: number; // first page
-  lastPage: number; // last page
-  range: number[]; // array of page numbers
-  rangeSize: number; // size of the range
+  /**
+   * The page number for the current page
+   */
+  currentPage: number;
+  /**
+   * The page number for the first page
+   */
+  firstPage: number;
+  /**
+   * The page number for the last page (it can also be used as a total page
+   * count)
+   */
+  lastPage: number;
+  /**
+   * An array of page numbers included in the pagination range
+   */
+  range: number[];
+  /**
+   * The size of the pagination range
+   */
+  rangeSize: number;
 }
 
 export interface PaginationEvents {
+  /**
+   * Sets the current page to a given page number (no safeguards)
+   */
   setCurrentPage: (page: number) => void;
+  /**
+   * Sets the current page to the first page
+   */
   first: () => void;
+  /**
+   * Sets the current page to the last page
+   */
   last: () => void;
+  /**
+   * Increments the current page by 1
+   */
   next: () => void;
+  /**
+   * Decrements the current page by 1
+   */
   previous: () => void;
+  /**
+   * Sets the current page to a given page number (with safeguards). `goTo`
+   * is very similar to `setCurrentPage`, but it has some built-in safeguards.
+   * If the page number provided is below the first page (e.g: `0`),
+   * `currentPage` will be set to the `firstPage`. Similarly, if the number
+   * provided is larger than the `lastPage`, it will set `currentPage` to the
+   * `lastPage`.
+   */
   goTo: (page: number) => void;
 }
 

package/pagination/lib/Pagination/usePaginationModel.ts

@@ -5,10 +5,29 @@ import {getRangeMax, getRangeMin} from './common/utils/helpers';
 import {PaginationModel} from './types';
 
 export type UsePaginationModelConfig = {
+  /**
+   * The page number for the last page (it can also be used as a total page
+   * count)
+   */
   lastPage: number;
+  /**
+   * The page number for the first page
+   * @default 1
+   */
   firstPage?: number;
+  /**
+   * The initial current page
+   * @default 1
+   */
   initialCurrentPage?: number;
+  /**
+   * The function called when the page changes
+   */
   onPageChange?: (pageNumber: number) => void;
+  /**
+   * The size of the pagination range
+   * @default 5
+   */
   rangeSize?: number;
 };
 

package/popup/lib/PopupCard.tsx

@@ -2,7 +2,7 @@ import * as React from 'react';
 import {keyframes} from '@emotion/core';
 
 import {Card} from '@workday/canvas-kit-react/card';
-import {space} from '@workday/canvas-kit-react/tokens';
+import {space, type} from '@workday/canvas-kit-react/tokens';
 import {
   styled,
   TransformOrigin,
@@ -43,6 +43,7 @@ const popupAnimation = (transformOrigin: TransformOrigin) => {
 const StyledPopupCard = styled(Card)<
   StyledType & {width?: number | string; transformOrigin?: TransformOrigin}
 >(
+  type.levels.subtext.large,
   {
     position: 'relative',
     maxWidth: `calc(100vw - ${space.l})`,
@@ -87,7 +88,7 @@ export const PopupCard = createComponent('div')({
         padding={padding}
         {...props}
       >
-        <Card.Body>{children}</Card.Body>
+        {children}
       </StyledPopupCard>
     );
   },

package/tabs/index.ts

@@ -1,2 +1,8 @@
 export * from './lib/Tabs';
 export * from './lib/useTabsModel';
+
+export {StyledTabItem, useTabsItem} from './lib/TabsItem';
+export {useTabsList} from './lib/TabsList';
+export {useTabsMenuPopper} from './lib/TabsMenuPopper';
+export {useTabsOverflowButton} from './lib/TabsOverflowButton';
+export {useTabsPanel} from './lib/TabsPanel';

package/tabs/lib/Tabs.tsx

@@ -1,15 +1,20 @@
 import React from 'react';
 
 import {createComponent, useDefaultModel} from '@workday/canvas-kit-react/common';
+import {Menu} from './menu';
 
-import {Tab} from './Tab';
-import {TabList} from './TabList';
-import {TabPanel} from './TabPanel';
+import {TabsItem} from './TabsItem';
+import {TabsList} from './TabsList';
+import {TabsPanel} from './TabsPanel';
 import {useTabsModel, TabsModel, TabsModelConfig} from './useTabsModel';
+import {TabsOverflowButton} from './TabsOverflowButton';
+import {TabsMenuPopper} from './TabsMenuPopper';
+import {TabsPanels} from './TabsPanels';
 
 export const TabsModelContext = React.createContext<TabsModel>({} as any);
 
-export interface TabsProps extends TabsModelConfig {
+// use `T = any` here because there's no way to pass generics to a compound component...
+export interface TabsProps<T = any> extends TabsModelConfig<T> {
   /**
    * The contents of the Tabs. Can be `Tabs` children or any valid elements.
    */
@@ -19,7 +24,7 @@ export interface TabsProps extends TabsModelConfig {
    * config passed to this component.
    * @default useTabsModel(config)
    */
-  model?: TabsModel;
+  model?: TabsModel<T>;
 }
 
 export const Tabs = createComponent()({
@@ -27,11 +32,31 @@ export const Tabs = createComponent()({
   Component: ({children, model, ...config}: TabsProps) => {
     const value = useDefaultModel(model, config, useTabsModel);
 
-    return <TabsModelContext.Provider value={value}>{children}</TabsModelContext.Provider>;
+    return (
+      <TabsModelContext.Provider value={value}>
+        <Menu model={value.menu}>{children}</Menu>
+      </TabsModelContext.Provider>
+    );
   },
   subComponents: {
-    List: TabList,
-    Item: Tab,
-    Panel: TabPanel,
+    List: TabsList,
+    Item: TabsItem,
+    Panel: TabsPanel,
+    Panels: TabsPanels,
+    OverflowButton: TabsOverflowButton,
+    MenuPopper: TabsMenuPopper,
+    /**
+     * The overflow menu of the Tabs component. If there isn't enough room to render all the tab
+     * items, the extra tabs that don't fit will be overflowed into this menu.
+     * @example
+     * <Tabs.Menu.Popper>
+     *   <Tabs.Menu.Card>
+     *     <Tabs.Menu.List>
+     *       {(item: MyTabItem) => <Tabs.Menu.Item name={item.id}>{item.text}</Tabs.Menu.Item>}
+     *     </Tabs.Menu.List>
+     *   </Tabs.Menu.Card>
+     * </Tabs.Menu.Popper>
+     */
+    Menu,
   },
 });

package/tabs/lib/TabsItem.tsx

@@ -0,0 +1,250 @@
+import * as React from 'react';
+
+import {colors, space, type, borderRadius, iconColors} from '@workday/canvas-kit-react/tokens';
+import {
+  createComponent,
+  focusRing,
+  hideMouseFocus,
+  styled,
+  StyledType,
+  useModelContext,
+  createHook,
+  composeHooks,
+  ExtractProps,
+  ellipsisStyles,
+  EllipsisText,
+  useLocalRef,
+  useMount,
+} from '@workday/canvas-kit-react/common';
+import {Box} from '@workday/canvas-kit-labs-react/common';
+import {OverflowTooltip} from '@workday/canvas-kit-react/tooltip';
+import {SystemIcon} from '@workday/canvas-kit-react/icon';
+import {useListRegisterItem} from './list';
+import {useRovingFocus} from './cursor';
+import {isSelected, useSelectionItem} from './selection';
+import {useOverflowMeasureItem} from './overflow';
+
+import {TabsModelContext} from './Tabs';
+import {TabsModel} from './useTabsModel';
+import {StackProps} from '@workday/canvas-kit-labs-react/layout';
+export interface TabsItemProps
+  extends ExtractProps<typeof Box, never>,
+    Partial<Pick<StackProps, 'spacing'>> {
+  /**
+   * Optionally pass index to tab item. This should be done if `Tabs.Item` components were created
+   * via a `Array::map` function. This index will ensure keyboard navigation works even if items are
+   * inserted out of order.
+   */
+  index?: number;
+  /**
+   * The contents of the tab item. This will be the accessible name of the tab for screen readers.
+   * Often, this is text. Icons are also supported. Using `Tabs.Icon` will render an icon that is
+   * not visible to screen readers and therefore the icon should not be necessary to understand the
+   * tab. In most circumstances, `aria-label` should not be used.
+   *
+   * ```tsx
+   * <Tabs.Item>First Tab</Tabs.Item>
+   * <Tabs.Item hasIcon>
+   *   <Tabs.Icon icon={canvasIcon} />
+   *   <Tabs.Text>Second Tab</Tabs.Text>
+   * </Tabs.Item>
+   * ```
+   */
+  children: React.ReactNode;
+  /**
+   * The name of the tab. This name will be used in change events and for `initialTab`. Must match
+   * the `name` of the associated tab panel. If this property is not provided, it will default to a
+   * string representation of the the zero-based index of the Tab when it was initialized.
+   */
+  name?: string;
+  /**
+   * Optionally pass a model directly to this component. Default is to implicitly use the same
+   * model as the container component which uses React context. Only use this for advanced use-cases
+   */
+  model?: TabsModel;
+  /**
+   * Optional id. If not set, it will inherit the ID passed to the `Tabs` component and append the
+   * index at the end. Only set this for advanced cases.
+   */
+  id?: string;
+  /**
+   * Part of the ARIA specification for tabs. This attributes links a `role=tab` to a
+   * `role=tabpanel`. This value must be the same as the associated `id` attribute of the tab panel.
+   * This is automatically set by the component and should only be used in advanced cases.
+   */
+  'aria-controls'?: string;
+  /**
+   * Part of the ARIA specification for tabs. Lets screen readers know which tab is active. This
+   * should either be `true` or `undefined` and never `false`. This is automatically set by the
+   * component and should only be used in advanced cases.
+   */
+  'aria-selected'?: boolean;
+  /**
+   * Part of the ARIA specification for tabs. The currently active tab should not have a `tabIndex`
+   * set while all inactive tabs should have a `tabIndex={-1}`
+   */
+  tabIndex?: number;
+  /**
+   * Use `hasIcon={true}` when the Tab item contains an icon. This instructs the tab item to render
+   * children as a flex container to accommodate icons. You will have to use `Tabs.Item.Text` as a
+   * child element if this is set to true.
+   *
+   * @example
+   * <Tabs.Item hasIcon>
+   *   <Tabs.Item.Icon icon={someIcon} />
+   *   <Tabs.Item.Text>Tab Text</Tabs.Item.Text>
+   * </Tabs.Item>
+   */
+  hasIcon?: boolean;
+}
+
+export const StyledTabItem = styled(Box.as('button'))<
+  StyledType & {hasIcon?: boolean} & Pick<TabsItemProps, 'spacing'>
+>(
+  ({theme, spacing}) => ({
+    ...type.levels.subtext.large,
+    '& > *:not(style) ~ *:not(style)': {
+      marginLeft: spacing || space.xxs,
+    },
+    fontWeight: type.properties.fontWeights.medium,
+    border: 'none',
+    backgroundColor: 'transparent',
+    flex: '0 0 auto',
+    alignItems: 'center',
+    maxWidth: '280px',
+    padding: `${space.xs} ${space.s}`,
+    height: 52,
+    boxSizing: 'border-box',
+    cursor: 'pointer',
+    color: colors.licorice300,
+    position: 'relative',
+    borderRadius: `${borderRadius.m} ${borderRadius.m} 0px 0px`,
+    transition: 'background 150ms ease, color 150ms ease',
+
+    ...hideMouseFocus,
+
+    '.wd-icon-background ~ .wd-icon-accent, .wd-icon-background ~ .wd-icon-accent2': {
+      fill: iconColors.active,
+    },
+
+    '&:hover, &:focus': {
+      backgroundColor: colors.soap200,
+      color: colors.blackPepper400,
+      '.wd-icon-fill, .wd-icon-accent, .wd-icon-accent2': {
+        fill: iconColors.hover,
+      },
+      '.wd-icon-background ~ .wd-icon-accent, .wd-icon-background ~ .wd-icon-accent2': {
+        fill: iconColors.active,
+      },
+    },
+
+    '&:focus': {
+      outline: `none`,
+      ...focusRing({inset: 'outer', width: 0, separation: 2}, theme),
+    },
+
+    '&:disabled, &[aria-disabled]': {
+      color: colors.licorice100,
+      '.wd-icon-fill, .wd-icon-accent, .wd-icon-accent2': {
+        fill: iconColors.disabled,
+      },
+      '&:hover': {
+        cursor: 'auto',
+        backgroundColor: `transparent`,
+        '.wd-icon-fill, .wd-icon-accent, .wd-icon-accent2': {
+          fill: iconColors.disabled,
+        },
+      },
+    },
+
+    '&[aria-selected=true]': {
+      color: theme.canvas.palette.primary.main,
+      cursor: 'default',
+      '.wd-icon-fill, .wd-icon-accent, .wd-icon-accent2': {
+        fill: theme.canvas.palette.primary.main,
+      },
+      '&:after': {
+        position: 'absolute',
+        height: space.xxxs,
+        borderRadius: `${borderRadius.m} ${borderRadius.m} 0px 0px`,
+        backgroundColor: theme.canvas.palette.primary.main,
+        bottom: 0,
+        content: `''`,
+        left: 0,
+        marginTop: '-2px',
+        width: '100%',
+      },
+      '&:hover, &:focus': {
+        backgroundColor: `transparent`,
+        color: theme.canvas.palette.primary.main,
+      },
+    },
+  }),
+  ({hasIcon}) => {
+    if (hasIcon) {
+      return {
+        display: 'flex',
+      };
+    } else {
+      return ellipsisStyles;
+    }
+  }
+);
+
+export const TabsItem = createComponent('button')({
+  displayName: 'Tabs.Item',
+  Component: ({model, children, ...elemProps}: TabsItemProps, ref, Element) => {
+    const localModel = useModelContext(TabsModelContext, model);
+
+    const props = useTabsItem(localModel, elemProps, ref);
+
+    if ('production' !== process.env.NODE_ENV) {
+      // ensure `hasIcon` is used when a child has an icon
+      // eslint-disable-next-line react-hooks/rules-of-hooks
+      const {elementRef, localRef} = useLocalRef(props.ref);
+      props.ref = elementRef;
+      // eslint-disable-next-line react-hooks/rules-of-hooks
+      useMount(() => {
+        if (localRef.current.querySelector('svg') && !props.hasIcon) {
+          console.warn(
+            `A Tabs.Item with an icon should have the 'hasIcon' prop set to true. This ensures correct rendering`
+          );
+        }
+      });
+    }
+
+    return (
+      <OverflowTooltip>
+        <StyledTabItem as={Element} {...props}>
+          {children}
+        </StyledTabItem>
+      </OverflowTooltip>
+    );
+  },
+  subComponents: {
+    Icon: SystemIcon,
+    Text: EllipsisText,
+  },
+});
+
+export const useTabsItem = composeHooks(
+  createHook(
+    (model: TabsModel, _?: React.Ref<HTMLButtonElement>, elemProps: {name?: string} = {}) => {
+      const {state} = model;
+      const name = elemProps.name || '';
+
+      const selected = !!elemProps.name && isSelected(name, state);
+
+      return {
+        type: 'button' as 'button', // keep Typescript happy
+        role: 'tab',
+        'aria-selected': selected,
+        'aria-controls': `tabpanel-${state.id}-${name}`,
+      };
+    }
+  ),
+  useSelectionItem,
+  useOverflowMeasureItem,
+  useRovingFocus,
+  useListRegisterItem
+);