@telus-uds/components-web 2.17.2 → 2.19.0

package/src/Autocomplete/Autocomplete.jsx

@@ -1,357 +0,0 @@
-/* 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,
-  useThemeTokens
-} 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'
-
-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 = (str, substring = '', matchIndexes = [], resultsTextColor) => (
-  // Wrapping all in bold
-  <Typography variant={{ bold: false }} tokens={{ color: resultsTextColor }}>
-    {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) ?? ''),
-        // Unbold the occurrence of the substring (while keeping the original casing)
-        <Typography key={matchIndex} variant={{ bold: true }} tokens={{ color: resultsTextColor }}>
-          {str.slice(matchIndex, matchIndex + substring.length)}
-        </Typography>,
-        // 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)
-      ],
-      []
-    )}
-  </Typography>
-)
-const highlight = (items = [], text = '', color) =>
-  items.reduce((acc, item) => {
-    const matches = Array.from(item.label.toLowerCase().matchAll(text.toLowerCase()))?.map(
-      ({ index }) => index
-    )
-
-    if (matches?.length) {
-      return [...acc, { ...item, label: highlightAllMatches(item.label, text, matches, color) }]
-    }
-
-    return [...acc, item]
-  }, [])
-
-const Autocomplete = forwardRef(
-  (
-    {
-      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
-    },
-    ref
-  ) => {
-    const { color: resultsTextColor } = useThemeTokens('Search', {}, { 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] = useState(initialItems)
-
-    // We need to store the current value as well to be able to highlight it
-    const [currentValue, setCurrentValue] = useState(value ?? initialValue)
-
-    const inputTokens = { paddingLeft: INPUT_LEFT_PADDING }
-
-    // Setting up the overlay
-    const openOverlayRef = useRef()
-    const [isExpanded, setIsExpanded] = useState((value ?? initialValue)?.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 = (data = []) =>
-      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 = () => {
-        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 })
-
-      updateInputWidth()
-
-      window.addEventListener('load', updateInputWidth)
-      window.addEventListener('resize', throttledUpdateInputWidth)
-
-      return () => {
-        window.removeEventListener('load', updateInputWidth)
-        window.removeEventListener('resize', throttledUpdateInputWidth)
-      }
-    }, [inputRef])
-
-    const handleChange = (newValue) => {
-      onChange?.(newValue)
-      setCurrentValue(newValue)
-      setIsExpanded(newValue?.length >= minToSuggestion)
-      if (!isControlled && initialItems !== undefined) {
-        setCurrentItems(
-          initialItems.filter(({ label }) =>
-            label?.toLowerCase()?.includes(newValue?.toLowerCase())
-          )
-        )
-      }
-    }
-    const handleSelect = (selectedId) => {
-      onSelect?.(selectedId)
-      const { label: newValue } = (isControlled ? items : currentItems)?.find(
-        ({ id }) => id === selectedId
-      )
-      onChange?.(newValue)
-      setCurrentValue(newValue)
-      if (!isControlled && inputRef?.current) inputRef.current.value = newValue
-      setIsExpanded(false)
-    }
-    const handleClose = (event) => {
-      if (event.type === 'keydown') {
-        if (event.key === 'Escape' || event.key === 27) {
-          setIsExpanded(false)
-        } else if (event.key === 'ArrowDown' && isExpanded && !isLoading && targetRef?.current) {
-          targetRef.current.focus()
-        }
-      } else if (
-        event.type === 'click' &&
-        openOverlayRef?.current &&
-        event.target &&
-        !openOverlayRef?.current?.contains(event.target)
-      ) {
-        setIsExpanded(false)
-      } else if (
-        event.type === 'touchstart' &&
-        openOverlayRef?.current &&
-        event.touches[0].target &&
-        !openOverlayRef?.current?.contains(event.touches[0].target)
-      ) {
-        setIsExpanded(false)
-      }
-    }
-
-    const { supportsProps, ...selectedProps } = selectProps(rest)
-
-    return (
-      <>
-        <InputSupports
-          {...supportsProps}
-          accessibilityAutoComplete="list"
-          accessibilityControls="autocomplete"
-          accessibilityExpanded={isExpanded}
-          accessibilityRole="combobox"
-          {...selectedProps}
-          validation={validation}
-          ref={ref}
-        >
-          {({ inputId, ...props }) => {
-            if (typeof children === 'function')
-              return children({
-                inputId,
-                inputRef,
-                onChange: handleChange,
-                onKeyPress: handleClose,
-                readOnly,
-                tokens: inputTokens,
-                ...selectedProps,
-                ...props,
-                ...(isControlled ? { value } : { initialValue })
-              })
-
-            return (
-              <TextInput
-                onChange={handleChange}
-                onClear={onClear}
-                onKeyPress={handleClose}
-                readOnly={readOnly}
-                ref={inputRef}
-                tokens={inputTokens}
-                validation={validation}
-                {...selectedProps}
-                {...props}
-                {...(isControlled ? { value } : { initialValue })}
-              />
-            )
-          }}
-        </InputSupports>
-        {isExpanded && (
-          <>
-            <Listbox.Overlay
-              overlaidPosition={overlaidPosition}
-              isReady={isReady}
-              minWidth={fullWidth ? inputWidth : MIN_LISTBOX_WIDTH}
-              maxWidth={inputWidth}
-              onLayout={onTargetLayout}
-              ref={openOverlayRef}
-            >
-              {isLoading ? (
-                <Loading label={getCopy('loading')} />
-              ) : (
-                <Suggestions
-                  hasResults={getCopy('hasResults')}
-                  id="autocomplete"
-                  items={itemsToSuggest(
-                    highlight(isControlled ? items : currentItems, currentValue, resultsTextColor)
-                  )}
-                  noResults={noResults ?? getCopy('noResults')}
-                  onClose={handleClose}
-                  onSelect={handleSelect}
-                  parentRef={inputRef}
-                  ref={targetRef}
-                />
-              )}
-            </Listbox.Overlay>
-            {targetRef?.current && (
-              <div
-                // This catches and shifts focus to other interactive elements.
-                onFocus={() => 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/src/Autocomplete/Loading.jsx

@@ -1,15 +0,0 @@
-import React from 'react'
-import PropTypes from 'prop-types'
-import { Box, StackView } from '@telus-uds/components-base'
-import Spinner from '../Spinner'
-
-const Loading = ({ label }) => (
-  <Box space={3}>
-    <StackView direction="row" space={2} tokens={{ alignItems: 'center' }}>
-      <Spinner inline={true} show={true} label={label} labelPosition="right" />
-    </StackView>
-  </Box>
-)
-Loading.propTypes = { label: PropTypes.string }
-
-export default Loading

package/src/Autocomplete/Suggestions.jsx

@@ -1,52 +0,0 @@
-import React, { forwardRef } from 'react'
-import PropTypes from 'prop-types'
-import { A11yText, Box, Typography } from '@telus-uds/components-base'
-import Listbox from '../Listbox'
-
-const Suggestions = forwardRef(
-  ({ hasResults, items = [], noResults, onClose, onSelect, parentRef }, ref) => {
-    const pressableItems = items.map(({ id, ...rest }) => ({
-      id,
-      onPress: () => onSelect(id),
-      ...rest
-    }))
-    if (items?.length)
-      return (
-        <>
-          <A11yText accessibilityLiveRegion="polite" text={hasResults} />
-          <Listbox
-            items={pressableItems}
-            firstItemRef={ref}
-            parentRef={parentRef}
-            onClose={onClose}
-          />
-        </>
-      )
-
-    return (
-      <Box space={3}>
-        {typeof noResults === 'string' ? (
-          <>
-            <Typography accessibilityLiveRegion="polite" variant={{ size: 'small' }}>
-              {noResults}
-            </Typography>
-          </>
-        ) : (
-          noResults
-        )}
-      </Box>
-    )
-  }
-)
-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/src/Autocomplete/constants.js

@@ -1,6 +0,0 @@
-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/src/Autocomplete/dictionary.js

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

package/src/Autocomplete/index.js

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

package/src/Listbox/GroupControl.jsx

@@ -1,82 +0,0 @@
-import React from 'react'
-import styled from 'styled-components'
-import PropTypes from 'prop-types'
-import { Icon, Spacer, useThemeTokens, useListboxContext } from '@telus-uds/components-base'
-
-const StyledControlWrapper = styled.div(
-  ({
-    groupFontName,
-    groupFontWeight,
-    groupFontSize,
-    groupColor,
-    groupBackgroundColor,
-    groupBorderColor,
-    groupBorderWidth,
-    groupBorderRadius,
-    groupPaddingLeft,
-    groupPaddingRight,
-    groupPaddingTop,
-    groupPaddingBottom,
-    itemTextDecoration,
-    itemOutline,
-    groupHeight
-  }) => ({
-    fontFamily: `${groupFontName}${groupFontWeight}normal`,
-    fontSize: groupFontSize,
-    color: groupColor,
-    textDecoration: itemTextDecoration,
-    backgroundColor: groupBackgroundColor,
-    outline: itemOutline,
-    width: '100%',
-    height: groupHeight,
-    display: 'flex',
-    alignItems: 'center',
-    justifyContent: 'space-between',
-    boxSizing: 'border-box',
-    border: `${groupBorderWidth}px solid ${groupBorderColor}`,
-    borderRadius: groupBorderRadius,
-    paddingLeft: groupPaddingLeft - groupBorderWidth,
-    paddingRight: groupPaddingRight - groupBorderWidth,
-    paddingTop: groupPaddingTop - groupBorderWidth,
-    paddingBottom: groupPaddingBottom - groupBorderWidth
-  })
-)
-
-const GroupControl = ({ expanded, pressed, hover, focus, label, id }) => {
-  const { selectedId, setSelectedId } = useListboxContext()
-  const tokens = useThemeTokens(
-    'Listbox',
-    {},
-    {},
-    {
-      expanded,
-      pressed,
-      hover,
-      current: selectedId === id && id !== undefined,
-      focus
-    }
-  )
-
-  return (
-    <StyledControlWrapper onClick={() => setSelectedId(id)} {...tokens}>
-      {label}
-      <Spacer space={1} direction="row" />
-      <Icon
-        icon={tokens.groupIcon}
-        tokens={{ color: tokens.groupColor }}
-        variant={{ size: 'micro' }}
-      />
-    </StyledControlWrapper>
-  )
-}
-
-GroupControl.propTypes = {
-  id: PropTypes.string,
-  expanded: PropTypes.bool,
-  pressed: PropTypes.bool,
-  hover: PropTypes.bool,
-  focus: PropTypes.bool,
-  label: PropTypes.string
-}
-
-export default GroupControl

package/src/Listbox/Listbox.jsx

@@ -1,163 +0,0 @@
-import React, { useCallback, useEffect, useRef, useState } from 'react'
-import PropTypes from 'prop-types'
-import styled from 'styled-components'
-import {
-  ExpandCollapse,
-  useThemeTokens,
-  withLinkRouter,
-  ListboxContext
-} from '@telus-uds/components-base'
-import ListboxGroup from './ListboxGroup'
-import ListboxItem from './ListboxItem'
-import DropdownOverlay from './ListboxOverlay'
-
-const StyledList = styled.ul({
-  margin: 0,
-  padding: 0,
-  listStyle: 'none'
-})
-
-const getInitialOpen = (items, selectedId) =>
-  items
-    .filter(
-      (item) =>
-        item.items &&
-        item.items.some((nestedItem) => (nestedItem.id ?? nestedItem.label) === selectedId)
-    )
-    .map((item) => item.id ?? item.label)
-
-const Listbox = ({
-  items = [],
-  firstItemRef = null, // focus will be moved to this one once within the menu
-  parentRef = null, // to return focus to after leaving the last menu item
-  selectedId: defaultSelectedId,
-  LinkRouter,
-  itemRouterProps,
-  onClose,
-  variant,
-  tokens
-}) => {
-  const initialOpen = getInitialOpen(items, defaultSelectedId)
-
-  const [selectedId, setSelectedId] = useState(defaultSelectedId)
-
-  const { minHeight, minWidth } = useThemeTokens('Listbox', variant, tokens)
-
-  // We need to keep track of each item's ref in order to be able to
-  // focus on a specific item via keyboard navigation
-  const itemRefs = useRef([])
-  if (firstItemRef?.current) itemRefs.current[0] = firstItemRef.current
-  const [focusedIndex, setFocusedIndex] = useState(0)
-  const handleKeydown = useCallback(
-    (event) => {
-      const nextItemRef = itemRefs.current[focusedIndex + 1]
-      const prevItemRef = itemRefs.current[focusedIndex - 1]
-      if (event.key === 'ArrowUp' || (event.shiftKey && event.key === 'Tab')) {
-        // Move the focus to the previous item or to the parent one if on the first
-        if (prevItemRef) {
-          event.preventDefault()
-          prevItemRef.focus()
-        } else if (parentRef) parentRef.current?.focus()
-        setFocusedIndex(focusedIndex - 1)
-      } else if ((event.key === 'ArrowDown' || event.key === 'Tab') && nextItemRef) {
-        event.preventDefault()
-        setFocusedIndex(focusedIndex + 1)
-        nextItemRef.focus()
-      } else if (event.key === 'Escape') {
-        // Close the dropdown
-        parentRef?.current?.click()
-        // Return focus to the dropdown control after leaving the last item
-        parentRef?.current?.focus()
-        if (onClose) onClose(event)
-      }
-    },
-    [focusedIndex, onClose, parentRef]
-  )
-
-  // Add listeners for mouse clicks outside and for key presses
-  useEffect(() => {
-    window.addEventListener('click', onClose)
-    window.addEventListener('keydown', handleKeydown)
-    window.addEventListener('touchstart', onClose)
-
-    return () => {
-      window.removeEventListener('click', onClose)
-      window.removeEventListener('keydown', handleKeydown)
-      window.removeEventListener('touchstart', onClose)
-    }
-  }, [onClose, handleKeydown])
-
-  return (
-    <ListboxContext.Provider value={{ selectedId, setSelectedId }}>
-      <ExpandCollapse initialOpen={initialOpen} maxOpen={1}>
-        {(expandProps) => (
-          <StyledList role="listbox" style={{ minHeight, minWidth }}>
-            {items.map((item, index) => {
-              const { id, label, items: nestedItems } = item
-              const itemId = id ?? label
-
-              // Give `firstItemRef` to the first focusable item
-              const itemRef =
-                (index === 0 && !itemId !== selectedId) ||
-                (index === 1 && items[0].id === selectedId)
-                  ? firstItemRef
-                  : (ref) => {
-                      itemRefs.current[index] = ref
-                      return ref
-                    }
-
-              return nestedItems ? (
-                <ListboxGroup
-                  {...item}
-                  expandProps={expandProps}
-                  LinkRouter={LinkRouter}
-                  itemRouterProps={itemRouterProps}
-                  prevItemRef={itemRefs.current[index - 1] ?? null}
-                  nextItemRef={itemRefs.current[index + 1] ?? null}
-                  ref={itemRef}
-                  key={itemId}
-                />
-              ) : (
-                <ListboxItem
-                  {...item}
-                  key={itemId}
-                  id={itemId}
-                  LinkRouter={LinkRouter}
-                  itemRouterProps={itemRouterProps}
-                  prevItemRef={itemRefs.current[index - 1] ?? null}
-                  nextItemRef={itemRefs.current[index + 1] ?? null}
-                  ref={itemRef}
-                />
-              )
-            })}
-          </StyledList>
-        )}
-      </ExpandCollapse>
-    </ListboxContext.Provider>
-  )
-}
-
-Listbox.propTypes = {
-  ...withLinkRouter.propTypes,
-  /**
-   * Focus will be moved to the item with this ref once within the menu.
-   */
-  firstItemRef: PropTypes.object,
-  /**
-   * Focus will be returned to the dropdown control with this ref after leaving
-   * the last menu item.
-   */
-  parentRef: PropTypes.object,
-  /**
-   * `Listbox` items
-   */
-  items: PropTypes.array,
-  /**
-   * To select an item by default
-   */
-  selectedId: PropTypes.string
-}
-
-Listbox.Overlay = DropdownOverlay
-
-export default Listbox