@telus-uds/components-base 1.65.0 → 1.67.0

package/lib-module/ThemeProvider/utils/styles.js

@@ -3,8 +3,9 @@
  * don't map directly to cross-platform design token values.
  */
 import Platform from "react-native-web/dist/exports/Platform";
-import { fontBasePixels } from '@telus-uds/system-constants'; // Make design tokens fit React Native's text styles' specific requirements and quirks
+import { fontBasePixels } from '@telus-uds/system-constants';
 
+// Make design tokens fit React Native's text styles' specific requirements and quirks
 export function applyTextStyles(_ref) {
   let {
     fontColor,
@@ -21,27 +22,24 @@ export function applyTextStyles(_ref) {
     },
     ...rest
   } = _ref;
-  const styles = { ...rest
+  const styles = {
+    ...rest
   };
   const {
     forceAbsoluteFontSizing
   } = themeOptions;
-
   if (fontSize) {
     // If relative font sizes are needed, catch and calculate them here
     styles.fontSize = Platform.OS === 'web' && !forceAbsoluteFontSizing ? `${fontSize / fontBasePixels}rem` : fontSize;
   }
-
   if (typeof lineHeight === 'number') {
     // React Native expects absolute line heights but multipliers are better as design tokens
     styles.lineHeight = lineHeight * (fontSize || fontBasePixels);
   }
-
   if (typeof letterSpacing === 'number' && letterSpacing) {
     // Same as for line heights - React Native expects absolute letter spacing value
     styles.letterSpacing = letterSpacing * (fontSize || fontBasePixels);
   }
-
   if (fontName) {
     // Don't set undefined font families. May need some validation here that the font is available.
     // Android doesn't recognise font weights natively so apply custom font weights via `fontFamily`.
@@ -51,16 +49,17 @@ export function applyTextStyles(_ref) {
     // Font weight support in Android is limited to 'bold' or anything else === 'normal'.
     styles.fontWeight = Platform.OS === 'android' && Number(fontWeight) > 400 ? 'bold' : fontWeight;
   }
-
   if (fontColor) {
     styles.color = fontColor;
-  } // TODO: look into calculating typographic spacing with PixelRatio.getFontScale()
+  }
+
+  // TODO: look into calculating typographic spacing with PixelRatio.getFontScale()
   // Do while implementing advanced typography e.g. paragraph etc
   // https://github.com/telus/universal-design-system/issues/89
 
-
   return styles;
 }
+
 /**
  * React Native's in-built shadow support is limited. Take an object describing an ideal shadow and
  * return a platform-appropriate implementation that gets close to the described effect.
@@ -74,7 +73,6 @@ export function applyTextStyles(_ref) {
  * @param {number}  shadowToken.spread
  * @return {object}
  */
-
 export function applyShadowToken(shadowToken) {
   if (!shadowToken) return {};
   const applyShadow = Platform.select({
@@ -84,7 +82,6 @@ export function applyShadowToken(shadowToken) {
   });
   return applyShadow();
 }
-
 function applyWebShadow(_ref2) {
   let {
     inset,
@@ -100,7 +97,6 @@ function applyWebShadow(_ref2) {
   };
   return boxShadow;
 }
-
 function applyAndroidShadow(shadowToken) {
   const {
     color,
@@ -108,23 +104,20 @@ function applyAndroidShadow(shadowToken) {
     spread,
     offsetY,
     offsetX
-  } = shadowToken; // Android shadows are very limited and workarounds are hacky. Use the built-in `elevation` API unless
+  } = shadowToken;
+  // Android shadows are very limited and workarounds are hacky. Use the built-in `elevation` API unless
   // shadow design is radically different to a simple top-down shadow (e.g. horizontal, upward, or inset)
-
   if (!inset && offsetY >= 0 && offsetY >= offsetX) {
     return {
       // Can't match other platforms, but can give longer shadows to elements designed for longer shadows
       elevation: spread + offsetY,
       shadowColor: color // Only applies on Android >= 9 and React Native >= 0.64.0
-
     };
-  } // TODO: maybe use a library or workaround to increase capabilities.
+  }
+  // TODO: maybe use a library or workaround to increase capabilities.
   // https://github.com/telus/universal-design-system/issues/535
-
-
   return {};
 }
-
 function applyIosShadow(_ref3) {
   let {
     inset,
@@ -138,15 +131,15 @@ function applyIosShadow(_ref3) {
   // TODO: maybe use a library or workaround for inset shadows. This is a sizable task and would
   // involve changing component implementations to use a custom view, can't be done with styles alone.
   // https://github.com/telus/universal-design-system/issues/535
-  if (inset) return {}; // React Native iOS doesn't support spread. Where there's an offset, can approximate positive spread by
+  if (inset) return {};
+
+  // React Native iOS doesn't support spread. Where there's an offset, can approximate positive spread by
   // increasing the (positive or negative) offset by the spread. This makes the shadow reach the point it
   // would if spread was supported (with a side effect that its start is further "under" the element).
-
   const nudgeBySpread = offset => {
     if (!offset || spread <= 0) return 0;
     return offset > 0 ? spread : spread * -1;
   };
-
   return {
     shadowColor: color,
     shadowOffset: {
@@ -155,7 +148,6 @@ function applyIosShadow(_ref3) {
     },
     shadowRadius: blur,
     shadowOpacity: 1 // opacity is applied via RGBA in the `color` token
-
   };
 }
 
@@ -171,20 +163,16 @@ export function verticalAlignRow(verticalAlign) {
     alignItems: verticalAlignToFlexRowAlign[verticalAlign]
   };
 }
-
 const calculateBorderRadius = (borderRadius, outerBorderGap, outerBorderWidth) => {
   if (borderRadius) {
     return borderRadius + outerBorderGap + outerBorderWidth;
   }
-
   return null;
 };
 /**
  * Use on an outer container to create an outer border with an optional gap around it
  * that matches the border radius of any inner border.
  */
-
-
 export const applyOuterBorder = _ref4 => {
   let {
     outerBorderColor,

package/lib-module/ThemeProvider/utils/theme-tokens.js

@@ -1,6 +1,7 @@
 import PropTypes from 'prop-types';
 import semVerSatisfies from 'semver/functions/satisfies';
 import pkg from '../../../package.json';
+
 /**
  * @typedef {import('../../utils/props/variantProp.js').AppearanceSet} AppearanceSet
  * @typedef {import('../../utils/props/tokens.js').TokensProp} TokensProp
@@ -13,25 +14,19 @@ import pkg from '../../../package.json';
 
 export const getComponentTheme = (theme, componentName) => {
   var _theme$metadata;
-
   // Give clear and understandable error messages for common dev errors, for example,
   // typo in component name, missing export or accessing old version of theme
   if (!theme) {
     throw new Error(`Called useTheme's getStyle on "${componentName}" with no theme provided`);
   }
-
   const themeName = ((_theme$metadata = theme.metadata) === null || _theme$metadata === void 0 ? void 0 : _theme$metadata.name) || '';
-
   if (!theme.components) {
     throw new Error(`Theme "${themeName}" has no components defined (looking for "${componentName}")`);
   }
-
   const componentTheme = theme.components[componentName];
-
   if (!componentTheme) {
     throw new Error(`Theme "${themeName}" does not have styles for component "${componentName}"`);
   }
-
   return componentTheme;
 };
 export const doesThemeConditionApply = (_ref, appearances) => {
@@ -41,6 +36,7 @@ export const doesThemeConditionApply = (_ref, appearances) => {
   return Array.isArray(value) ? value.includes(appearanceValue) : value === appearanceValue;
 };
 export const doesThemeRuleApply = (rule, appearances) => Object.entries(rule.if).every(condition => doesThemeConditionApply(condition, appearances));
+
 /**
  * Turns a tokens prop (which may be either a tokens object or a tokens getter function)
  * into one resolved tokens object, based on current appearances state.
@@ -57,21 +53,20 @@ export const doesThemeRuleApply = (rule, appearances) => Object.entries(rule.if)
  * @param {TokensProp} [tokenOverrides] - optional set of tokens or tokens getter function to override the default
  * @returns {TokensSet} - object containing resolved tokens with overrides applied
  */
-
 export const resolveThemeTokens = function (defaultTokens) {
   let appearances = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   let tokenOverrides = arguments.length > 2 ? arguments[2] : undefined;
-
   const resolve = tokens => typeof tokens === 'function' ? tokens(appearances) : tokens;
-
   if (!tokenOverrides) return resolve(defaultTokens);
   return Object.entries(resolve(tokenOverrides)).reduce((mergedTokens, _ref2) => {
     let [tokenName, tokenValue] = _ref2;
-    return tokenValue === undefined ? mergedTokens : { ...mergedTokens,
+    return tokenValue === undefined ? mergedTokens : {
+      ...mergedTokens,
       [tokenName]: tokenValue
     };
   }, resolve(defaultTokens));
 };
+
 /**
  * Gives a prop types error if a set of resolved tokens doesn't match a provided prop
  * types validator.
@@ -83,7 +78,6 @@ export const resolveThemeTokens = function (defaultTokens) {
  * @param {function} validator - PropTypes validator function
  * @param {string} componentName - identifier to display in PropType error messages
  */
-
 export const validateThemeTokens = (themeTokens, validator, componentName) => {
   PropTypes.checkPropTypes({
     tokens: validator
@@ -92,6 +86,7 @@ export const validateThemeTokens = (themeTokens, validator, componentName) => {
   }, 'resolved token', componentName);
   return themeTokens;
 };
+
 /**
  * Merges variants over states. Must be merged in that order to allow static showcases of a state,
  * e.g. `<Button variant={{ pressed: true }} />` where button's pressed state is `false` by default.
@@ -101,14 +96,15 @@ export const validateThemeTokens = (themeTokens, validator, componentName) => {
  * @param {AppearanceSet} [states]
  * @returns {AppearanceSet}
  */
-
 export const mergeAppearances = function () {
   let variants = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   let states = arguments.length > 1 ? arguments[1] : undefined;
-  return states ? { ...states,
+  return states ? {
+    ...states,
     ...variants
   } : variants;
 };
+
 /**
  * Get a set of theme tokens by applying a theme's component rules based on a component's variants and state.
  *
@@ -120,7 +116,6 @@ export const mergeAppearances = function () {
  * @param {object} [states] - object containing current state options for this component instance
  * @returns {object} Set of resolved theme tokens
  */
-
 export const getThemeTokens = function (_ref3, tokensProp) {
   let {
     rules = [],
@@ -128,15 +123,18 @@ export const getThemeTokens = function (_ref3, tokensProp) {
   } = _ref3;
   let variants = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   let states = arguments.length > 3 ? arguments[3] : undefined;
-  const appearances = mergeAppearances(variants, states); // TODO: if in dev mode, validate the appearances and provided propTokens
-  // Get the theme's default tokens set and merge tokens from applicable theme rules over it
+  const appearances = mergeAppearances(variants, states);
+  // TODO: if in dev mode, validate the appearances and provided propTokens
 
-  const themeTokens = rules.reduce((mergedTokens, rule) => doesThemeRuleApply(rule, appearances) ? { ...mergedTokens,
+  // Get the theme's default tokens set and merge tokens from applicable theme rules over it
+  const themeTokens = rules.reduce((mergedTokens, rule) => doesThemeRuleApply(rule, appearances) ? {
+    ...mergedTokens,
     ...rule.tokens
   } : mergedTokens, defaultThemeTokens);
   return resolveThemeTokens(themeTokens, appearances, tokensProp);
 };
 export const toArray = strOrArr => Array.isArray(strOrArr) ? strOrArr : [strOrArr];
+
 /**
  * Throws an error if the theme was built with an incompatible version of @telus-uds/system-theme-tokens
  *
@@ -148,13 +146,10 @@ export const toArray = strOrArr => Array.isArray(strOrArr) ? strOrArr : [strOrAr
  *
  * @param {object} theme - UDS theme built for react-native
  */
-
 export const validateThemeTokensVersion = theme => {
   var _theme$metadata2;
-
   const expectedThemeTokensVersion = pkg.dependencies['@telus-uds/system-theme-tokens'];
   const actualThemeTokensVersion = theme === null || theme === void 0 ? void 0 : (_theme$metadata2 = theme.metadata) === null || _theme$metadata2 === void 0 ? void 0 : _theme$metadata2.themeTokensVersion;
-
   if (!semVerSatisfies(actualThemeTokensVersion, expectedThemeTokensVersion)) {
     throw new Error(`Invalid UDS token schema version detected.
 

package/lib-module/Timeline/Timeline.js

@@ -6,7 +6,6 @@ import { getTokensPropType, variantProp, a11yProps, viewProps, selectSystemProps
 import { useViewport } from '../ViewportProvider';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
-
 const selectDotStyles = _ref => {
   let {
     dotWidth,
@@ -23,7 +22,6 @@ const selectDotStyles = _ref => {
     borderColor: timelineColor
   };
 };
-
 const selectConnectorStyles = _ref2 => {
   let {
     timelineConnectorColor,
@@ -36,7 +34,6 @@ const selectConnectorStyles = _ref2 => {
     backgroundColor: timelineConnectorColor
   };
 };
-
 const selectTimelineContainerStyle = _ref3 => {
   let {
     timelineContainerDirection
@@ -45,7 +42,6 @@ const selectTimelineContainerStyle = _ref3 => {
     flexDirection: timelineContainerDirection
   };
 };
-
 const selectLineItemStyles = _ref4 => {
   let {
     lineItemAlign,
@@ -61,7 +57,6 @@ const selectLineItemStyles = _ref4 => {
     overflow: 'hidden'
   };
 };
-
 const selectLineItemContainer = _ref5 => {
   let {
     lineItemContainerDirection,
@@ -72,7 +67,6 @@ const selectLineItemContainer = _ref5 => {
     flex: lineContainerFlexSize
   };
 };
-
 const selectItemContentStyles = (_ref6, isLastChild) => {
   let {
     itemContentFlexSize,
@@ -85,8 +79,8 @@ const selectItemContentStyles = (_ref6, isLastChild) => {
     marginRight: !isLastChild && itemContentMarginRight
   };
 };
-
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
+
 /**
  * Timeline is a component that displays either a horizontal or vertical list of the
  * children components passed by props
@@ -99,7 +93,6 @@ const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, vie
  * ## A11y guidelines
  * Timeline link supports all the common a11y props.
  */
-
 const Timeline = /*#__PURE__*/forwardRef((_ref7, ref) => {
   let {
     tokens,
@@ -114,20 +107,23 @@ const Timeline = /*#__PURE__*/forwardRef((_ref7, ref) => {
   const themeTokens = useThemeTokens('Timeline', tokens, variant, {
     viewport
   });
-  const containerProps = { ...selectProps(rest),
+  const containerProps = {
+    ...selectProps(rest),
     ...getA11yPropsFromHtmlTag(tag, rest.accessibilityRole || 'list'),
     accessibilityLabel
   };
-  return /*#__PURE__*/_jsx(View, { ...containerProps,
+  return /*#__PURE__*/_jsx(View, {
+    ...containerProps,
     ref: ref,
     style: selectTimelineContainerStyle(themeTokens),
     children: children.map((child, index) => {
       var _child$props;
-
-      const childrenProps = { ...getA11yPropsFromHtmlTag(childrenTag, (child === null || child === void 0 ? void 0 : (_child$props = child.props) === null || _child$props === void 0 ? void 0 : _child$props.accessibilityRole) || 'listitem')
+      const childrenProps = {
+        ...getA11yPropsFromHtmlTag(childrenTag, (child === null || child === void 0 ? void 0 : (_child$props = child.props) === null || _child$props === void 0 ? void 0 : _child$props.accessibilityRole) || 'listitem')
       };
       return /*#__PURE__*/_jsxs(View, {
-        style: selectLineItemContainer(themeTokens) // eslint-disable-next-line react/no-array-index-key
+        style: selectLineItemContainer(themeTokens)
+        // eslint-disable-next-line react/no-array-index-key
         ,
         ...childrenProps,
         children: [/*#__PURE__*/_jsxs(View, {
@@ -146,21 +142,19 @@ const Timeline = /*#__PURE__*/forwardRef((_ref7, ref) => {
   });
 });
 Timeline.displayName = 'Timeline';
-Timeline.propTypes = { ...selectedSystemPropTypes,
+Timeline.propTypes = {
+  ...selectedSystemPropTypes,
   tokens: getTokensPropType('Timeline'),
   variant: variantProp.propType,
-
   /**
    * A list of components that will be rendered either horizontally or vertically
    */
   children: PropTypes.arrayOf(PropTypes.node).isRequired,
-
   /**
    * A required accessibility label that needs to be passed to be used on List
    * which is applied as normal for a React Native accessibilityLabel prop.
    */
   accessibilityLabel: PropTypes.string.isRequired,
-
   /**
    * Sets the HTML tag of the outer container and the children. By default `'li'` for the children
    * and `'ul'` for the container

package/lib-module/ToggleSwitch/ToggleSwitch.js

@@ -11,9 +11,10 @@ import { a11yProps, focusHandlerProps, getTokensPropType, selectTokens, pressPro
 import { useInputValue } from '../utils/input';
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
-const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, focusHandlerProps, pressProps, viewProps]); // We need to drop the icon before passing it to the `ButtonBase`, because it's
-// being handled separately in this case
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, focusHandlerProps, pressProps, viewProps]);
 
+// We need to drop the icon before passing it to the `ButtonBase`, because it's
+// being handled separately in this case
 const selectButtonTokens = (_ref, _ref2) => {
   let {
     icon: _,
@@ -23,15 +24,16 @@ const selectButtonTokens = (_ref, _ref2) => {
     trackHeight,
     outerBorderGapButton
   } = _ref2;
-  return selectTokens('Button', { ...tokens,
+  return selectTokens('Button', {
+    ...tokens,
     // Width tokens are applied to our inner track. Disable Button width token so it wraps our track width.
     outerBorderGap: outerBorderGapButton,
     height: trackHeight,
     width: null
   });
-}; // Map and rename icon-specific tokens to name used within Icon
-
+};
 
+// Map and rename icon-specific tokens to name used within Icon
 const selectIconTokens = _ref3 => {
   let {
     iconSize,
@@ -42,7 +44,6 @@ const selectIconTokens = _ref3 => {
     color: iconColor
   };
 };
-
 const selectTrackSwitchStyles = _ref4 => {
   let {
     switchSize,
@@ -54,7 +55,6 @@ const selectTrackSwitchStyles = _ref4 => {
     height: Math.max(switchSize, trackHeight)
   };
 };
-
 const selectTrackStyles = _ref5 => {
   let {
     trackBorderWidth,
@@ -69,7 +69,6 @@ const selectTrackStyles = _ref5 => {
     width
   };
 };
-
 const selectSwitchStyles = _ref6 => {
   let {
     switchSize,
@@ -96,7 +95,6 @@ const selectSwitchStyles = _ref6 => {
     })
   };
 };
-
 const selectLabelStyles = _ref7 => {
   let {
     labelMarginLeft
@@ -105,7 +103,6 @@ const selectLabelStyles = _ref7 => {
     marginLeft: labelMarginLeft
   };
 };
-
 const selectLabelTokens = _ref8 => {
   let {
     labelColor,
@@ -122,7 +119,6 @@ const selectLabelTokens = _ref8 => {
     lineHeight: labelLineHeight
   };
 };
-
 const ToggleSwitch = /*#__PURE__*/forwardRef((_ref9, ref) => {
   let {
     copy = 'en',
@@ -149,11 +145,8 @@ const ToggleSwitch = /*#__PURE__*/forwardRef((_ref9, ref) => {
     initialValue,
     onChange
   });
-
   const handlePress = event => setValue(!currentValue, event);
-
   const getButtonTokens = buttonState => selectButtonTokens(getTokens(buttonState), getTokens(themeTokens));
-
   const uniqueId = useUniqueId('toggleSwitch');
   const inputId = id ?? uniqueId;
   return /*#__PURE__*/_jsxs(StackView, {
@@ -196,10 +189,10 @@ const ToggleSwitch = /*#__PURE__*/forwardRef((_ref9, ref) => {
           trackHeight,
           width,
           trackBorderWidth
-        } = stateTokens; // If drag-slide support is needed, use a PanResponder and apply these to an Animated value.
+        } = stateTokens;
+        // If drag-slide support is needed, use a PanResponder and apply these to an Animated value.
         // Use translate transforms for smoothest non-thread-blocking animations and to allow drag.
         // Two different translates depending on the switchSize and trackSize relationship.
-
         const isSwitchTallerThanTrack = switchSize >= trackHeight;
         const slideStart = isSwitchTallerThanTrack ? 0 : trackBorderWidth;
         const slideEnd = isSwitchTallerThanTrack ? width - switchSize : width - switchSize - trackBorderWidth;
@@ -216,7 +209,8 @@ const ToggleSwitch = /*#__PURE__*/forwardRef((_ref9, ref) => {
             style: [staticStyles.track, trackStyles]
           }), /*#__PURE__*/_jsx(View, {
             style: [staticStyles.switch, switchStyles, switchPositionStyle],
-            children: IconComponent && /*#__PURE__*/_jsx(IconComponent, { ...iconTokens
+            children: IconComponent && /*#__PURE__*/_jsx(IconComponent, {
+              ...iconTokens
             })
           })]
         });
@@ -225,50 +219,43 @@ const ToggleSwitch = /*#__PURE__*/forwardRef((_ref9, ref) => {
   });
 });
 ToggleSwitch.displayName = 'ToggleSwitch';
-ToggleSwitch.propTypes = { ...selectedSystemPropTypes,
-
+ToggleSwitch.propTypes = {
+  ...selectedSystemPropTypes,
   /**
    * Whether the English or French copy will be used (e.g. for accessibility labels).
    */
   copy: PropTypes.oneOf(['en', 'fr']),
   tokens: getTokensPropType('ToggleSwitch'),
   variant: variantProp.propType,
-
   /**
    * If this is a "controlled" component and a parent handles its selected state,
    * tells the switch if it is on (true) or off (false).
    */
   value: PropTypes.bool,
-
   /**
    * If this is an "uncontrolled" component that handles its own selected state,
    * optionally tells the switch if it should default to on (true) or off (false).
    */
   initialValue: PropTypes.bool,
-
   /**
    * Function called when the switch is toggled, with one boolean argument that is the
    * new position of the switch, on (true) or off (false). For "controlled" components,
    * this should always be passed and used to control the state of the switch.
    */
   onChange: PropTypes.func,
-
   /**
    * Input ID.
    */
   id: PropTypes.string,
-
   /**
    * An optional label.
    */
   label: PropTypes.string,
-
   /**
    * If passed, the switch does not respond to user input and may recieve different
    * theme tokens if the theme supports inactive appearance.
    */
   inactive: PropTypes.bool,
-
   /**
    * Content of an optional Tooltip. If set, a tooltip button will be shown next to the label.
    */