@telus-uds/components-base 4.0.0-alpha.2 → 4.0.0-beta.1

package/lib/esm/Button/ButtonGroup.js

@@ -21,6 +21,8 @@ import { getPressHandlersWithArgs } from '../utils/pressability';
 import { jsx as _jsx } from "react/jsx-runtime";
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
 const [selectItemProps, selectedItemPropTypes] = selectSystemProps([a11yProps, focusHandlerProps, pressProps, viewProps]);
+const EQUAL_WIDTH = 'equal';
+const RESPONSIVE_WIDTH = 'responsive';
 export const ButtonGroup = /*#__PURE__*/React.forwardRef((_ref, ref) => {
   let {
     variant,
@@ -65,31 +67,90 @@ export const ButtonGroup = /*#__PURE__*/React.forwardRef((_ref, ref) => {
   const isMobileNonContained = Platform.OS !== 'web' && (!variant || variant?.style !== 'contained');
   const themeButtonTokensCallback = useThemeTokensCallback('ButtonGroupItem', tokens, variant);
   const gapValue = useSpacingScale(gap || space);
+  const isWeb = Platform.OS === 'web';
+  const buttonWidthVariant = variant?.width;
   const getButtonTokens = useCallback(state => {
     const themeButtonTokens = themeButtonTokensCallback(state);
     const shouldUseTransparentBackground = isMobileNonContained && !state.selected && !state.pressed && !state.hover && !state.focus;
+    let widthStyle;
+    switch (buttonWidthVariant) {
+      case EQUAL_WIDTH:
+        widthStyle = staticStyles.equalWidth;
+        break;
+      case RESPONSIVE_WIDTH:
+        widthStyle = staticStyles.responsiveWidth;
+        break;
+      // no default
+    }
     return {
       ...themeButtonTokens,
-      ...(variant?.width === 'equal' && staticStyles.equalWidth),
+      ...widthStyle,
       ...(shouldUseTransparentBackground && {
         backgroundColor: 'transparent'
       }),
       alignSelf: themeButtonTokens.width ? 'flex-start' : 'center'
     };
-  }, [themeButtonTokensCallback, isMobileNonContained, variant?.width]);
-  const fieldsetStyles = useMemo(() => ({
-    ...staticStyles.fieldsetBase,
-    borderRadius,
-    backgroundColor: isMobileNonContained ? 'transparent' : backgroundColor || 'transparent',
-    padding,
-    width: variant?.width === 'equal' ? '100%' : 'auto'
-  }), [borderRadius, backgroundColor, padding, variant?.width, isMobileNonContained]);
-  const viewStyles = useMemo(() => ({
-    ...staticStyles.viewBase,
-    flexDirection: direction === 'column' ? 'column' : 'row',
-    gap: gapValue || 0,
-    justifyContent: variant?.width === 'equal' ? 'space-evenly' : 'flex-start'
-  }), [direction, gapValue, variant?.width]);
+  }, [themeButtonTokensCallback, isMobileNonContained, buttonWidthVariant]);
+  const fieldsetStyles = useMemo(() => {
+    let fieldSetBase;
+    switch (buttonWidthVariant) {
+      case EQUAL_WIDTH:
+      case RESPONSIVE_WIDTH:
+        fieldSetBase = staticStyles.fieldSetResponsive;
+        break;
+      default:
+        fieldSetBase = staticStyles.fieldsetBase;
+        break;
+    }
+    return {
+      ...fieldSetBase,
+      borderRadius,
+      backgroundColor: isMobileNonContained ? 'transparent' : backgroundColor || 'transparent',
+      padding
+    };
+  }, [borderRadius, backgroundColor, padding, isMobileNonContained, buttonWidthVariant]);
+  const buttonsContainerStyles = useMemo(() => {
+    let flexWrap;
+    if (isWeb) {
+      flexWrap = 'wrap';
+    } else {
+      switch (buttonWidthVariant) {
+        case EQUAL_WIDTH:
+        case RESPONSIVE_WIDTH:
+          flexWrap = 'nowrap';
+          break;
+        default:
+          flexWrap = 'wrap';
+          break;
+      }
+    }
+    let justifyContent;
+    switch (buttonWidthVariant) {
+      case EQUAL_WIDTH:
+        justifyContent = 'space-evenly';
+        break;
+      default:
+        justifyContent = 'flex-start';
+        break;
+    }
+    let viewBaseStyle;
+    switch (buttonWidthVariant) {
+      case EQUAL_WIDTH:
+      case RESPONSIVE_WIDTH:
+        viewBaseStyle = {};
+        break;
+      default:
+        viewBaseStyle = staticStyles.viewBase;
+        break;
+    }
+    return {
+      ...viewBaseStyle,
+      flexWrap,
+      flexDirection: direction === 'column' ? 'column' : 'row',
+      gap: gapValue || 0,
+      justifyContent
+    };
+  }, [direction, gapValue, buttonWidthVariant, isWeb]);
   const {
     currentValues,
     toggleOneValue
@@ -111,7 +172,7 @@ export const ButtonGroup = /*#__PURE__*/React.forwardRef((_ref, ref) => {
   }
 
   // Some web screenreaders e.g. MacOS Voiceover don't handle radiogroups properly unless radio is direct child of radiogroup
-  const innerRole = Platform.OS === 'web' && accessibilityRole === 'radiogroup' ? accessibilityRole : undefined;
+  const buttonsWrapperRole = Platform.OS === 'web' && accessibilityRole === 'radiogroup' ? accessibilityRole : undefined;
   return /*#__PURE__*/_jsx(Fieldset, {
     ...systemProps,
     ref: ref,
@@ -129,8 +190,8 @@ export const ButtonGroup = /*#__PURE__*/React.forwardRef((_ref, ref) => {
     style: fieldsetStyles,
     ...selectProps(rest),
     children: /*#__PURE__*/_jsx(View, {
-      accessibilityRole: innerRole,
-      style: viewStyles,
+      accessibilityRole: buttonsWrapperRole,
+      style: buttonsContainerStyles,
       children: items.map((_ref2, index) => {
         let {
           label,
@@ -300,17 +361,24 @@ ButtonGroup.propTypes = {
   copy: PropTypes.oneOf(['en', 'fr'])
 };
 const staticStyles = StyleSheet.create({
+  equalWidth: {
+    width: '100%',
+    flex: 1
+  },
+  responsiveWidth: {
+    width: 'auto'
+  },
   fieldsetBase: {
     alignSelf: 'flex-start',
-    display: 'inline'
+    display: 'inline',
+    width: 'auto'
+  },
+  fieldSetResponsive: {
+    width: '100%'
   },
   viewBase: {
     flexWrap: 'wrap',
     alignContent: 'stretch',
     alignItems: 'center'
-  },
-  equalWidth: {
-    width: '100%',
-    flex: 1
   }
 });

package/lib/esm/Card/CardBase.js

@@ -20,9 +20,7 @@ import { FlexGridCol } from '../FlexGrid/FlexGridCol/FlexGridCol';
 import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
 const GRID_COLUMNS = 12;
-const isOverlayColor = color => {
-  return color && typeof color === 'string' && color.startsWith('rgba(');
-};
+const isOverlayColor = color => color && typeof color === 'string' && color.startsWith('rgba(');
 const setBackgroundImage = _ref => {
   let {
     src,
@@ -31,7 +29,8 @@ const setBackgroundImage = _ref => {
     backgroundImagePosition,
     backgroundImageAlign,
     content,
-    cardStyle
+    cardStyle,
+    testID
   } = _ref;
   const borderRadius = cardStyle?.borderRadius || 0;
   const borderWidth = cardStyle?.borderWidth || 0;
@@ -91,6 +90,7 @@ const setBackgroundImage = _ref => {
         style: [staticStyles.imageBackground, backgroundImageStyle],
         role: "img",
         "aria-label": alt,
+        testID: testID,
         children: content
       });
     }
@@ -105,7 +105,8 @@ const setBackgroundImage = _ref => {
         style: [staticStyles.containImage, positionStyles],
         accessible: true,
         accessibilityLabel: alt,
-        accessibilityIgnoresInvertColors: true
+        accessibilityIgnoresInvertColors: true,
+        testID: testID
       }), /*#__PURE__*/_jsx(View, {
         style: staticStyles.contentOverlay,
         children: content
@@ -121,6 +122,7 @@ const setBackgroundImage = _ref => {
     style: staticStyles.imageBackground,
     accessible: true,
     accessibilityLabel: alt,
+    testID: testID,
     children: content
   });
 };
@@ -129,22 +131,13 @@ const selectPaddedContentStyles = _ref2 => {
     paddingTop,
     paddingBottom,
     paddingLeft,
-    paddingRight,
-    borderWidth,
-    borderColor,
-    borderRadius,
-    hasInteractiveBorder
+    paddingRight
   } = _ref2;
   return {
     paddingTop,
     paddingBottom,
     paddingLeft,
-    paddingRight,
-    ...(hasInteractiveBorder ? {
-      borderWidth,
-      borderColor,
-      borderRadius
-    } : {})
+    paddingRight
   };
 };
 const selectInteractiveOverlayStyles = _ref3 => {
@@ -163,12 +156,31 @@ const selectInteractiveOverlayStyles = _ref3 => {
     backgroundColor,
     borderRadius: adjustedBorderRadius,
     pointerEvents: 'none',
-    zIndex: 1
+    zIndex: 3
+  };
+};
+const selectOuterContainerStyles = _ref4 => {
+  let {
+    containerStyle,
+    backgroundColor,
+    borderRadius,
+    borderColor,
+    borderWidth,
+    hasGradientToken
+  } = _ref4;
+  return {
+    ...containerStyle,
+    backgroundColor,
+    borderRadius,
+    ...(hasGradientToken ? {} : {
+      borderColor,
+      borderWidth
+    })
   };
 };
 
 // Ensure explicit selection of tokens
-export const selectStyles = _ref4 => {
+export const selectStyles = function (_ref5) {
   let {
     flex,
     backgroundColor,
@@ -189,7 +201,10 @@ export const selectStyles = _ref4 => {
     gradient,
     maxHeight,
     overflowY
-  } = _ref4;
+  } = _ref5;
+  let {
+    hasBgImage = false
+  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   const hasGradient = (gradient || backgroundGradient) && Platform.OS === 'web';
   let backgroundImageValue = null;
   if (hasGradient) {
@@ -218,7 +233,11 @@ export const selectStyles = _ref4 => {
     ...(gradient && Platform.OS === 'web' ? {
       backgroundImage: backgroundImageValue,
       backgroundOrigin: `border-box`,
-      boxShadow: `inset 0 1000px ${boxShadowColor}`,
+      // bgImage child fills the content-box and replaces what the inset shadow
+      // used to cover, so we omit it to avoid hiding the image.
+      ...(hasBgImage ? {} : {
+        boxShadow: `inset 0 1000px ${boxShadowColor}`
+      }),
       border: `${borderWidth}px solid transparent`
     } : {}),
     ...(backgroundGradient && Platform.OS === 'web' ? {
@@ -235,7 +254,7 @@ export const selectStyles = _ref4 => {
  * A themeless base component for Card which components can apply theme tokens to. Not
  * intended to be used in apps or sites directly: build themed components on top of this.
  */
-export const CardBase = /*#__PURE__*/React.forwardRef((_ref5, ref) => {
+export const CardBase = /*#__PURE__*/React.forwardRef((_ref6, ref) => {
   let {
     children,
     tokens,
@@ -243,15 +262,14 @@ export const CardBase = /*#__PURE__*/React.forwardRef((_ref5, ref) => {
     backgroundImage,
     fullBleedContent,
     cardState,
+    testID,
     ...rest
-  } = _ref5;
+  } = _ref6;
   const resolvedTokens = typeof tokens === 'function' ? tokens(cardState) : tokens;
-  const tokensToUse = backgroundImage && backgroundImage.src ? {
-    ...resolvedTokens,
-    gradient: undefined,
-    backgroundGradient: undefined
-  } : resolvedTokens;
-  const cardStyle = selectStyles(tokensToUse);
+  const hasBgImage = Boolean(backgroundImage && backgroundImage.src);
+  const cardStyle = selectStyles(resolvedTokens, {
+    hasBgImage
+  });
   const props = selectProps(rest);
   let content = children;
   const {
@@ -284,31 +302,29 @@ export const CardBase = /*#__PURE__*/React.forwardRef((_ref5, ref) => {
       ...containerStyle
     } = cardStyle;
     const hasPadding = paddingTop || paddingBottom || paddingLeft || paddingRight;
-    const hasInteractiveBorder = borderWidth && borderWidth > 0;
     const hasInteractiveOverlay = isOverlayColor(backgroundColor);
-    const paddedContent = hasPadding || hasInteractiveBorder ? /*#__PURE__*/_jsx(View, {
+    const outerBackgroundColor = hasInteractiveOverlay ? undefined : backgroundColor;
+    const hasGradientToken = Boolean(resolvedTokens.gradient) && Platform.OS === 'web';
+    const paddedContent = hasPadding ? /*#__PURE__*/_jsx(View, {
       style: selectPaddedContentStyles({
         paddingTop,
         paddingBottom,
         paddingLeft,
-        paddingRight,
-        borderWidth,
-        borderColor,
-        borderRadius,
-        hasInteractiveBorder
+        paddingRight
       }),
       children: children
     }) : children;
     const contentWithOverlay = /*#__PURE__*/_jsxs(_Fragment, {
-      children: [hasInteractiveOverlay && Platform.OS === 'web' && /*#__PURE__*/_jsx(View, {
+      children: [/*#__PURE__*/_jsx(View, {
+        style: staticStyles.contentOverlay,
+        children: paddedContent
+      }), hasInteractiveOverlay && Platform.OS === 'web' && /*#__PURE__*/_jsx(View, {
         style: selectInteractiveOverlayStyles({
           backgroundColor,
           borderRadius,
           borderWidth
-        })
-      }), /*#__PURE__*/_jsx(View, {
-        style: staticStyles.contentOverlay,
-        children: paddedContent
+        }),
+        testID: testID && `${testID}-card-base-bg-overlay`
       })]
     });
     content = setBackgroundImage({
@@ -319,17 +335,23 @@ export const CardBase = /*#__PURE__*/React.forwardRef((_ref5, ref) => {
       backgroundImageAlign,
       content: contentWithOverlay,
       cardStyle: {
-        ...containerStyle,
-        borderRadius
-      }
+        borderRadius,
+        borderWidth
+      },
+      testID: testID && `${testID}-card-base-bg-image`
     });
     return /*#__PURE__*/_jsx(View, {
-      style: {
-        ...containerStyle,
-        borderRadius
-      },
+      style: selectOuterContainerStyles({
+        containerStyle,
+        backgroundColor: outerBackgroundColor,
+        borderRadius,
+        borderColor,
+        borderWidth,
+        hasGradientToken
+      }),
       dataSet: dataSet,
       ref: ref,
+      testID: testID,
       ...props,
       children: content
     });
@@ -369,6 +391,7 @@ export const CardBase = /*#__PURE__*/React.forwardRef((_ref5, ref) => {
       style: containerStyle,
       dataSet: dataSet,
       ref: ref,
+      testID: testID,
       ...props,
       children: /*#__PURE__*/_jsx(FlexGrid, {
         children: /*#__PURE__*/_jsx(FlexGridRow, {
@@ -385,6 +408,7 @@ export const CardBase = /*#__PURE__*/React.forwardRef((_ref5, ref) => {
     style: cardStyle,
     dataSet: dataSet,
     ref: ref,
+    testID: testID,
     ...props,
     children: content
   });
@@ -427,6 +451,10 @@ CardBase.propTypes = {
   ...selectedSystemPropTypes,
   children: PropTypes.node,
   tokens: getTokensPropType('Card'),
+  /**
+   * Identifier for testing purposes.
+   */
+  testID: PropTypes.string,
   /**
    * Apply background image to the card.
    */

package/lib/esm/ColourToggle/ColourBubble.js

@@ -3,11 +3,13 @@ import PropTypes from 'prop-types';
 import View from "react-native-web/dist/exports/View";
 import Pressable from "react-native-web/dist/exports/Pressable";
 import Platform from "react-native-web/dist/exports/Platform";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
 import { resolvePressableTokens } from '../utils/pressability';
 import { applyShadowToken } from '../ThemeProvider/utils/styles';
 import { getTokensPropType } from '../utils/props/tokens';
 import { Tooltip } from '../Tooltip/Tooltip.native';
-import { jsx as _jsx } from "react/jsx-runtime";
+import { UNAVAILABLE_VARIANT } from './constants';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 const selectGeneralBubbleTokens = _ref => {
   let {
     outerBubbleHeight,
@@ -63,37 +65,70 @@ const selectBorderBubbleTokens = _ref3 => {
     borderRadius: bubbleBorderRadius
   };
 };
-export const ColourBubble = /*#__PURE__*/React.forwardRef((_ref4, ref) => {
+const selectOverlayStyles = _ref4 => {
   let {
-    tokens = {},
+    overlayColor,
+    innerBubbleBorderRadius
+  } = _ref4;
+  return {
+    borderRadius: innerBubbleBorderRadius,
+    backgroundColor: overlayColor
+  };
+};
+const selectSlashStyles = (_ref5, unavailable) => {
+  let {
+    slashLightColor,
+    slashDarkColor,
+    slashWidth,
+    slashOffset
+  } = _ref5;
+  return {
+    width: slashWidth,
+    backgroundColor: unavailable === UNAVAILABLE_VARIANT.DARK ? slashDarkColor : slashLightColor,
+    marginLeft: slashOffset
+  };
+};
+export const ColourBubble = /*#__PURE__*/React.forwardRef((_ref6, ref) => {
+  let {
+    tokens = () => ({}),
     id,
     colourHexCode,
     colourName,
     isSelected,
     onPress,
-    showTooltip
-  } = _ref4;
+    showTooltip,
+    unavailable,
+    isDisabled
+  } = _ref6;
   const defaultTokens = tokens({
     selected: isSelected
   });
-  const resolveColourBubbleTokens = pressState => resolvePressableTokens(tokens, pressState, {});
-  const themeTokens = React.useMemo(() => tokens(), [tokens]);
-  const pressable = /*#__PURE__*/_jsx(Pressable, {
+  const resolveColourBubbleTokens = pressState => resolvePressableTokens(tokens, isDisabled ? {} : pressState, {});
+  const themeTokens = tokens();
+  const pressable = /*#__PURE__*/_jsxs(Pressable, {
     style: state => [selectGeneralBubbleTokens(resolveColourBubbleTokens(state)), isSelected && selectBorderBubbleTokens(defaultTokens)],
     onPress: onPress,
+    disabled: isDisabled,
+    focusable: !isDisabled,
     accessible: true,
     accessibilityRole: "radio",
     accessibilityLabel: colourName,
     accessibilityState: {
-      checked: isSelected
+      checked: isSelected,
+      disabled: isDisabled
     },
     ref: ref,
     testID: id,
-    children: /*#__PURE__*/_jsx(View, {
+    children: [/*#__PURE__*/_jsx(View, {
       style: [selectInnerBubbleTokens(themeTokens), {
         backgroundColor: colourHexCode
-      }]
-    })
+      }],
+      children: unavailable && /*#__PURE__*/_jsx(View, {
+        style: [StyleSheet.absoluteFillObject, selectOverlayStyles(themeTokens)]
+      })
+    }), unavailable && /*#__PURE__*/_jsx(View, {
+      style: [staticStyles.indicator, selectSlashStyles(themeTokens, unavailable)]
+    })]
   });
   if (showTooltip) {
     return /*#__PURE__*/_jsx(Tooltip, {
@@ -135,5 +170,23 @@ ColourBubble.propTypes = {
   /**
    * When true, wraps the bubble in a Tooltip that displays the colourName on hover (web only).
    */
-  showTooltip: PropTypes.bool
-};
+  showTooltip: PropTypes.bool,
+  /**
+   * When set, renders a diagonal indicator over the bubble. Accepts either 'dark' or 'light' to determine the colour of the indicator.
+   */
+  unavailable: PropTypes.oneOf(Object.values(UNAVAILABLE_VARIANT)),
+  /**
+   * When true, disables interaction on the bubble.
+   */
+  isDisabled: PropTypes.bool
+};
+const staticStyles = StyleSheet.create({
+  indicator: {
+    position: 'absolute',
+    top: '50%',
+    height: 2,
+    transform: [{
+      rotate: '-45deg'
+    }]
+  }
+});

package/lib/esm/ColourToggle/ColourToggle.js

@@ -7,9 +7,12 @@ import { getTokensPropType } from '../utils/props/tokens';
 import { selectSystemProps } from '../utils/props/selectSystemProps';
 import { variantProp } from '../utils/props/variantProp';
 import { viewProps } from '../utils/props/viewProps';
+import { useCopy } from '../utils/useCopy';
 import { StackWrap } from '../StackView/StackWrap';
 import { Typography } from '../Typography/Typography';
 import { ColourBubble } from './ColourBubble';
+import { UNAVAILABLE_VARIANT, DICTIONARY_CONTENT_SHAPE } from './constants';
+import { DEFAULT_COLOUR_TOGGLE_DICTIONARY } from './dictionary';
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
 export const ColourToggle = /*#__PURE__*/React.forwardRef((_ref, ref) => {
@@ -20,37 +23,49 @@ export const ColourToggle = /*#__PURE__*/React.forwardRef((_ref, ref) => {
     items,
     onChange,
     showTooltips,
+    copy = 'en',
+    dictionary = DEFAULT_COLOUR_TOGGLE_DICTIONARY,
     ...rest
   } = _ref;
   const [currentColourId, setCurrentColourId] = React.useState(defaultColourId);
   const getTokens = useThemeTokensCallback('ColourToggle', tokens, variant);
+  const getCopy = useCopy({
+    dictionary,
+    copy
+  });
   const {
     space
   } = getTokens();
-  const {
-    colourName: currentColourName = ''
-  } = items.find(item => item.id === currentColourId) || '';
+  const currentItem = items.find(_ref2 => {
+    let {
+      id
+    } = _ref2;
+    return id === currentColourId;
+  });
   return /*#__PURE__*/_jsxs(View, {
     ref: ref,
     ...selectProps(rest),
     children: [/*#__PURE__*/_jsx(Typography, {
-      children: currentColourName
+      children: currentItem?.unavailable ? `${currentItem.colourName} ${getCopy('unavailable')}` : currentItem?.colourName ?? ''
     }), /*#__PURE__*/_jsx(StackWrap, {
       space: space,
       accessibilityRole: "radiogroup",
-      children: items.map((_ref2, index) => {
+      children: items.map((_ref3, index) => {
         let {
           id,
           colourHexCode,
-          colourName
-        } = _ref2;
+          colourName,
+          unavailable,
+          disabled
+        } = _ref3;
         const colourBubbleId = id || `ColourBubble[${index}]`;
         const handleChangeColour = event => {
           setCurrentColourId(id);
           onChange?.(event, {
             id,
             colourHexCode,
-            colourName
+            colourName,
+            unavailable
           });
         };
         return /*#__PURE__*/_jsx(ColourBubble, {
@@ -60,7 +75,9 @@ export const ColourToggle = /*#__PURE__*/React.forwardRef((_ref, ref) => {
           colourHexCode: colourHexCode,
           colourName: colourName,
           onPress: handleChangeColour,
-          showTooltip: showTooltips
+          showTooltip: showTooltips,
+          unavailable: unavailable,
+          isDisabled: !!disabled
         }, colourBubbleId);
       })
     })]
@@ -87,7 +104,9 @@ ColourToggle.propTypes = {
   items: PropTypes.arrayOf(PropTypes.exact({
     colourHexCode: PropTypes.string,
     colourName: PropTypes.string,
-    id: PropTypes.string
+    id: PropTypes.string,
+    unavailable: PropTypes.oneOf(Object.values(UNAVAILABLE_VARIANT)),
+    disabled: PropTypes.bool
   })),
   /**
    * If provided, this function is called when the current selection of the color is changed of all currently `items`. Receives two parameters: item object selected and the event
@@ -96,5 +115,16 @@ ColourToggle.propTypes = {
   /**
    * When true, displays each colour's name as a tooltip on hover (web only).
    */
-  showTooltips: PropTypes.bool
+  showTooltips: PropTypes.bool,
+  /**
+   * Select English or French copy.
+   */
+  copy: PropTypes.oneOf(['en', 'fr']),
+  /**
+   * Override default labels.
+   */
+  dictionary: PropTypes.shape({
+    en: DICTIONARY_CONTENT_SHAPE,
+    fr: DICTIONARY_CONTENT_SHAPE
+  })
 };

package/lib/esm/ColourToggle/constants.js

@@ -0,0 +1,8 @@
+import PropTypes from 'prop-types';
+export const UNAVAILABLE_VARIANT = {
+  DARK: 'dark',
+  LIGHT: 'light'
+};
+export const DICTIONARY_CONTENT_SHAPE = PropTypes.shape({
+  unavailable: PropTypes.string
+});

package/lib/esm/ColourToggle/dictionary.js

@@ -0,0 +1,8 @@
+export const DEFAULT_COLOUR_TOGGLE_DICTIONARY = {
+  en: {
+    unavailable: '(Out of stock)'
+  },
+  fr: {
+    unavailable: '(En rupture de stock)'
+  }
+};