@telus-uds/components-base 2.4.0 → 3.0.0

package/lib/esm/Autocomplete/Autocomplete.js

@@ -0,0 +1,473 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import Dimensions from "react-native-web/dist/exports/Dimensions";
+import Platform from "react-native-web/dist/exports/Platform";
+import View from "react-native-web/dist/exports/View";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import throttle from 'lodash.throttle';
+import matchAll from 'string.prototype.matchall';
+import { inputSupportsProps, selectSystemProps, textInputProps, textInputHandlerProps, useCopy, htmlAttrs, useOverlaidPosition, useSafeLayoutEffect, getTokensPropType } from '../utils';
+import { useThemeTokens } from '../ThemeProvider';
+import Listbox from '../Listbox';
+import Typography from '../Typography';
+import { TextInput } from '../TextInput';
+import InputSupports from '../InputSupports';
+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, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+const staticStyles = StyleSheet.create({
+  container: {
+    zIndex: 100,
+    flexDirection: 'column',
+    justifyContent: 'flex-start',
+    flexGrow: 0,
+    flexShrink: 0
+  }
+});
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([htmlAttrs, inputSupportsProps, textInputHandlerProps, textInputProps]);
+
+// 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] : [];
+  let resultsTextColor = arguments.length > 3 ? arguments[3] : undefined;
+  return (
+    /*#__PURE__*/
+    // Wrapping all in bold
+    _jsx(Typography, {
+      variant: {
+        bold: false
+      },
+      tokens: {
+        color: resultsTextColor
+      },
+      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
+        },
+        tokens: {
+          color: resultsTextColor
+        },
+        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] : '';
+  let color = arguments.length > 2 ? arguments[2] : undefined;
+  return items.reduce((acc, item) => {
+    const matches = Array.from(matchAll(item.label.toLowerCase(), text.toLowerCase().replace(/[/\-\\^$*+?.()|[\]{}]/g, '\\$&')))?.map(_ref => {
+      let {
+        index
+      } = _ref;
+      return index;
+    });
+    if (matches?.length) {
+      return [...acc, {
+        ...item,
+        label: highlightAllMatches(item.label, text, matches, color)
+      }];
+    }
+    return [...acc, item];
+  }, []);
+};
+const Autocomplete = /*#__PURE__*/React.forwardRef((_ref2, ref) => {
+  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,
+    helpText = '',
+    loadingLabel,
+    tokens,
+    ...rest
+  } = _ref2;
+  const {
+    color: resultsTextColor,
+    ...restOfTokens
+  } = useThemeTokens('Autocomplete', tokens, {
+    focus: true
+  });
+
+  // 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] = React.useState(initialItems);
+  const [otherItems, setOtherItems] = React.useState(items);
+
+  // We need to store the current value as well to be able to highlight it
+  const [currentValue, setCurrentValue] = React.useState(value ?? initialValue);
+  const inputTokens = {
+    paddingLeft: INPUT_LEFT_PADDING
+  };
+
+  // Setting up the overlay
+  const openOverlayRef = React.useRef();
+  const [isExpanded, setIsExpanded] = React.useState((value ?? initialValue)?.length >= minToSuggestion);
+  const [isFocused, setisFocused] = React.useState(false);
+  const [sourceLayout, setSourceLayout] = React.useState(null);
+
+  // When it's nested, selected value
+  const [nestedSelectedValue, setNestedSelectedValue] = React.useState(null);
+  const [isInputVisible, setIsInputVisible] = React.useState(true);
+  const {
+    supportsProps,
+    ...selectedProps
+  } = selectProps(rest);
+  const {
+    hint,
+    label: inputLabel
+  } = supportsProps;
+  const hintExpansionEnabled = isFocused && helpText && !currentValue;
+  const {
+    overlaidPosition,
+    sourceRef: inputRef,
+    // targetRef,
+    onTargetLayout,
+    isReady
+  } = useOverlaidPosition({
+    isShown: isExpanded || hintExpansionEnabled,
+    offsets: {
+      vertical: Platform.OS !== 'web' && (hint || inputLabel) ? 28 : 4
+    }
+  });
+  const targetRef = React.useRef(null);
+  // 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] = React.useState();
+  useSafeLayoutEffect(() => {
+    if (Platform.OS === 'web') {
+      const updateInputWidth = () => {
+        setInputWidth(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
+      });
+      throttledUpdateInputWidth();
+      Dimensions.addEventListener('change', throttledUpdateInputWidth);
+      return () => {
+        Dimensions.removeEventListener('change', throttledUpdateInputWidth);
+      };
+    }
+    setInputWidth(sourceLayout?.width);
+    return () => {};
+  }, [inputRef, sourceLayout]);
+  const handleMeasure = event => {
+    onTargetLayout(event);
+    if (Platform.OS !== 'web') {
+      inputRef?.current?.measureInWindow((x, y, width) => {
+        setInputWidth(width);
+      });
+    }
+  };
+  const handleChange = newValue => {
+    onChange?.(newValue || '');
+    setCurrentValue(newValue);
+    setIsExpanded(newValue?.length >= minToSuggestion);
+    if (!isControlled && initialItems !== undefined) {
+      setCurrentItems(initialItems.filter(_ref3 => {
+        let {
+          label
+        } = _ref3;
+        return label?.toLowerCase()?.includes(newValue?.toLowerCase());
+      }));
+    }
+  };
+  const handleSelect = selectedId => {
+    onSelect?.(selectedId);
+    const {
+      label: newValue,
+      nested,
+      title
+    } = (isControlled ? items : currentItems)?.find(_ref4 => {
+      let {
+        id
+      } = _ref4;
+      return id === selectedId;
+    });
+    if (title) return;
+    if (!nested) {
+      setNestedSelectedValue(null);
+      onChange?.(newValue);
+      setIsExpanded(false);
+    }
+    setCurrentValue(newValue);
+    if (!isControlled && inputRef?.current) inputRef.current.value = newValue;
+    if (nested) setNestedSelectedValue(newValue);
+    inputRef.current.focus();
+  };
+
+  /**
+   * When an item that is nested equal "true" is selected this useEffect is executed.
+   * The nested item is added to the item list at the top, the if validates it doesn't exist
+   * within the list, if doesn't exist the nested item is added to the top of the list,
+   * the nested item is added with an id equal "0"
+   */
+  React.useEffect(() => {
+    if (nestedSelectedValue && !items.find(item => item.id === 0)) {
+      const tmpItems = [...items];
+      tmpItems.unshift({
+        label: nestedSelectedValue,
+        title: true,
+        id: 0
+      });
+      setOtherItems(tmpItems.map(item => {
+        return {
+          ...item,
+          nestedChild: item.id !== 0
+        };
+      }));
+    }
+  }, [nestedSelectedValue, items]);
+  React.useEffect(() => {
+    if (Platform.OS === 'ios' || Platform.OS === 'android') {
+      return undefined;
+    }
+    const observer = new IntersectionObserver(entries => {
+      const [entry] = entries;
+      setIsInputVisible(entry.isIntersecting);
+      if (!entry.isIntersecting) {
+        setIsExpanded(false);
+      }
+    });
+    const currentInputRef = inputRef.current;
+    if (currentInputRef) {
+      observer.observe(currentInputRef);
+    }
+    return () => {
+      if (currentInputRef) {
+        observer.unobserve(currentInputRef);
+      }
+    };
+  }, [inputRef]);
+  const handleClose = event => {
+    if (event.type === 'keydown' && (event.key === 'Escape' || event.key === '27') || event.type === 'click' && !openOverlayRef?.current?.contains(event.target) || event.type === 'touchstart' && openOverlayRef?.current && event.touches[0].target && !openOverlayRef?.current?.contains(event.touches[0].target)) {
+      setIsExpanded(false);
+      setNestedSelectedValue(null);
+    } else if (event.type === 'keydown' && (event.key === 'ArrowDown' || event.key === 'Tab') && isExpanded && !isLoading && targetRef?.current) {
+      event.preventDefault();
+      targetRef.current.focus();
+    }
+  };
+  const itemsToShow = currentValue ? itemsToSuggest(highlight(isControlled ? items : currentItems, currentValue, resultsTextColor)) : [];
+  const helpTextToShow = isFocused && !currentValue ? helpText : noResults ?? getCopy('noResults');
+  return /*#__PURE__*/_jsxs(View, {
+    style: staticStyles.container,
+    children: [/*#__PURE__*/_jsx(InputSupports, {
+      ...supportsProps,
+      accessibilityAutoComplete: "list",
+      accessibilityControls: "autocomplete",
+      accessibilityExpanded: isExpanded,
+      accessibilityRole: "combobox",
+      ...selectedProps,
+      validation: validation,
+      ref: ref,
+      children: _ref5 => {
+        let {
+          inputId,
+          ...props
+        } = _ref5;
+        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,
+          onFocus: () => {
+            setisFocused(true);
+          },
+          onBlur: () => {
+            setisFocused(false);
+          },
+          onClear: onClear,
+          onKeyPress: handleClose,
+          readOnly: readOnly,
+          ref: inputRef,
+          ...(Platform.OS !== 'web' ? {
+            onLayout: event => {
+              setSourceLayout(event.nativeEvent.layout);
+              const {
+                y,
+                height
+              } = event.nativeEvent.layout;
+              if (y >= 0 && height > 0) {
+                setIsInputVisible(true);
+              } else {
+                setIsInputVisible(false);
+                setIsExpanded(false);
+              }
+            }
+          } : {}),
+          tokens: inputTokens,
+          validation: validation,
+          ...selectedProps,
+          ...props,
+          ...(isControlled ? {
+            value
+          } : {
+            initialValue
+          })
+        });
+      }
+    }), (isExpanded || hintExpansionEnabled) && isInputVisible && /*#__PURE__*/_jsxs(_Fragment, {
+      children: [/*#__PURE__*/_jsx(Listbox.Overlay, {
+        overlaidPosition: overlaidPosition,
+        isReady: isReady,
+        minWidth: fullWidth ? inputWidth : MIN_LISTBOX_WIDTH,
+        maxWidth: inputWidth,
+        onLayout: handleMeasure,
+        tokens: restOfTokens,
+        ref: openOverlayRef,
+        children: isLoading ? /*#__PURE__*/_jsx(Loading, {
+          label: loadingLabel ?? getCopy('loading')
+        }) : /*#__PURE__*/_jsx(Suggestions, {
+          hasResults: getCopy('hasResults'),
+          id: "autocomplete",
+          items: nestedSelectedValue ? itemsToSuggest(highlight(otherItems, nestedSelectedValue, resultsTextColor)) : itemsToShow,
+          noResults: helpTextToShow,
+          onClose: handleClose,
+          onSelect: handleSelect,
+          parentRef: inputRef,
+          ref: targetRef
+        })
+      }), targetRef?.current && /*#__PURE__*/_jsx(View
+      // This catches and shifts focus to other interactive elements.
+      , {
+        onFocus: () => targetRef?.current?.focus(),
+        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,
+  tokens: getTokensPropType('Autocomplete'),
+  /**
+   * 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,
+  /**
+   * Help text to display when the input is focused and empty
+   */
+  helpText: PropTypes.string,
+  /**
+   * 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/esm/Autocomplete/Suggestions.js

@@ -0,0 +1,64 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import A11yText from '../A11yText';
+import Typography from '../Typography';
+import Box from '../Box';
+import Listbox from '../Listbox';
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+const Suggestions = /*#__PURE__*/React.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?.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/esm/BaseProvider/HydrationContext.js

@@ -0,0 +1,47 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import Platform from "react-native-web/dist/exports/Platform";
+import { jsx as _jsx } from "react/jsx-runtime";
+const HydrationContext = /*#__PURE__*/React.createContext();
+const isSSR = typeof window === 'undefined';
+const hasWebStyleTag = () => {
+  if (isSSR || Platform.OS !== 'web' || typeof document !== 'object') {
+    return false;
+  }
+  return Boolean(document?.getElementById('react-native-stylesheet'));
+};
+
+/**
+ * Returns true if this render cycle is the hydration of existing SSR content.
+ *
+ * Use this when changing how content renders based on data that is instantly available
+ * during the very first client-side render or hydration, but not available on the server,
+ * to ensure no changes happen until the original SSR DOM has been hydrated.
+ */
+export const useHydrationContext = () => React.useContext(HydrationContext);
+
+/**
+ * Allows components and hooks to observe if SSR hydration is currently in progress
+ * and if so, to re-render with content that differs to the server when it is complete.
+ */
+export const HydrationProvider = _ref => {
+  let {
+    children
+  } = _ref;
+  const [hasMounted, setHasMounted] = React.useState(false);
+  React.useEffect(() => {
+    setHasMounted(true);
+  }, []);
+
+  // If we've got a HydrationProvider inside a HydrationProvider somehow, defer to the top one
+  const valueFromAncestor = useHydrationContext();
+  const isHydrating = valueFromAncestor ?? Boolean(!hasMounted && hasWebStyleTag());
+  return /*#__PURE__*/_jsx(HydrationContext.Provider, {
+    value: isHydrating,
+    children: children
+  });
+};
+HydrationProvider.propTypes = {
+  children: PropTypes.node
+};
+export default HydrationProvider;

package/lib/esm/BaseProvider/index.js

@@ -0,0 +1,40 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { PortalProvider } from '@gorhom/portal';
+import A11yInfoProvider from '../A11yInfoProvider';
+import ViewportProvider from '../ViewportProvider';
+import ThemeProvider from '../ThemeProvider';
+import { HydrationProvider } from './HydrationContext';
+
+// eslint-disable-next-line no-unused-vars
+import { jsx as _jsx } from "react/jsx-runtime";
+const BaseProvider = /*#__PURE__*/React.forwardRef((_ref, _) => {
+  let {
+    defaultTheme,
+    children,
+    themeOptions
+  } = _ref;
+  return /*#__PURE__*/_jsx(HydrationProvider, {
+    children: /*#__PURE__*/_jsx(A11yInfoProvider, {
+      children: /*#__PURE__*/_jsx(ViewportProvider, {
+        children: /*#__PURE__*/_jsx(ThemeProvider, {
+          defaultTheme: defaultTheme,
+          themeOptions: themeOptions,
+          children: /*#__PURE__*/_jsx(PortalProvider, {
+            children: children
+          })
+        })
+      })
+    })
+  });
+});
+BaseProvider.displayName = 'BaseProvider';
+BaseProvider.propTypes = {
+  children: PropTypes.node.isRequired,
+  defaultTheme: ThemeProvider.propTypes?.defaultTheme,
+  themeOptions: PropTypes.shape({
+    forceAbsoluteFontSizing: PropTypes.bool,
+    forceZIndex: PropTypes.bool
+  })
+};
+export default BaseProvider;