@telus-uds/components-web 1.7.0 → 1.9.0

package/lib-module/Autocomplete/Autocomplete.js

@@ -0,0 +1,369 @@
+/* eslint-disable react/require-default-props */
+import React, { forwardRef, useRef, useState } from 'react';
+import PropTypes from 'prop-types';
+import { throttle } from 'lodash';
+import { InputSupports, inputSupportsProps, selectSystemProps, TextInput, textInputProps, textInputHandlerProps, Typography, useCopy, useSafeLayoutEffect } from '@telus-uds/components-base';
+import Listbox from '../Listbox';
+import { htmlAttrs, useOverlaidPosition } from '../utils';
+import Loading from './Loading';
+import Suggestions from './Suggestions';
+import { DEFAULT_MAX_SUGGESTIONS, DEFAULT_MIN_TO_SUGGESTION, INPUT_LEFT_PADDING, MIN_LISTBOX_WIDTH } from './constants';
+import dictionary from './dictionary';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Fragment as _Fragment } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([htmlAttrs, inputSupportsProps, textInputHandlerProps, textInputProps]);
+const inputTokens = {
+  paddingLeft: INPUT_LEFT_PADDING
+}; // Returns JSX to display a bold string `str` with unbolded occurrences of the
+// `substring` based in the array of `matchIndexes` provided
+
+const highlightAllMatches = function (str) {
+  let substring = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+  let matchIndexes = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
+  return (
+    /*#__PURE__*/
+    // Wrapping all in bold
+    _jsx(Typography, {
+      variant: {
+        bold: false
+      },
+      children: matchIndexes.reduce((acc, matchIndex, index) => [...acc, // Add a piece of the string up to the first occurrence of the substring
+      index === 0 && (str.slice(0, matchIndex) ?? ''),
+      /*#__PURE__*/
+      // Unbold the occurrence of the substring (while keeping the original casing)
+      _jsx(Typography, {
+        variant: {
+          bold: true
+        },
+        children: str.slice(matchIndex, matchIndex + substring.length)
+      }, matchIndex), // Add the rest of the string until the next occurrence or the end of it
+      str.slice(matchIndex + substring.length, matchIndexes[index + 1] ?? str.length)], [])
+    })
+  );
+};
+
+const highlight = function () {
+  let items = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  let text = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+  return items.reduce((acc, item) => {
+    var _Array$from;
+
+    const matches = (_Array$from = Array.from(item.label.toLowerCase().matchAll(text.toLowerCase()))) === null || _Array$from === void 0 ? void 0 : _Array$from.map(_ref => {
+      let {
+        index
+      } = _ref;
+      return index;
+    });
+
+    if (matches !== null && matches !== void 0 && matches.length) {
+      return [...acc, { ...item,
+        label: highlightAllMatches(item.label, text, matches)
+      }];
+    }
+
+    return [...acc, item];
+  }, []);
+};
+
+const Autocomplete = /*#__PURE__*/forwardRef((_ref2, ref) => {
+  var _ref3;
+
+  let {
+    children,
+    copy = 'en',
+    fullWidth = true,
+    initialItems,
+    initialValue,
+    isLoading = false,
+    items,
+    maxSuggestions = DEFAULT_MAX_SUGGESTIONS,
+    minToSuggestion = DEFAULT_MIN_TO_SUGGESTION,
+    noResults,
+    onChange,
+    onClear,
+    onSelect,
+    readOnly,
+    validation,
+    value,
+    ...rest
+  } = _ref2;
+  // The wrapped input is mostly responsible for controlled vs uncontrolled handling,
+  // but we also need to adjust suggestions based on the mode:
+  // - in controlled mode we rely entirely on the suggestions passed via the `items` prop,
+  // - in uncontrolled mode we filter the suggestions ourselves based on the `initialItems`
+  //   prop and the text entered
+  const isControlled = value !== undefined; // We need to store current items for uncontrolled usage
+
+  const [currentItems, setCurrentItems] = useState(initialItems); // We need to store the current value as well to be able to highlight it
+
+  const [currentValue, setCurrentValue] = useState(value ?? initialValue); // Setting up the overlay
+
+  const openOverlayRef = useRef();
+  const [isExpanded, setIsExpanded] = useState(((_ref3 = value ?? initialValue) === null || _ref3 === void 0 ? void 0 : _ref3.length) >= minToSuggestion);
+  const {
+    overlaidPosition,
+    sourceRef: inputRef,
+    targetRef,
+    onTargetLayout,
+    isReady
+  } = useOverlaidPosition({
+    isShown: isExpanded,
+    offsets: {
+      vertical: 4
+    }
+  }); // We limit the number of suggestions displayed to avoid huge lists
+  // TODO: add a way to make the `Listbox` occupy fixed height and be scrollable
+  // within that height, which will unlock similar behaviour for `AutoComplete` as well
+
+  const itemsToSuggest = function () {
+    let data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+    return maxSuggestions ? data.slice(0, maxSuggestions) : [...data];
+  };
+
+  const getCopy = useCopy({
+    dictionary,
+    copy
+  }); // Tracking input width changes to resize the listbox overlay accordingly
+
+  const [inputWidth, setInputWidth] = useState();
+  useSafeLayoutEffect(() => {
+    const updateInputWidth = () => {
+      var _inputRef$current;
+
+      setInputWidth((inputRef === null || inputRef === void 0 ? void 0 : (_inputRef$current = inputRef.current) === null || _inputRef$current === void 0 ? void 0 : _inputRef$current.clientWidth) + 4); // adding back all the input borders / outlines
+
+      setIsExpanded(false); // close the suggestions while the input is changing
+    };
+
+    const throttledUpdateInputWidth = throttle(updateInputWidth, 100, {
+      leading: false
+    });
+    updateInputWidth();
+    window.addEventListener('load', updateInputWidth);
+    window.addEventListener('resize', throttledUpdateInputWidth);
+    return () => {
+      window.removeEventListener('load', updateInputWidth);
+      window.removeEventListener('resize', throttledUpdateInputWidth);
+    };
+  }, [inputRef]);
+
+  const handleChange = newValue => {
+    onChange === null || onChange === void 0 ? void 0 : onChange(newValue);
+    setCurrentValue(newValue);
+    setIsExpanded((newValue === null || newValue === void 0 ? void 0 : newValue.length) >= minToSuggestion);
+
+    if (!isControlled && initialItems !== undefined) {
+      setCurrentItems(initialItems.filter(_ref4 => {
+        var _label$toLowerCase;
+
+        let {
+          label
+        } = _ref4;
+        return label === null || label === void 0 ? void 0 : (_label$toLowerCase = label.toLowerCase()) === null || _label$toLowerCase === void 0 ? void 0 : _label$toLowerCase.includes(newValue === null || newValue === void 0 ? void 0 : newValue.toLowerCase());
+      }));
+    }
+  };
+
+  const handleSelect = selectedId => {
+    var _ref5;
+
+    onSelect === null || onSelect === void 0 ? void 0 : onSelect(selectedId);
+    const {
+      label: newValue
+    } = (_ref5 = isControlled ? items : currentItems) === null || _ref5 === void 0 ? void 0 : _ref5.find(_ref6 => {
+      let {
+        id
+      } = _ref6;
+      return id === selectedId;
+    });
+    onChange === null || onChange === void 0 ? void 0 : onChange(newValue);
+    setCurrentValue(newValue);
+    if (!isControlled && inputRef !== null && inputRef !== void 0 && inputRef.current) inputRef.current.value = newValue;
+    setIsExpanded(false);
+  };
+
+  const handleClose = event => {
+    var _openOverlayRef$curre, _openOverlayRef$curre2;
+
+    if (event.type === 'keydown') {
+      if (event.key === 'Escape' || event.key === 27) {
+        setIsExpanded(false);
+      } else if (event.key === 'ArrowDown' && isExpanded && !isLoading && targetRef !== null && targetRef !== void 0 && targetRef.current) {
+        targetRef.current.focus();
+      }
+    } else if (event.type === 'click' && openOverlayRef !== null && openOverlayRef !== void 0 && openOverlayRef.current && event.target && !(openOverlayRef !== null && openOverlayRef !== void 0 && (_openOverlayRef$curre = openOverlayRef.current) !== null && _openOverlayRef$curre !== void 0 && _openOverlayRef$curre.contains(event.target))) {
+      setIsExpanded(false);
+    } else if (event.type === 'touchstart' && openOverlayRef !== null && openOverlayRef !== void 0 && openOverlayRef.current && event.touches[0].target && !(openOverlayRef !== null && openOverlayRef !== void 0 && (_openOverlayRef$curre2 = openOverlayRef.current) !== null && _openOverlayRef$curre2 !== void 0 && _openOverlayRef$curre2.contains(event.touches[0].target))) {
+      setIsExpanded(false);
+    }
+  };
+
+  const {
+    supportsProps,
+    ...selectedProps
+  } = selectProps(rest);
+  return /*#__PURE__*/_jsxs(_Fragment, {
+    children: [/*#__PURE__*/_jsx(InputSupports, { ...supportsProps,
+      accessibilityAutoComplete: "list",
+      accessibilityControls: "autocomplete",
+      accessibilityExpanded: isExpanded,
+      accessibilityRole: "combobox",
+      ...selectedProps,
+      validation: validation,
+      ref: ref,
+      children: _ref7 => {
+        let {
+          inputId,
+          ...props
+        } = _ref7;
+        if (typeof children === 'function') return children({
+          inputId,
+          inputRef,
+          onChange: handleChange,
+          onKeyPress: handleClose,
+          readOnly,
+          tokens: inputTokens,
+          ...selectedProps,
+          ...props,
+          ...(isControlled ? {
+            value
+          } : {
+            initialValue
+          })
+        });
+        return /*#__PURE__*/_jsx(TextInput, {
+          onChange: handleChange,
+          onClear: onClear,
+          onKeyPress: handleClose,
+          readOnly: readOnly,
+          ref: inputRef,
+          tokens: inputTokens,
+          ...selectedProps,
+          ...props,
+          ...(isControlled ? {
+            value
+          } : {
+            initialValue
+          })
+        });
+      }
+    }), isExpanded && /*#__PURE__*/_jsxs(_Fragment, {
+      children: [/*#__PURE__*/_jsx(Listbox.Overlay, {
+        overlaidPosition: overlaidPosition,
+        isReady: isReady,
+        minWidth: fullWidth ? inputWidth : MIN_LISTBOX_WIDTH,
+        maxWidth: inputWidth,
+        onLayout: onTargetLayout,
+        ref: openOverlayRef,
+        children: isLoading ? /*#__PURE__*/_jsx(Loading, {
+          label: getCopy('loading')
+        }) : /*#__PURE__*/_jsx(Suggestions, {
+          hasResults: getCopy('hasResults'),
+          id: "autocomplete",
+          items: itemsToSuggest(highlight(isControlled ? items : currentItems, currentValue)),
+          noResults: noResults ?? getCopy('noResults'),
+          onClose: handleClose,
+          onSelect: handleSelect,
+          parentRef: inputRef,
+          ref: targetRef
+        })
+      }), (targetRef === null || targetRef === void 0 ? void 0 : targetRef.current) && /*#__PURE__*/_jsx("div", {
+        // This catches and shifts focus to other interactive elements.
+        onFocus: () => {
+          var _targetRef$current;
+
+          return targetRef === null || targetRef === void 0 ? void 0 : (_targetRef$current = targetRef.current) === null || _targetRef$current === void 0 ? void 0 : _targetRef$current.focus();
+        } // eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex
+        ,
+        tabIndex: 0
+      })]
+    })]
+  });
+});
+Autocomplete.displayName = 'Autocomplete'; // If a language dictionary entry is provided, it must contain every key
+
+const dictionaryContentShape = PropTypes.shape({
+  hasResults: PropTypes.string.isRequired,
+  loading: PropTypes.string.isRequired,
+  noResults: PropTypes.string.isRequired
+});
+Autocomplete.propTypes = { ...selectedSystemPropTypes,
+
+  /**
+   * Can be used to provide a function that renders a custom input:
+   * <Autocomplete items={items} value={currentValue}>
+   *   {({ inputId, inputRef, onChange, onKeyPress, readOnly, tokens, value }) => (
+   *     <Search
+   *       nativeID={inputId}
+   *       ref={inputRef}
+   *       onChange={onChange}
+   *       onKeyPress={onKeyPress}
+   *       readOnly={readOnly}
+   *       tokens={tokens}
+   *       value={value}
+   *     />
+   *   )}
+   * </Autocomplete>
+   */
+  children: PropTypes.func,
+
+  /**
+   * Copy language identifier
+   */
+  copy: PropTypes.oneOfType([PropTypes.oneOf(['en', 'fr']), dictionaryContentShape]),
+
+  /**
+   * Set to true in order to display the loading indicator instead of results
+   */
+  isLoading: PropTypes.bool,
+
+  /**
+   * List of items to display as suggestions
+   */
+  items: PropTypes.arrayOf(PropTypes.shape({
+    id: PropTypes.string,
+    label: PropTypes.string
+  })),
+
+  /**
+   * Label to display alongside the spinner when in a loading state
+   */
+  loadingLabel: PropTypes.string,
+
+  /**
+   * Minimum number of characters typed for a list of suggestions to appear
+   */
+  minToSuggestion: PropTypes.number,
+
+  /**
+   * Maximum number of suggestions provided at the same time
+   */
+  maxSuggestions: PropTypes.number,
+
+  /**
+   * Text or JSX to render when no results are available
+   */
+  noResults: PropTypes.node,
+
+  /**
+   * Handler function to be called when the input value changes
+   */
+  onChange: PropTypes.func,
+
+  /**
+   * Handler function to be called when the clear button (appears if the handler is passed) is pressed
+   */
+  onClear: PropTypes.func,
+
+  /**
+   * Callback function to be called when an item is selected from the list
+   */
+  onSelect: PropTypes.func,
+
+  /**
+   * Input value for controlled usage
+   */
+  value: PropTypes.string
+};
+export default Autocomplete;

package/lib-module/Autocomplete/Loading.js

@@ -0,0 +1,38 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Box, StackView, Typography } from '@telus-uds/components-base';
+import Spinner from '../Spinner';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+
+const Loading = _ref => {
+  let {
+    label
+  } = _ref;
+  return /*#__PURE__*/_jsx(Box, {
+    space: 3,
+    children: /*#__PURE__*/_jsxs(StackView, {
+      direction: "row",
+      space: 2,
+      tokens: {
+        alignItems: 'center'
+      },
+      children: [/*#__PURE__*/_jsx(Spinner, {
+        inline: true,
+        show: true,
+        size: "small"
+      }), /*#__PURE__*/_jsx(Typography, {
+        variant: {
+          size: 'small'
+        },
+        accessibilityLiveRegion: "polite",
+        children: label
+      })]
+    })
+  });
+};
+
+Loading.propTypes = {
+  label: PropTypes.string
+};
+export default Loading;

package/lib-module/Autocomplete/Suggestions.js

@@ -0,0 +1,64 @@
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+import { A11yText, Box, Typography } from '@telus-uds/components-base';
+import Listbox from '../Listbox';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Fragment as _Fragment } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const Suggestions = /*#__PURE__*/forwardRef((_ref, ref) => {
+  let {
+    hasResults,
+    items = [],
+    noResults,
+    onClose,
+    onSelect,
+    parentRef
+  } = _ref;
+  const pressableItems = items.map(_ref2 => {
+    let {
+      id,
+      ...rest
+    } = _ref2;
+    return {
+      id,
+      onPress: () => onSelect(id),
+      ...rest
+    };
+  });
+  if (items !== null && items !== void 0 && items.length) return /*#__PURE__*/_jsxs(_Fragment, {
+    children: [/*#__PURE__*/_jsx(A11yText, {
+      accessibilityLiveRegion: "polite",
+      text: hasResults
+    }), /*#__PURE__*/_jsx(Listbox, {
+      items: pressableItems,
+      firstItemRef: ref,
+      parentRef: parentRef,
+      onClose: onClose
+    })]
+  });
+  return /*#__PURE__*/_jsx(Box, {
+    space: 3,
+    children: typeof noResults === 'string' ? /*#__PURE__*/_jsx(_Fragment, {
+      children: /*#__PURE__*/_jsx(Typography, {
+        accessibilityLiveRegion: "polite",
+        variant: {
+          size: 'small'
+        },
+        children: noResults
+      })
+    }) : noResults
+  });
+});
+Suggestions.displayName = 'Suggestions';
+Suggestions.propTypes = {
+  hasResults: PropTypes.string.isRequired,
+  items: PropTypes.arrayOf(PropTypes.shape({
+    id: PropTypes.string,
+    label: PropTypes.node
+  })).isRequired,
+  noResults: PropTypes.node.isRequired,
+  onClose: PropTypes.func.isRequired,
+  onSelect: PropTypes.func.isRequired,
+  parentRef: PropTypes.object.isRequired
+};
+export default Suggestions;

package/lib-module/Autocomplete/constants.js

@@ -0,0 +1,5 @@
+import palette from '@telus-uds/palette-allium/build/web/palette';
+export const DEFAULT_MIN_TO_SUGGESTION = 1;
+export const DEFAULT_MAX_SUGGESTIONS = 5;
+export const INPUT_LEFT_PADDING = palette.size.size16;
+export const MIN_LISTBOX_WIDTH = palette.size.size288;

package/lib-module/Autocomplete/dictionary.js

@@ -0,0 +1,12 @@
+export default {
+  en: {
+    hasResults: 'Some results are available',
+    loading: 'Loading suggestions...',
+    noResults: 'No results found'
+  },
+  fr: {
+    hasResults: 'Quelques suggestions sont disponible',
+    loading: 'Chargement en cours...',
+    noResults: 'Aucun résultat trouvé'
+  }
+};

package/lib-module/Autocomplete/index.js

@@ -0,0 +1,2 @@
+import Autocomplete from './Autocomplete';
+export default Autocomplete;

package/lib-module/BlockQuote/BlockQuote.js

@@ -0,0 +1,156 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Link, selectSystemProps, StackView, Typography, useThemeTokens, withLinkRouter } from '@telus-uds/components-base';
+import styled from 'styled-components';
+import { htmlAttrs, transformGradient } from '../utils';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([htmlAttrs]);
+const BlockQuoteContainer = /*#__PURE__*/styled.blockquote.withConfig({
+  displayName: "BlockQuote__BlockQuoteContainer",
+  componentId: "components-web__sc-vals3u-0"
+})(["margin:0;position:relative;padding-left:", ";padding-right:", ";padding-bottom:", ";padding-top:", ";&::before{content:'';left:0;top:0;position:absolute;height:100%;width:", ";background:", ";}"], _ref => {
+  let {
+    paddingLeft
+  } = _ref;
+  return `${paddingLeft}px`;
+}, _ref2 => {
+  let {
+    paddingRight
+  } = _ref2;
+  return `${paddingRight}px`;
+}, _ref3 => {
+  let {
+    paddingBottom
+  } = _ref3;
+  return `${paddingBottom}px`;
+}, _ref4 => {
+  let {
+    paddingTop
+  } = _ref4;
+  return `${paddingTop}px`;
+}, _ref5 => {
+  let {
+    width
+  } = _ref5;
+  return `${width}px`;
+}, _ref6 => {
+  let {
+    backgroundGradient
+  } = _ref6;
+  return backgroundGradient && transformGradient(backgroundGradient);
+});
+const QuoteContainer = /*#__PURE__*/styled.div.withConfig({
+  displayName: "BlockQuote__QuoteContainer",
+  componentId: "components-web__sc-vals3u-1"
+})(["margin-bottom:", ";"], _ref7 => {
+  let {
+    marginBottom
+  } = _ref7;
+  return `${marginBottom}px`;
+});
+
+const BlockQuote = _ref8 => {
+  let {
+    children,
+    link,
+    additionalInfo,
+    linkHref,
+    textStyle = 'large',
+    LinkRouter,
+    linkRouterProps,
+    tokens,
+    variant,
+    ...rest
+  } = _ref8;
+  const {
+    color,
+    paddingTop,
+    paddingBottom,
+    paddingLeft,
+    paddingRight,
+    marginBottom,
+    width,
+    backgroundGradient
+  } = useThemeTokens('BlockQuote', tokens, variant);
+  const mappedTextSize = textStyle === 'heading' ? 'h3' : textStyle;
+
+  const renderLink = () => {
+    if (linkHref) {
+      return /*#__PURE__*/_jsx(Link, {
+        href: linkHref,
+        tokens: {
+          blockFontWeight: '500',
+          color
+        },
+        variant: {
+          alternative: true
+        },
+        LinkRouter: LinkRouter,
+        linkRouterProps: linkRouterProps,
+        children: link
+      });
+    }
+
+    return /*#__PURE__*/_jsx(Typography, {
+      tokens: {
+        color,
+        fontWeight: '500'
+      },
+      children: link
+    });
+  };
+
+  const renderQuote = () => {
+    const quote = /*#__PURE__*/_jsx(Typography, {
+      tokens: {
+        color,
+        fontWeight: '400'
+      },
+      variant: {
+        size: mappedTextSize
+      },
+      children: children
+    });
+
+    if (additionalInfo || link) {
+      return /*#__PURE__*/_jsx(QuoteContainer, {
+        marginBottom: marginBottom,
+        children: quote
+      });
+    }
+
+    return quote;
+  };
+
+  return /*#__PURE__*/_jsxs(BlockQuoteContainer, { ...selectProps(rest),
+    paddingTop: paddingTop,
+    paddingBottom: paddingBottom,
+    paddingLeft: paddingLeft,
+    paddingRight: paddingRight,
+    width: width,
+    backgroundGradient: backgroundGradient,
+    children: [renderQuote(), (additionalInfo || link) && /*#__PURE__*/_jsxs(StackView, {
+      space: 0,
+      children: [link && renderLink(), additionalInfo && /*#__PURE__*/_jsx(Typography, {
+        tokens: {
+          color
+        },
+        variant: {
+          size: 'small'
+        },
+        children: additionalInfo
+      })]
+    })]
+  });
+};
+
+BlockQuote.propTypes = { ...selectedSystemPropTypes,
+  ...withLinkRouter.propTypes,
+  children: PropTypes.node.isRequired,
+  link: PropTypes.string,
+  linkHref: PropTypes.string,
+  additionalInfo: PropTypes.string,
+  textStyle: PropTypes.oneOf(['large', 'heading'])
+};
+export default BlockQuote;

package/lib-module/BlockQuote/index.js

@@ -0,0 +1,2 @@
+import BlockQuote from './BlockQuote';
+export default BlockQuote;

package/lib-module/Callout/Callout.js

@@ -80,6 +80,9 @@ const Callout = _ref2 => {
     padding: `${paddingTop}px ${paddingRight}px ${paddingBottom}px ${paddingLeft}px`,
     ...selectProps(rest),
     children: [icon && /*#__PURE__*/_jsx(Icon, {
+      tokens: {
+        color
+      },
       icon: icon,
       variant: {
         rank: 'primary',