@telus-uds/components-base 1.66.0 → 1.67.1

package/lib/utils/props/handlerProps.js

@@ -4,22 +4,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.textInputHandlerProps = exports.focusHandlerProps = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
-
 var _getPropSelector = _interopRequireDefault(require("./getPropSelector"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const focusHandlerProps = {
   types: {
     /**
      * onBlur handler
      */
     onBlur: _propTypes.default.func,
-
     /**
      * onFocus handler
      */
@@ -34,62 +28,50 @@ const textInputHandlerProps = {
      * onChange handler
      */
     onChange: _propTypes.default.func,
-
     /**
      * onChangeText handler
      */
     onChangeText: _propTypes.default.func,
-
     /**
      * onClear handler
      */
     onClear: _propTypes.default.func,
-
     /**
      * onSubmit handler
      */
     onSubmit: _propTypes.default.func,
-
     /**
      * onSubmitEditing handler
      */
     onSubmitEditing: _propTypes.default.func,
-
     /**
      * onContentSizeChange handler
      */
     onContentSizeChange: _propTypes.default.func,
-
     /**
      * onEndEditing handler
      */
     onEndEditing: _propTypes.default.func,
-
     /**
      * onScroll handler
      */
     onScroll: _propTypes.default.func,
-
     /**
      * onSelectionChange handler
      */
     onSelectionChange: _propTypes.default.func,
-
     /**
      * onKeyPress handler
      */
     onKeyPress: _propTypes.default.func,
-
     /**
      * onKeyUp handler (only supported on Web)
      */
     onKeyUp: _propTypes.default.func,
-
     /**
      * onKeyDown handler (only supported on Web)
      */
     onMouseOver: _propTypes.default.func,
-
     /**
      * onKeyDown handler (only supported on Web)
      */
@@ -98,7 +80,6 @@ const textInputHandlerProps = {
 };
 exports.textInputHandlerProps = textInputHandlerProps;
 const selectTextInputHandlers = (0, _getPropSelector.default)(textInputHandlerProps.types);
-
 textInputHandlerProps.select = props => {
   // Support for onKeyPress/onKeyUp/onKeyDown is inconsistent between React Native and React Native Web
   const {
@@ -107,7 +88,6 @@ textInputHandlerProps.select = props => {
     onKeyDown,
     ...resolvedProps
   } = selectTextInputHandlers(props);
-
   if (onKeyPress || onKeyUp || onKeyDown) {
     if (_Platform.default.OS !== 'web') {
       // React Native only supports onKeyPress. Call any key handlers supplied in expected order.
@@ -118,9 +98,9 @@ textInputHandlerProps.select = props => {
       };
     } else {
       // React Native Web supports onKeyUp the normal way.
-      if (onKeyUp) resolvedProps.onKeyUp = onKeyUp; // React Native Web doesn't support the `onKeyDown` prop name, but maps a supplied onKeyPress handler
+      if (onKeyUp) resolvedProps.onKeyUp = onKeyUp;
+      // React Native Web doesn't support the `onKeyDown` prop name, but maps a supplied onKeyPress handler
       // to the onKeyDown event and calls it with a keydown event. Make React Native Web call either or both.
-
       if (onKeyPress || onKeyDown) {
         resolvedProps.onKeyPress = event => {
           if (typeof onKeyDown === 'function') onKeyDown(event);
@@ -129,6 +109,5 @@ textInputHandlerProps.select = props => {
       }
     }
   }
-
   return resolvedProps;
 };

package/lib/utils/props/hrefAttrsProp.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // Props related to HTML <a> anchor link attributes.
 const targetValues = ['_self', '_blank', '_parent', '_top'];
 var _default = {
@@ -19,7 +16,6 @@ var _default = {
     rel: _propTypes.default.string,
     target: _propTypes.default.oneOf(targetValues)
   },
-
   /**
    * Takes a props object, bundles any hrefAttrs props present into one object
    * and returns that keyed as `hrefAttrs` and non-hrefAttrs props keyed as `rest`

package/lib/utils/props/index.js

@@ -124,9 +124,7 @@ Object.defineProperty(exports, "viewProps", {
     return _viewProps.default;
   }
 });
-
 var _tokens = require("./tokens");
-
 Object.keys(_tokens).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -138,9 +136,7 @@ Object.keys(_tokens).forEach(function (key) {
     }
   });
 });
-
 var _handlerProps = require("./handlerProps");
-
 Object.keys(_handlerProps).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
@@ -152,39 +148,21 @@ Object.keys(_handlerProps).forEach(function (key) {
     }
   });
 });
-
 var _a11yProps = _interopRequireDefault(require("./a11yProps"));
-
 var _clickProps = _interopRequireDefault(require("./clickProps"));
-
 var _copyPropTypes = _interopRequireDefault(require("./copyPropTypes"));
-
 var _componentPropType = _interopRequireDefault(require("./componentPropType"));
-
 var _hrefAttrsProp = _interopRequireDefault(require("./hrefAttrsProp"));
-
 var _inputSupportsProps = _interopRequireDefault(require("./inputSupportsProps"));
-
 var _linkProps = _interopRequireDefault(require("./linkProps"));
-
 var _pressProps = _interopRequireDefault(require("./pressProps"));
-
 var _paddingProp = _interopRequireDefault(require("./paddingProp"));
-
 var _rectProp = _interopRequireDefault(require("./rectProp"));
-
 var _responsiveProps = _interopRequireDefault(require("./responsiveProps"));
-
 var _spacingProps = _interopRequireDefault(require("./spacingProps"));
-
 var _selectSystemProps = _interopRequireDefault(require("./selectSystemProps"));
-
 var _textInputProps = _interopRequireDefault(require("./textInputProps"));
-
 var _textProps = _interopRequireDefault(require("./textProps"));
-
 var _variantProp = _interopRequireDefault(require("./variantProp"));
-
 var _viewProps = _interopRequireDefault(require("./viewProps"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/lib/utils/props/inputSupportsProps.js

@@ -4,44 +4,35 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 var _default = {
   types: {
     /**
      * Whether the English or French copy will be used (e.g. for accessibility labels).
      */
     copy: _propTypes.default.oneOf(['en', 'fr']),
-
     /**
      * The input label.
      */
     label: _propTypes.default.string,
-
     /**
      * A short description of the expected input.
      */
     hint: _propTypes.default.string,
-
     /**
      * Position of the hint relative to label. Use `below` to display a larger hint below the label.
      */
     hintPosition: _propTypes.default.oneOf(['inline', 'below']),
-
     /**
      * A detailed description of validation error/success or additional instructions.
      * Visual variant is determined based on the `validation` prop.
      */
     feedback: _propTypes.default.string,
-
     /**
      * Content of an optional `Tooltip`. If set, a tooltip button will be shown next to the label.
      */
     tooltip: _propTypes.default.string,
-
     /**
      * Use to visually mark an input as valid or invalid.
      */

package/lib/utils/props/linkProps.js

@@ -4,24 +4,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _Linking = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Linking"));
-
 var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _pressProps = require("./pressProps");
-
 var _a11yProps = _interopRequireDefault(require("./a11yProps"));
-
 var _hrefAttrsProp = _interopRequireDefault(require("./hrefAttrsProp"));
-
 var _getPropSelector = _interopRequireDefault(require("./getPropSelector"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const linkPropTypes = { ..._pressProps.pressPropTypes,
+const linkPropTypes = {
+  ..._pressProps.pressPropTypes,
   href: _propTypes.default.string,
   hrefAttrs: _propTypes.default.shape(_hrefAttrsProp.default.types),
   ..._a11yProps.default.types
@@ -31,12 +23,10 @@ var _default = {
    * Proptypes for components that, on Web, can output <a href="..."> link elements
    */
   types: linkPropTypes,
-
   /**
    * Filters a props object, returning only the platform-relevant link props defined above
    */
   select: (0, _getPropSelector.default)(linkPropTypes),
-
   /**
    * Turn hrefs into press handlers that open links on Native.
    *

package/lib/utils/props/paddingProp.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 var _default = {
   propType: _propTypes.default.shape({
     paddingBottom: _propTypes.default.number,

package/lib/utils/props/pressProps.js

@@ -4,17 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.pressPropTypes = exports.default = void 0;
-
 var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _rectProp = _interopRequireDefault(require("./rectProp"));
-
 var _getPropSelector = _interopRequireDefault(require("./getPropSelector"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const pressHandlerPropTypes = {
   onPress: _propTypes.default.func,
   onPressIn: _propTypes.default.func,
@@ -31,7 +25,8 @@ const pressHandlerPropTypes = {
     }
   })
 };
-const pressPropTypes = { ...pressHandlerPropTypes,
+const pressPropTypes = {
+  ...pressHandlerPropTypes,
   disabled: _propTypes.default.bool,
   ..._Platform.default.select({
     web: {},
@@ -47,7 +42,6 @@ var _default = {
    * Proptypes for clickable or pressable components, including web-only props
    */
   types: pressPropTypes,
-
   /**
    * Filters a props object, returning only the platform-relevant press props defined above
    */

package/lib/utils/props/rectProp.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 var _default = {
   propType: _propTypes.default.shape({
     bottom: _propTypes.default.number,

package/lib/utils/props/responsiveProps.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const getByViewport = propType => ({
   xs: propType,
   sm: propType,
@@ -16,6 +13,7 @@ const getByViewport = propType => ({
   lg: propType,
   xl: propType
 });
+
 /**
  * Utilities for props that allow different values to be applied at different viewports.
  *
@@ -30,8 +28,6 @@ const getByViewport = propType => ({
  * @property {Function} getTypeOptionallyByViewport - returns a PropTypes validator that accepts
  *   either the provided proptype on its own, or the output of getTypeByViewport
  */
-
-
 var _default = {
   getByViewport,
   getTypeByViewport: propType => _propTypes.default.shape(getByViewport(propType)),

package/lib/utils/props/selectSystemProps.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = selectSystemProps;
-
 // Returns a selector for requested prop kinds as well as the propTypes for
 // those props merged into one object
 function selectSystemProps(systemPropHelpers) {
@@ -12,18 +11,17 @@ function selectSystemProps(systemPropHelpers) {
     if (typeof (propHelper === null || propHelper === void 0 ? void 0 : propHelper.select) !== 'function') {
       throw new Error(`An invalid system prop helper has been passed to 'selectSystemProps': prop selector ('.select') is missing in ${propHelper}`);
     }
-
-    return { ...acc,
+    return {
+      ...acc,
       ...propHelper.select(props)
     };
   }, {});
-
   const selectedPropTypes = systemPropHelpers.reduce((acc, propHelper) => {
     if (!(propHelper !== null && propHelper !== void 0 && propHelper.types)) {
       throw new Error(`An invalid system prop helper has been passed to 'selectSystemProps': types selector ('.types') is missing in ${propHelper}`);
     }
-
-    return { ...acc,
+    return {
+      ...acc,
       ...propHelper.types
     };
   }, {});

package/lib/utils/props/spacingProps.js

@@ -4,15 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _responsiveProps = _interopRequireDefault(require("./responsiveProps"));
-
 var _variantProp = _interopRequireDefault(require("./variantProp"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @typedef {0|1|2|3|4|5|6|7|8|9|10|11} SpacingIndex - value used to select a size on the spacing scale
  *
@@ -33,16 +28,16 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @typedef {SpacingIndex|SpacingObject} SpacingValue
  */
 const spacingScale = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11];
-
 const spacingIndexPropType = _propTypes.default.oneOf(spacingScale);
-
-const spacingObjectPropType = _propTypes.default.shape({ ..._responsiveProps.default.getByViewport(spacingIndexPropType),
+const spacingObjectPropType = _propTypes.default.shape({
+  ..._responsiveProps.default.getByViewport(spacingIndexPropType),
   space: spacingIndexPropType,
   options: _propTypes.default.shape({
     variant: _variantProp.default.propType,
     size: _propTypes.default.number
   })
 });
+
 /**
  * Components and utilities that assign fixed space between components use a theme-defined spacing scale.
  *
@@ -57,8 +52,6 @@ const spacingObjectPropType = _propTypes.default.shape({ ..._responsiveProps.def
  *   scale, or an object with an optional `options` key and one or more spacing indexes keyed either by
  *   viewports or `space` to apply at all viewports.
  */
-
-
 var _default = {
   scale: spacingScale,
   types: {

package/lib/utils/props/textInputProps.js

@@ -4,18 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _Platform = _interopRequireDefault(require("react-native-web/dist/cjs/exports/Platform"));
-
 var _getPropSelector = _interopRequireDefault(require("./getPropSelector"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 // This file contains common props for components that render a React Native TextInput
 // It excludes interaction handler functions which are in `./handlerProps.js`
-
 /**
  * TextInput (web and native) supports some common React Native props
  * shared with React Native's Text component.
@@ -25,10 +19,10 @@ const textProps = {
   nativeId: _propTypes.default.string,
   onLayout: _propTypes.default.func
 };
+
 /**
  * UDS text inputs accept props related to UDS's useInputValue hook
  */
-
 const inputValueProps = {
   value: _propTypes.default.string,
   type: _propTypes.default.string,
@@ -36,60 +30,52 @@ const inputValueProps = {
   readOnly: _propTypes.default.bool,
   inactive: _propTypes.default.bool
 };
+
 /**
  * This collection adds props that can be passed through to both React Native's
  * and React Native Web's implementations of the React Native TextInput component.
  */
-
-const crossPlatform = { ...textProps,
+const crossPlatform = {
+  ...textProps,
   ...inputValueProps,
-
   /**
    * Web and Android; 'off' disables device autocomplete, other strings are platform-specific.
    * Valid values on Native: https://reactnative.dev/docs/textinput#autocomplete-android
    * Valid values on Web: https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete
    */
   autoComplete: _propTypes.default.string,
-
   /**
    * On Native, default is `true`, passing `false` disables autoCorrect.
    * On web, only supported by Safari and expects "on" or "off" strings.
    */
   autoCorrect: _propTypes.default.oneOf([true, false, 'on', 'off']),
-
   /**
    * Focuses the element on mount. On Web, only the first form element with autoFocus is focussed.
    */
   autoFocus: _propTypes.default.bool,
-
   /**
    * Default is `true` for single line, `false` for multi-line
    */
   blurOnSubmit: _propTypes.default.bool,
-
   /**
    * iOS and Web only, no effect on Android
    */
   clearTextOnFocus: _propTypes.default.bool,
-
   /**
    * Default is `true`. On web, this works by mapping to input's `readonly` attribute
    */
   editable: _propTypes.default.bool,
-
   /**
    * See documentation for allowed values (varies between Web, Android and iOS) and important notes:
    * - Native: https://reactnative.dev/docs/textinput#keyboardtype
    * - Web: equivalent to `inputmode` but see https://necolas.github.io/react-native-web/docs/text-input/
    */
   keyboardType: _propTypes.default.string,
-
   /**
    * Uses native tools (no flicker) to cap the maximum number of characters.
    * On Web, works via `maxlength` attr.
    */
   maxLength: _propTypes.default.number,
-
   /**
    * If passed as true, the text input can be multiple lines.
    *
@@ -97,24 +83,20 @@ const crossPlatform = { ...textProps,
    * > Use with textAlignVertical set to top for the same behavior in both platforms.
    */
   multiline: _propTypes.default.bool,
-
   /**
    * Web and Android only, requires `multiline` to be `true`.
    */
   numberOfLines: _propTypes.default.number,
-
   /**
    * Text to display when no value set.
    * Accesibility guidelines recommend using labels to describe the input and using
    * placeholders rarely and sparingly to prompt a particular format.
    */
   placeholder: _propTypes.default.string,
-
   /**
    * Sets placeholder colour. On Web, uses `::placeholder { color: ... }` selector.
    */
   placeholderTextColor: _propTypes.default.string,
-
   /**
    * One of a subset of platform-specific options that controls labelling and presentation
    * in on-screen keyboards and accessibility tools. Uses `enterkeyhint` attr on Web.
@@ -122,34 +104,30 @@ const crossPlatform = { ...textProps,
    * 'done', 'go', 'next', 'search', and 'send' are available for Web, Android and iOS.
    */
   returnKeyType: _propTypes.default.string,
-
   /**
    * Obscures passwords and similar. Equivalent to type="password" on Web.
    * Does not work if multiline is true.
    */
   secureTextEntry: _propTypes.default.bool,
-
   /**
    * If true, all text will automatically be selected on focus.
    */
   selectTextOnFocus: _propTypes.default.bool,
-
   /**
    * Web and iOS. On iOS, default inherits from `autoCorrect`.
    * On Web, equivalent to `spellcheck` attr.
    */
   spellCheck: _propTypes.default.bool
 };
+
 /**
  * These web-only props all control HTML `input` attributes of the same name.
  * Refer to general HTML documentation for more details.
  */
-
 const webOnly = {
   disabled: _propTypes.default.bool,
   dir: _propTypes.default.oneOf(['auto', 'ltr', 'rtl']),
   lang: _propTypes.default.string,
-
   /**
    * Sets the HTML input `pattern` attr. Not supported by React Native Web, but is supported by UDS.
    * Must also pass in a ref and check validity by calling the HTML element's checkValidity method:
@@ -157,6 +135,7 @@ const webOnly = {
    */
   pattern: _propTypes.default.string
 };
+
 /**
  * These props are supported in React Native but not React Native Web.
  *
@@ -168,7 +147,6 @@ const webOnly = {
  * native component based on the values of multiple boolean flags, and may sometimes appear to pick an
  * option that is inappropriate for one flag based on the values of one or more other other flags.
  */
-
 const nativeOnly = {
   caretHidden: _propTypes.default.bool,
   clearButtonMode: _propTypes.default.string,
@@ -196,16 +174,17 @@ var _default = {
    * Subset of proptypes that can be passed down to a React Native or React Native Web
    * `TextInput` component. Allow regardless of platform, so cross-platform apps don't warn.
    */
-  types: { ...crossPlatform,
+  types: {
+    ...crossPlatform,
     ...webOnly,
     ...nativeOnly
   },
-
   /**
    * Filters a props object. Return only platform-appropriate TextInput props, native inputs
    * may throw errors on receiving unknown props.
    */
-  select: (0, _getPropSelector.default)({ ...crossPlatform,
+  select: (0, _getPropSelector.default)({
+    ...crossPlatform,
     ..._Platform.default.select({
       web: webOnly,
       default: nativeOnly