@workday/canvas-kit-react 5.3.0 → 5.3.4

package/button/lib/parts/ButtonLabelIcon.tsx

@@ -5,25 +5,22 @@ import isPropValid from '@emotion/is-prop-valid';
 import {SystemIcon} from '@workday/canvas-kit-react/icon';
 import {styled} from '@workday/canvas-kit-react/common';
 
-import {ButtonSizes, IconPositions} from '../types';
 export interface ButtonLabelIconProps {
   /**
-   * There are four button sizes: `extraSmall`, `small`, `medium`, and `large`.
-   *
+   * The size of the Button.
    * @default 'medium'
    */
-  size?: ButtonSizes;
+  size?: 'small' | 'medium' | 'large';
   /**
    * The icon of the Button.
    * Note: not displayed at `small` size
    */
   icon?: CanvasSystemIcon;
   /**
-   * Button icon positions can either be `left` or `right`.
-   * If no value is provided, it defaults to `left`.
+   * The position of the TertiaryButton icon.
    * @default 'left'
    */
-  iconPosition?: IconPositions;
+  iconPosition?: 'left' | 'right';
   /**
    * If set to `true`, transform the icon's x-axis to mirror the graphic
    * @default false
@@ -31,29 +28,8 @@ export interface ButtonLabelIconProps {
   shouldMirrorIcon?: boolean;
 }
 
-const iconSizes: Record<ButtonSizes, number> = {
-  extraSmall: 18,
-  small: 20,
-  medium: 20,
-  large: 24,
-};
-
-const getIconPositionStyles = ({iconPosition, size}: ButtonLabelIconProps) => {
-  // Adjust margin values for visual balance, large buttons require 8px
-  const balancingMargin = size === 'large' ? space.xxs : space.xxxs;
-  // iconPosition can only be "right", "left", or undefined (defaults to "left")
-  if (iconPosition === 'right') {
-    return {
-      marginLeft: undefined,
-      marginRight: `-${balancingMargin} !important`,
-    };
-  } else {
-    return {
-      marginLeft: `-${balancingMargin} !important`,
-      marginRight: undefined,
-    };
-  }
-};
+const ICON_SIZE = 24;
+const SMALL_ICON_SIZE = 20;
 
 const ButtonLabelIconStyled = styled('span', {
   shouldForwardProp: prop => isPropValid(prop) && prop !== 'size',
@@ -62,10 +38,13 @@ const ButtonLabelIconStyled = styled('span', {
     display: 'inline-block',
   },
   ({size}) => ({
-    width: size ? iconSizes[size] : iconSizes.medium,
-    height: size ? iconSizes[size] : iconSizes.medium,
+    width: size === 'small' ? SMALL_ICON_SIZE : ICON_SIZE,
+    height: size === 'small' ? SMALL_ICON_SIZE : ICON_SIZE,
   }),
-  getIconPositionStyles
+  ({iconPosition}) => ({
+    marginLeft: iconPosition === 'right' ? undefined : `-${space.xxxs} !important`,
+    marginRight: iconPosition === 'right' ? `-${space.xxxs} !important` : undefined,
+  })
 );
 
 export const ButtonLabelIcon = ({
@@ -75,11 +54,12 @@ export const ButtonLabelIcon = ({
   shouldMirrorIcon = false,
   ...elemProps
 }: ButtonLabelIconProps) => {
+  /* istanbul ignore next line for coverage */
   if (icon === undefined) {
     return null;
   }
 
-  const iconSize = size ? iconSizes[size] : undefined;
+  const iconSize = size === 'small' ? SMALL_ICON_SIZE : undefined;
 
   return (
     <ButtonLabelIconStyled iconPosition={iconPosition} size={size} {...elemProps}>

package/button/lib/types.ts

@@ -20,14 +20,3 @@ export interface ButtonColors {
   };
   disabled: ButtonStateColors;
 }
-
-/**
- * There are four button sizes: `extraSmall`, `small`, `medium`, and `large`.
- * If no size is provided, it will default to `medium`.
- *
- * @default 'medium'
- */
-export type ButtonSizes = 'extraSmall' | 'small' | 'medium' | 'large';
-// TODO: Remove TertiaryButtonSizes in favor of button sizes when we add Tertiary large
-export type TertiaryButtonSizes = 'extraSmall' | 'small' | 'medium';
-export type IconPositions = 'left' | 'right';

package/common/index.ts

@@ -6,4 +6,3 @@ export * from './lib/styles';
 export * from './lib/utils';
 export * from './lib/CanvasProvider';
 export * from './lib/InputProvider';
-export * from './lib/EllipsisText';

package/common/lib/styles/accessibleHide.ts

@@ -1,10 +1,10 @@
-import {CSSProperties} from '@workday/canvas-kit-react/tokens';
+import {CSSObject} from '@emotion/core';
 
 /**
  * A utility to hide content normal users while still making accessible to screenreaders
  * See https://a11y-101.com/development/skip-link
  */
-export const accessibleHide: CSSProperties = {
+export const accessibleHide: CSSObject = {
   clip: 'rect(1px, 1px, 1px, 1px)', // Deprecated but still used by most browsers, clip-path will be taking its place soon.
   clipPath: 'polygon(0px 0px, 0px 0px, 0px 0px, 0px 0px)',
   position: 'absolute',

package/common/lib/theming/README.md

@@ -90,10 +90,10 @@ export const defaultCanvasTheme: CanvasTheme = {
   breakpoints: {
     values: {
       zero: 0,
-      s: 320,
-      m: 768,
-      l: 1024,
-      xl: 1440,
+      s: 600,
+      m: 960,
+      l: 1280,
+      xl: 1920,
     },
     up,
     down,
@@ -243,205 +243,41 @@ variable before falling back to the default theme.
 
 ## Breakpoints
 
-Breakpoints are used by media queries to conditionally apply or modify styles based on the viewport
-width. This allows the UI to be responsive to various screen sizes.
-
-### Values
-
-The canvas theme object provides five breakpoint values that correspond to the min-widths of our
-standard screen sizes.
+Our breakpoint system is customized within the theme object. `theme.breakpoints.values` contains the
+various widths that our components adjust at:
 
 | Name   | Size (px) |
 | ------ | --------- |
 | `zero` | 0         |
-| `s`    | 320       |
-| `m`    | 768       |
-| `l`    | 1024      |
-| `xl`   | 1440      |
-
-And these are our standard screen size ranges:
-
-- `small` (320px - 767px) Used for mobile-sized screens
-- `medium` (768px - 1023px) Used for tablet-sized screens
-- `large` - (1024px - 1439px) Used for laptop and small desktop screens
-- `extra-large` (≥1440px) Used for very large screens
-
-> Note: Some applications may only require a subset of screen sizes and not use all breakpoints.
-
-Our breakpoint system is customized within the theme object. `theme.canvas.breakpoints.values`.
-
-```ts
-import {useTheme} from '@workday/canvas-kit-react/common';
-import {space} from '@workday/canvas-kit-react/tokens';
-
-const {theme} = useTheme();
-const {values} = theme.canvas.breakpoints;
-const styles = {
-  [`@media (min-width: ${values.m}px)`]: {
-    padding: space.s,
-  },
-};
-```
-
-### Functions
+| `s`    | 600       |
+| `m`    | 960       |
+| `l`    | 1280      |
+| `xl`   | 1920      |
 
 There are also several functions to help with generating media queries:
 
-- [Up](#Up)
-- [Down](#Down)
-- [Between](#Between)
-- [Only](#Only)
+#### `up: (key: BreakpointFnParam) => string`
 
-#### Up
+> Returns a media query reflecting your specified size and up. Works with the enum (e.g.
+> BreakpointKey.m) or the string (e.g. 'm'). Example: theme.breakpoints.up(BreakpointKey.m) =>
+> '@media (min-width:960px)'
 
-_Returns a media query above the `min-width` for the range of a given breakpoint_
+#### `down: (key: BreakpointFnParam) => string`
 
-Given a `start` breakpoint key ("zero", "s", "m", "l", "xl"), this function returns a media query
-(string) using a `min-width`.
+> Returns a media query reflecting your specified size and down. Works with the enum or the string
+> (e.g. 'm'). Example: theme.breakpoints.down(BreakpointKey.m) => '@media (max-width:1279.5px)'
 
-```ts
-import {useTheme} from '@workday/canvas-kit-react/common';
-import {space} from '@workday/canvas-kit-react/tokens';
-
-const theme = useTheme();
-const {up} = theme.canvas.breakpoints;
-const mediaQuery = up('l'); // Returns '@media (min-width: 1024px)'
-const styles = {
-  [mediaQuery]: {
-    padding: space.m,
-  },
-};
-```
+#### `between: (start: BreakpointFnParam, end: BreakpointFnParam) => string`
 
-#### Down
-
-_Returns a media query below the `max-width` for the range of a given breakpoint_
-
-Given an `end` breakpoint key ("zero", "s", "m", "l", "xl"), this function returns a media query
-(string) using a `max-width`.
-
-> Note: This function subtracts `0.5px` from the next breakpoint value to prevent collisions. For
-> example, `breakpoints.values.s`, has a `min-width` of `320px`, and the `max-width` is `767.5px`).
-
-If the `xl` breakpoint is provided, this function returns a media query with only a `min-width` of
-`0`, as seen in the second example below.
-
-```ts
-import {useTheme} from '@workday/canvas-kit-react/common';
-import {space} from '@workday/canvas-kit-react/tokens';
-
-const theme = useTheme();
-const {down} = theme.canvas.breakpoints;
-const mediaQuery = down('m'); // Returns '@media (max-width: 1023.5px)'
-const styles = {
-  [mediaQuery]: {
-    padding: space.m,
-  },
-};
-```
-
-This example uses the `xl` breakpoint and only adds a `min-width` of `0` to the media query.
-
-```ts
-import {useTheme} from '@workday/canvas-kit-react/common';
-import {space} from '@workday/canvas-kit-react/tokens';
-
-const theme = useTheme();
-const {down} = theme.canvas.breakpoints;
-const mediaQuery = down('xl'); // Returns '@media (min-width: 0)'
-const styles = {
-  [mediaQuery]: {
-    padding: space.m,
-  },
-};
-```
+> Returns a media query reflecting the sizes between your specified breakpoints. Works with the enum
+> or the string (e.g. 'm'). Example: theme.breakpoints.between(BreakpointKey.m, BreakpointKey.l) =>
+> '@media (min-width:960px) and (max-width:1919.5px)'
 
-#### Between
+#### `only: (key: BreakpointFnParam) => string`
 
-_Returns a media query between two given breakpoints_
-
-Given `start` and `end` breakpoint keys ("zero", "s", "m", "l", "xl"), this function returns a media
-query (string) using a min-width and max-width.
-
-> Note: This function subtracts `0.5px` from the next breakpoint value to prevent collisions. For
-> example, `breakpoints.values.s`, has a `min-width` of `320px`, and the `max-width` is `767.5px`).
-
-If the `xl` breakpoint is provided, this function returns a media query with only a `min-width`, as
-seen in the second example below.
-
-```ts
-import {useTheme} from '@workday/canvas-kit-react/common';
-import {space} from '@workday/canvas-kit-react/tokens';
-
-const theme = useTheme();
-const {between} = theme.canvas.breakpoints;
-// Returns '@media (min-width: 320px) and (max-width: 1023.5px)'
-const mediaQuery = between('s', 'm');
-const styles = {
-  [mediaQuery]: {
-    padding: space.s,
-  },
-};
-```
-
-This example uses `xl` as the `end` breakpoint and only adds a min-width to the media query.
-
-```ts
-import {useTheme} from '@workday/canvas-kit-react/common';
-import {space} from '@workday/canvas-kit-react/tokens';
-
-const theme = useTheme();
-const {between} = theme.canvas.breakpoints;
-const mediaQuery = between('m', 'xl'); // Returns '@media (min-width: 768px)'
-const styles = {
-  [mediaQuery]: {
-    padding: space.s,
-  },
-};
-```
-
-#### Only
-
-_Returns a media query with a `min-width` and `max-width` for a given breakpoint_
-
-Given a breakpoint key ("zero", "s", "m", "l", "xl"), this function returns a media query (string)
-using a `min-width` and `max-width`.
-
-> Note: This function subtracts `0.5px` from the next breakpoint value to prevent collisions.For
-> example, `breakpoints.values.s`, has a `min-width` of `320px`, and the `max-width` is `767.5px`).
-
-If the `xl` breakpoint is provided, this function returns a media query with only a `min-width` of
-`1440px`, as seen in the second example below.
-
-```ts
-import {useTheme} from '@workday/canvas-kit-react/common';
-import {space} from '@workday/canvas-kit-react/tokens';
-
-const theme = useTheme();
-const {only} = theme.canvas.breakpoints;
-const mediaQuery = only('s'); // Returns '@media (min-width: 320px) and (max-width: 767.5px)'
-const styles = {
-  [mediaQuery]: {
-    padding: space.s,
-  },
-};
-```
-
-This example uses the `xl` breakpoint and only adds a `min-width` of `1440px` to the media query.
-
-```ts
-import {useTheme} from '@workday/canvas-kit-react/common';
-import {space} from '@workday/canvas-kit-react/tokens';
-
-const theme = useTheme();
-const {only} = theme.canvas.breakpoints;
-const mediaQuery = only('m', 'xl'); // Returns '@media (min-width: 1440px)'
-const styles = {
-  [mediaQuery]: {
-    padding: space.s,
-  },
-};
-```
+> Returns a media query reflecting the size within your specified breakpoint. Works with the enum or
+> the string (e.g. 'm'). Example: theme.breakpointsonly(BreakpointKey.m) => '@media
+> (min-width:960px) and (max-width:1279.5px)'
 
 ## useIsRTL Hook