@telus-uds/components-base 2.0.0 → 2.0.2

package/lib-module/Button/ButtonDropdown.js

@@ -1,181 +0,0 @@
-import React, { forwardRef } from 'react';
-import PropTypes from 'prop-types';
-import Platform from "react-native-web/dist/exports/Platform";
-import Text from "react-native-web/dist/exports/Text";
-import View from "react-native-web/dist/exports/View";
-import buttonPropTypes, { textAndA11yText } from './propTypes';
-import ButtonBase from './ButtonBase';
-import { useThemeTokensCallback } from '../ThemeProvider';
-import { a11yProps, focusHandlerProps, resolvePressableState, selectTokens, useInputValue } from '../utils';
-import Icon from '../Icon';
-import { getStackedContent } from '../StackView';
-import { getPressHandlersWithArgs } from '../utils/pressability';
-import { jsx as _jsx } from "react/jsx-runtime";
-
-const selectIconTokens = _ref => {
-  let {
-    icon,
-    iconPosition,
-    iconSpace,
-    iconSize,
-    iconColor,
-    iconBackground,
-    iconBorderRadius,
-    iconAlignSelf,
-    iconPadding,
-    iconTranslateX,
-    iconTranslateY
-  } = _ref;
-  return {
-    icon,
-    iconPosition,
-    iconSpace,
-    iconWrapperStyle: {
-      backgroundColor: iconBackground,
-      borderRadius: iconBorderRadius,
-      alignSelf: iconAlignSelf,
-      padding: iconPadding,
-      ...Platform.select({
-        // TODO: https://github.com/telus/universal-design-system/issues/487
-        web: {
-          transition: 'color 200ms, background 200ms'
-        }
-      })
-    },
-    iconTokens: {
-      size: iconSize,
-      color: iconColor,
-      translateX: iconTranslateX,
-      translateY: iconTranslateY
-    }
-  };
-};
-
-const ButtonDropdown = /*#__PURE__*/forwardRef((_ref2, ref) => {
-  let {
-    value,
-    initialValue,
-    onChange,
-    label,
-    tokens,
-    variant,
-    inactive = false,
-    readOnly = false,
-    children = null,
-    accessibilityRole = 'radio',
-    ...props
-  } = _ref2;
-  const {
-    currentValue: isOpen,
-    setValue: setIsOpen
-  } = useInputValue({
-    value,
-    initialValue,
-    onChange,
-    readOnly
-  }, 'useButtonDropdownValues');
-  const extraState = {
-    open: isOpen,
-    inactive,
-    ...variant
-  };
-  const getTokens = useThemeTokensCallback('ButtonDropdown', tokens, extraState);
-
-  const getButtonTokens = buttonState => selectTokens('Button', getTokens(buttonState)); // Pass an object of relevant component state as first argument for any passed-in press handlers
-
-
-  const pressHandlers = getPressHandlersWithArgs(props, [{
-    label,
-    open: isOpen
-  }]);
-
-  const handlePress = event => {
-    if (!inactive) {
-      if (pressHandlers.onPress) pressHandlers === null || pressHandlers === void 0 ? void 0 : pressHandlers.onPress(event);
-      setIsOpen(!isOpen, event);
-    }
-  };
-
-  return /*#__PURE__*/_jsx(ButtonBase, {
-    ref: ref,
-    ...pressHandlers,
-    onPress: handlePress,
-    tokens: getButtonTokens,
-    inactive: inactive,
-    icon: () => null,
-    accessibilityRole: accessibilityRole,
-    ...props,
-    children: _ref3 => {
-      let {
-        textStyles,
-        ...buttonState
-      } = _ref3;
-      // TODO: once Icon/IconButton designs are stable, see if this sort of styling around
-      // an icon should go in Icon itself, or possibly via an IconText token set. Related issues:
-      // - Icon: https://github.com/telus/universal-design-system/issues/327
-      // - IconButton: https://github.com/telus/universal-design-system/issues/281
-      // - Token sets: https://github.com/telus/universal-design-system/issues/782
-      const itemTokens = getTokens(buttonState);
-      const {
-        iconTokens,
-        iconPosition,
-        iconSpace,
-        iconWrapperStyle,
-        icon: IconComponent
-      } = selectIconTokens(itemTokens);
-      const iconContent = IconComponent ? /*#__PURE__*/_jsx(View, {
-        style: iconWrapperStyle,
-        children: /*#__PURE__*/_jsx(Icon, {
-          icon: IconComponent,
-          tokens: iconTokens
-        })
-      }) : null;
-
-      const childrenContent = () => typeof children === 'function' ? children({ ...resolvePressableState(buttonState, extraState),
-        textStyles
-      }) : children;
-
-      const content = children ? childrenContent() : /*#__PURE__*/_jsx(Text, {
-        style: textStyles,
-        children: label
-      });
-      return getStackedContent(iconPosition === 'left' ? [iconContent, content] : [content, iconContent], {
-        space: iconSpace,
-        direction: 'row'
-      });
-    }
-  });
-});
-ButtonDropdown.displayName = 'ButtonDropdown';
-ButtonDropdown.propTypes = { ...a11yProps.types,
-  ...focusHandlerProps.types,
-  ...buttonPropTypes,
-  children: textAndA11yText,
-
-  /**
-   * Callback called when a controlled ButtonDropdown gets interacted with.
-   */
-  onChange: PropTypes.func,
-
-  /**
-   * `value` prop is being used to set the 'open' state of ButtonDropdown. Use it for
-   *  controlled ButtonDropdown. For uncontrolled ButtonDropdown, use `initialValue`.
-   */
-  value: PropTypes.bool,
-
-  /**
-   * Use `initialValue` to provide the initial value for an uncontrolled version.
-   */
-  initialValue: PropTypes.bool,
-
-  /**
-   * The label of ButtonDropdown.
-   */
-  label: PropTypes.string,
-
-  /**
-   * By default, `ButtonDropdown` is treated by accessibility tools as a radio button.
-   */
-  accessibilityRole: PropTypes.string
-};
-export default ButtonDropdown;

package/lib-module/Button/ButtonGroup.js

@@ -1,264 +0,0 @@
-import React, { forwardRef } from 'react';
-import PropTypes from 'prop-types';
-import ABBPropTypes from 'airbnb-prop-types';
-import Platform from "react-native-web/dist/exports/Platform";
-import ButtonBase from './ButtonBase';
-import { StackWrap } from '../StackView';
-import Fieldset from '../Fieldset';
-import { useViewport } from '../ViewportProvider';
-import { useThemeTokens, useThemeTokensCallback } from '../ThemeProvider';
-import { a11yProps, containUniqueFields, focusHandlerProps, pressProps, getTokensPropType, selectSystemProps, selectTokens, useMultipleInputValues, variantProp, viewProps } from '../utils';
-import { getPressHandlersWithArgs } from '../utils/pressability';
-import { jsx as _jsx } from "react/jsx-runtime";
-const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
-const [selectItemProps, selectedItemPropTypes] = selectSystemProps([a11yProps, focusHandlerProps, pressProps, viewProps]);
-const ButtonGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
-  let {
-    variant,
-    tokens,
-    items = [],
-    values,
-    initialValues,
-    maxValues = 1,
-    onChange,
-    readOnly = false,
-    inactive = false,
-    legend,
-    tooltip,
-    hint,
-    hintPosition = 'inline',
-    validation,
-    feedback,
-    name: inputGroupName,
-    copy,
-    iconPosition,
-    accessibilityRole = maxValues === 1 ? 'radiogroup' // radiogroup is cross-platform; only web aria has generic groups
-    : Platform.select({
-      web: 'group',
-      default: 'none'
-    }),
-    ...rest
-  } = _ref;
-  const viewport = useViewport();
-  const themeTokens = useThemeTokens('ButtonGroup', tokens, variant, {
-    viewport
-  });
-  const stackTokens = selectTokens('StackView', themeTokens);
-  const {
-    direction,
-    space,
-    fieldSpace
-  } = themeTokens;
-  const getButtonTokens = useThemeTokensCallback('ButtonGroupItem', tokens, variant);
-  const {
-    currentValues,
-    toggleOneValue
-  } = useMultipleInputValues({
-    initialValues,
-    values,
-    maxValues,
-    onChange,
-    readOnly
-  });
-  const systemProps = selectProps({
-    accessibilityRole,
-    ...rest
-  });
-  const itemA11yRole = systemProps.accessibilityRole === 'radiogroup' ? 'radio' : 'checkbox';
-  const uniqueFields = ['id', 'label'];
-
-  if (!containUniqueFields(items, uniqueFields)) {
-    throw new Error("ButtonGroup items must have unique ".concat(uniqueFields.join(', ')));
-  } // Some web screenreaders e.g. MacOS Voiceover don't handle radiogroups properly unless radio is direct child of radiogroup
-
-
-  const innerRole = Platform.OS === 'web' && accessibilityRole === 'radiogroup' ? accessibilityRole : undefined;
-  return /*#__PURE__*/_jsx(Fieldset, { ...systemProps,
-    ref: ref,
-    name: inputGroupName,
-    legend: legend,
-    tooltip: tooltip,
-    hint: hint,
-    hintPosition: hintPosition,
-    space: fieldSpace,
-    feedback: feedback,
-    readOnly: readOnly,
-    inactive: inactive,
-    validation: validation,
-    accessibilityRole: accessibilityRole,
-    ...selectProps(rest),
-    children: /*#__PURE__*/_jsx(StackWrap, {
-      accessibilityRole: innerRole,
-      space: space,
-      direction: direction,
-      tokens: stackTokens,
-      ref: ref,
-      children: items.map((_ref2, index) => {
-        let {
-          label,
-          id = label,
-          accessibilityLabel,
-          ref: itemRef,
-          ...itemRest
-        } = _ref2;
-        const isSelected = currentValues.includes(id); // Pass an object of relevant component state as first argument for any passed-in press handlers
-
-        const pressHandlers = getPressHandlersWithArgs(rest, [{
-          id,
-          label,
-          currentValues
-        }]);
-
-        const handlePress = event => {
-          if (pressHandlers.onPress) pressHandlers.onPress(event);
-          toggleOneValue(id, event);
-        };
-
-        const iconProp = itemRest.icon || undefined;
-        const itemA11y = {
-          accessibilityState: {
-            checked: isSelected
-          },
-          accessibilityRole: itemA11yRole,
-          accessibilityLabel,
-          ...a11yProps.getPositionInSet(items.length, index)
-        }; // Ensure button is direct child of group as MacOS voiceover only applies "X of Y" to
-        // "radio" if it's a direct child of "radiogroup", even if aria-posinset etc exists
-
-        return /*#__PURE__*/_jsx(ButtonBase, {
-          ref: itemRef,
-          ...pressHandlers,
-          onPress: handlePress,
-          tokens: getButtonTokens,
-          selected: isSelected,
-          inactive: inactive,
-          icon: iconProp,
-          ...selectItemProps({ ...itemRest,
-            ...itemA11y
-          }),
-          iconPosition: iconPosition,
-          children: label
-        }, id);
-      })
-    })
-  });
-});
-ButtonGroup.displayName = 'ButtonGroup';
-ButtonGroup.propTypes = { ...selectedSystemPropTypes,
-  tokens: getTokensPropType('ButtonGroup'),
-  variant: variantProp.propType,
-
-  /**
-   * The maximum number of items a user may select at once. Defaults to 1 and behaves
-   * like radio buttons. To have no limit and allow any number of selections, pass `null`.
-   */
-  maxValues: PropTypes.number,
-
-  /**
-   * The options a user may select
-   */
-  items: PropTypes.arrayOf(PropTypes.shape({ ...selectedItemPropTypes,
-
-    /**
-     * The text displayed to the user in the button, describing this option,
-     * passed to the button as its child.
-     */
-    label: PropTypes.string.isRequired,
-
-    /**
-     * An optional accessibility label may be passed to ButtonGroup Buttons
-     * which is applied as normal for a React Native accessibilityLabel prop.
-     */
-    accessibilityLabel: PropTypes.string,
-
-    /**
-     * An optional unique string may be provided to identify this option,
-     * which will be used in code and passed to any onChange function.
-     * If not provided, the label is used.
-     */
-    id: PropTypes.string,
-
-    /**
-     * An optional ref for one individual button in the ButtonGroup
-     */
-    ref: ABBPropTypes.ref()
-  })),
-
-  /**
-   * If provided, this function is called when the current selection is changed
-   * and is passed an array of the `id`s of all currently selected `items`.
-   */
-  onChange: PropTypes.func,
-
-  /**
-   * If the selected item(s) in the button group are to be controlled externally by
-   * a parent component, pass an array of strings as well as an `onChange` handler.
-   * Passing an array for "values" makes the ButtonGroup a "controlled" component that
-   * expects its state to be handled via `onChange` and so doesn't handle it itself.
-   */
-  values: PropTypes.arrayOf(PropTypes.string),
-
-  /**
-   * If `values` is not passed, making the ButtonGroup an "uncontrolled" component
-   * managing its own selected state, a default set of selections may be provided.
-   * Changing the `initialValues` does not change the user's selections.
-   */
-  initialValues: PropTypes.arrayOf(PropTypes.string),
-
-  /**
-   * Defines if the icon will be displayed on the right or left side of the label.
-   */
-  iconPosition: PropTypes.oneOf(['left', 'right']),
-
-  /**
-   * Main text used to describe this group, used in Fieldset's Legend element.
-   */
-  legend: PropTypes.string,
-
-  /**
-   * Optional additional text giving more detail to help a user make a choice.
-   */
-  hint: PropTypes.string,
-
-  /**
-   * Position of the hint relative to label. Use `below` to display a larger hint below the label.
-   */
-  hintPosition: PropTypes.oneOf(['inline', 'below']),
-
-  /**
-   * Optional tooltip text content to include alongside the legend and hint.
-   */
-  tooltip: PropTypes.string,
-
-  /**
-   * Current validation status of the group, passed to the feedback element if there is one.
-   */
-  validation: PropTypes.oneOf(['error', 'success']),
-
-  /**
-   * If provided, a Feedback element is rendered containing this text.
-   */
-  feedback: PropTypes.string,
-
-  /**
-   * If true, the buttons cannot be selected by the user and simply show their current state.
-   */
-  readOnly: PropTypes.bool,
-
-  /**
-   * If true, the buttons cannot be interacted with, elements are set as `disabled` and if the
-   * theme supports `inactive` appearances rules, these are applied.
-   */
-  inactive: PropTypes.bool,
-
-  /**
-   * On Web, this is passed to the `name` attribute of the fieldset.
-   */
-  name: PropTypes.string,
-
-  /**
-   * Sets the language of microcopy in subcomponents (e.g. Tooltip's default accessibility label).
-   */
-  copy: PropTypes.oneOf(['en', 'fr'])
-};
-export default ButtonGroup;

package/lib-module/Button/ButtonLink.js

@@ -1,40 +0,0 @@
-import React, { forwardRef } from 'react';
-import ButtonBase from './ButtonBase';
-import buttonPropTypes, { textAndA11yText } from './propTypes';
-import { a11yProps, hrefAttrsProp, linkProps } from '../utils/props';
-import { useThemeTokensCallback } from '../ThemeProvider';
-/**
- * `ButtonLink` is a component with the semantics and behaviour of a link, but with the visual appearance of a button.
- * ButtonLink is a block-level component and should not be used inline.
- */
-
-import { jsx as _jsx } from "react/jsx-runtime";
-const ButtonLink = /*#__PURE__*/forwardRef((_ref, ref) => {
-  let {
-    accessibilityRole = 'link',
-    tokens,
-    variant,
-    dataSet,
-    ...props
-  } = _ref;
-  const {
-    hrefAttrs,
-    rest
-  } = hrefAttrsProp.bundle(props);
-  const getTokens = useThemeTokensCallback('Button', tokens, variant);
-  return /*#__PURE__*/_jsx(ButtonBase, {
-    ref: ref,
-    accessibilityRole: accessibilityRole,
-    tokens: getTokens,
-    hrefAttrs: hrefAttrs,
-    dataSet: dataSet,
-    ...rest
-  });
-});
-ButtonLink.displayName = 'ButtonLink';
-ButtonLink.propTypes = { ...a11yProps.types,
-  ...buttonPropTypes,
-  ...linkProps.types,
-  children: textAndA11yText
-};
-export default ButtonLink;

package/lib-module/Button/index.js

@@ -1,5 +0,0 @@
-import Button from './Button';
-import ButtonLink from './ButtonLink';
-import ButtonGroup from './ButtonGroup';
-import ButtonDropdown from './ButtonDropdown';
-export { Button, ButtonDropdown, ButtonGroup, ButtonLink };

package/lib-module/Button/propTypes.js

@@ -1,53 +0,0 @@
-import PropTypes from 'prop-types';
-import ABBPropTypes from 'airbnb-prop-types';
-import { variantProp, getTokensPropType } from '../utils/props';
-import A11yText from '../A11yText';
-import { iconComponentPropTypes } from '../Icon';
-export const textAndA11yText = ABBPropTypes.childrenOf(PropTypes.oneOfType([ABBPropTypes.elementType(A11yText), PropTypes.string]));
-const buttonPropTypes = {
-  tokens: getTokensPropType('Button'),
-
-  /**
-   * If true, prevents the button from being pressed, changes the cursor (on web) and accessibility
-   * attributes to communicate this to the user, and applies `inactive: true` appearances from the theme
-   */
-  inactive: PropTypes.bool,
-
-  /**
-   * Alias for `inactive`
-   */
-  disabled: PropTypes.bool,
-
-  /**
-   * Button's children must be either:
-   *  - One or more text strings and / or A11yText components
-   *  - A render function with contents that responds to current button state by being passed an object of:
-   * ```
-   * { hovered<bool>, focused<bool>, pressed<bool>, inactive<bool>, selected<bool>, textStyles<RNStyle> }
-   * ```
-   */
-  children: PropTypes.oneOfType([PropTypes.func, textAndA11yText]).isRequired,
-
-  /**
-   * Function called when the button is pressed. Required unless the button has a href.
-   */
-  onPress: PropTypes.func,
-
-  /**
-   * Optional variant that may be passed down to the link's icon if there is one
-   */
-  iconProps: PropTypes.exact(iconComponentPropTypes),
-
-  /**
-   * When `icon` is provided, use `iconPosition` to place the Icon to the left or right side of the button.
-   */
-  iconPosition: PropTypes.oneOf(['left', 'right']),
-
-  /**
-   * A function component for an SVG icon to render inside the link. Inherits size and color from
-   * the link and any Typography the link is nested inside.
-   */
-  icon: PropTypes.func,
-  variant: variantProp.propType
-};
-export default buttonPropTypes;

package/lib-module/Card/Card.js

@@ -1,85 +0,0 @@
-import React, { forwardRef } from 'react';
-import PropTypes from 'prop-types';
-import { useThemeTokens } from '../ThemeProvider';
-import { getTokensPropType, variantProp } from '../utils';
-import { useViewport } from '../ViewportProvider';
-import { a11yProps, selectSystemProps, viewProps } from '../utils/props';
-import CardBase from './CardBase';
-import { jsx as _jsx } from "react/jsx-runtime";
-const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
-/**
- * A basic card component, unstyled by default.
- *
- * ## Component API
- *
- * ### Background
- *
- * In order to control the background of a card, the following tokens are currently
- * supported:
- *
- * - `backgroundColor`
- *
- * ### Border
- *
- * The following border tokens can be used:
- *
- * - `borderColor`
- * - `borderRadius`
- * - `borderWidth`
- *
- * ### Padding
- *
- * Please use the following tokens to control the padding:
- *
- * - `paddingBottom`
- * - `paddingLeft`
- * - `paddingRight`
- * - `paddingTop`
- *
- * Note that various viewport sizes are supported as well.
- *
- * ### Shadow
- *
- * Feel free to use the following properties within the `shadow` token:
- *
- * - `inset`: boolean
- * - `color`: string
- * - `offsetX`: number
- * - `offsetY`: number
- * - `blur`: number
- * - `spread`: number
- *
- * ## Accessibility
- *
- * Card supports all the common a11y props. Please remember that by marking a card as `accessible`
- * you automatically make inaccessible its children, which may or may not be appropriate
- * depending on what you are trying to achieve.
- */
-
-const Card = /*#__PURE__*/forwardRef((_ref, ref) => {
-  let {
-    children,
-    tokens,
-    variant,
-    dataSet,
-    ...rest
-  } = _ref;
-  const viewport = useViewport();
-  const themeTokens = useThemeTokens('Card', tokens, variant, {
-    viewport
-  });
-  return /*#__PURE__*/_jsx(CardBase, {
-    ref: ref,
-    tokens: themeTokens,
-    dataSet: dataSet,
-    ...selectProps(rest),
-    children: children
-  });
-});
-Card.displayName = 'Card';
-Card.propTypes = { ...selectedSystemPropTypes,
-  children: PropTypes.node,
-  tokens: getTokensPropType('Card'),
-  variant: variantProp.propType
-};
-export default Card;

package/lib-module/Card/CardBase.js

@@ -1,66 +0,0 @@
-import React, { forwardRef } from 'react';
-import PropTypes from 'prop-types';
-import View from "react-native-web/dist/exports/View";
-import { applyShadowToken } from '../ThemeProvider';
-import { getTokensPropType } from '../utils';
-import { a11yProps, viewProps, selectSystemProps } from '../utils/props';
-import { jsx as _jsx } from "react/jsx-runtime";
-const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]); // Ensure explicit selection of tokens
-
-const selectStyles = _ref => {
-  let {
-    flex,
-    backgroundColor,
-    borderColor,
-    borderRadius,
-    borderWidth,
-    paddingBottom,
-    paddingLeft,
-    paddingRight,
-    paddingTop,
-    minWidth,
-    shadow
-  } = _ref;
-  return {
-    flex,
-    backgroundColor,
-    borderColor,
-    borderRadius,
-    borderWidth,
-    paddingBottom,
-    paddingLeft,
-    paddingRight,
-    paddingTop,
-    minWidth,
-    ...applyShadowToken(shadow)
-  };
-};
-/**
- * A themeless base component for Card which components can apply theme tokens to. Not
- * intended to be used in apps or sites directly: build themed components on top of this.
- */
-
-
-const CardBase = /*#__PURE__*/forwardRef((_ref2, ref) => {
-  let {
-    children,
-    tokens,
-    dataSet,
-    ...rest
-  } = _ref2;
-  const cardStyle = selectStyles(typeof tokens === 'function' ? tokens() : tokens);
-  const props = selectProps(rest);
-  return /*#__PURE__*/_jsx(View, {
-    style: cardStyle,
-    dataSet: dataSet,
-    ref: ref,
-    ...props,
-    children: children
-  });
-});
-CardBase.displayName = 'CardBase';
-CardBase.propTypes = { ...selectedSystemPropTypes,
-  children: PropTypes.node,
-  tokens: getTokensPropType('Card')
-};
-export default CardBase;