@telus-uds/components-base 1.8.3 → 1.9.0

package/lib-module/Select/Select.js

@@ -0,0 +1,337 @@
+import React, { forwardRef, useState } from 'react';
+import View from "react-native-web/dist/exports/View";
+import Platform from "react-native-web/dist/exports/Platform";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import PropTypes from 'prop-types';
+import { applyTextStyles, useThemeTokens, applyOuterBorder } from '../ThemeProvider';
+import { a11yProps, componentPropType, getTokensPropType, inputSupportsProps, selectSystemProps, useInputValue, variantProp, viewProps } from '../utils';
+import Picker from './Picker';
+import InputSupports from '../InputSupports';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, inputSupportsProps, viewProps]);
+
+const selectInputStyles = (_ref, inactive) => {
+  let {
+    backgroundColor,
+    color,
+    borderWidth = 0,
+    borderColor,
+    borderRadius,
+    paddingTop,
+    paddingBottom,
+    paddingLeft = 0,
+    paddingRight,
+    fontName,
+    fontSize,
+    fontWeight,
+    lineHeight,
+    icon,
+    iconSize = 0,
+    validationIcon,
+    validationIconSize = 0,
+    height
+  } = _ref;
+
+  // Subtract border width from padding so overall input width/height doesn't
+  // jump around if the border width changes (avoiding NaN and negative padding)
+  const offsetBorder = value => typeof value === 'number' ? Math.max(0, value - borderWidth) : value;
+
+  const textStyles = applyTextStyles({
+    fontName,
+    fontSize,
+    lineHeight,
+    fontWeight
+  });
+  const webStyles = Platform.select({
+    web: {
+      appearance: 'none',
+      WebkitAppearance: 'none',
+      // since iOS Safari needs a prefix
+      outline: 'none',
+      cursor: inactive ? 'not-allowed' : undefined,
+      opacity: inactive ? 1 : undefined // override Chrome's default fadeout of a disabled select
+
+    }
+  });
+  let paddingWithIcons = paddingRight;
+
+  if (Platform.OS !== 'android') {
+    if (icon) {
+      paddingWithIcons += iconSize;
+    }
+
+    if (validationIcon) {
+      paddingWithIcons += validationIconSize;
+    }
+  }
+
+  return {
+    backgroundColor,
+    color,
+    borderWidth,
+    borderColor,
+    borderRadius,
+    paddingLeft: offsetBorder(paddingLeft),
+    paddingRight: offsetBorder(paddingWithIcons),
+    paddingTop: offsetBorder(paddingTop),
+    paddingBottom: offsetBorder(paddingBottom),
+    height,
+    ...textStyles,
+    ...webStyles
+  };
+};
+
+const selectOuterBorderStyles = _ref2 => {
+  let {
+    outerBackgroundColor,
+    outerBorderWidth,
+    outerBorderColor,
+    borderRadius
+  } = _ref2;
+  return {
+    background: outerBackgroundColor,
+    ...applyOuterBorder({
+      outerBorderColor,
+      outerBorderWidth,
+      borderRadius
+    })
+  };
+};
+
+const selectIconTokens = _ref3 => {
+  let {
+    iconSize,
+    iconColor
+  } = _ref3;
+  return {
+    size: iconSize,
+    color: iconColor
+  };
+};
+
+const selectIconContainerStyles = _ref4 => {
+  let {
+    paddingRight,
+    paddingBottom
+  } = _ref4;
+  return {
+    paddingRight,
+    paddingBottom
+  };
+};
+
+const selectValidationIconTokens = _ref5 => {
+  let {
+    validationIconSize,
+    validationIconColor
+  } = _ref5;
+  return {
+    size: validationIconSize,
+    color: validationIconColor
+  };
+};
+
+const selectValidationIconContainerStyles = _ref6 => {
+  let {
+    icon,
+    iconSize = 0,
+    paddingRight = 0,
+    paddingBottom
+  } = _ref6;
+  return {
+    paddingRight: icon ? paddingRight + iconSize : paddingRight,
+    paddingBottom
+  };
+};
+/**
+ * A basic form single-choice select component. Use in forms or individually to receive user's input.
+ *
+ * ## Usage criteria
+ * - Include a `placeholder` to provide instructions such as "Please select..." as an unselectable option (recommended)
+ * - Use when options are between 7-15 (recommended)
+ * - For options are 6 and under, use `Radio` groups or `ButtonGroup`.
+ * - For options 15 and above, look for alternatives (e.g grouping into categories, or input field with auto-complete etc.)
+ *
+ * ## Controlled component
+ * If it is required that the state of the `Select` be controlled by the application or other external methods,
+ * `value` and `onChange` props must be passed to the `Select`.
+ * If the `Select` value should not be changed by user input, a `readOnly` prop must be provided.
+ *
+ * ## Uncontrolled component
+ * If it is not necessary to control the `Select` state, you can create one without a value prop.
+ * In this case its value can be accessed within the `onChange` callback. Use the `initialValue` prop to set the
+ * default value for an uncontrolled `Select`.
+ *
+ * ## Getting feedback for entered values
+ * Use the `feedback` prop to give the user feedback regarding their selection.
+ * You can affirm that the user's selection was correct, or highlight errors that must be corrected, using the `validation` prop.
+ * Keep feedback text as brief as possible, should be limited to text and links.
+ *
+ * ## Using a tooltip
+ * When a more in-depth explanation is needed to fill out a `Select` properly, the tooltip prop may be used.
+ *
+ * ## Grouping options
+ * `Select` supports option groups. Use a `Select.Group` component to render an `<optgroup>` element with its items.
+ * NOTE: this does not work on native platforms - the grouped items will be shown at the same level as the non-grouped items.
+ *
+ */
+
+
+const Select = /*#__PURE__*/forwardRef((_ref7, ref) => {
+  let {
+    value,
+    initialValue,
+    onChange,
+    children,
+    inactive,
+    readOnly,
+    placeholder,
+    validation,
+    tokens,
+    variant,
+    testID,
+    ...rest
+  } = _ref7;
+  const {
+    currentValue,
+    setValue
+  } = useInputValue({
+    value,
+    initialValue,
+    onChange,
+    readOnly
+  });
+  const [isFocused, setIsFocused] = useState(false);
+
+  const handleFocus = () => setIsFocused(true);
+
+  const handleBlur = () => setIsFocused(false);
+
+  const [isHovered, setIsHovered] = useState(false);
+
+  const handleMouseOver = () => setIsHovered(true);
+
+  const handleMouseOut = () => setIsHovered(false);
+
+  const {
+    supportsProps,
+    ...selectedProps
+  } = selectProps(rest);
+  const themeTokens = useThemeTokens('Select', tokens, variant, {
+    focus: isFocused,
+    hover: isHovered,
+    inactive,
+    validation
+  });
+  const {
+    icon: IconComponent,
+    validationIcon: ValidationIconComponent
+  } = themeTokens;
+  return /*#__PURE__*/_jsx(InputSupports, { ...supportsProps,
+    ...selectedProps,
+    children: _ref8 => {
+      let {
+        inputId,
+        ...props
+      } = _ref8;
+      return /*#__PURE__*/_jsxs(View, {
+        style: selectOuterBorderStyles(themeTokens),
+        children: [/*#__PURE__*/_jsx(Picker, {
+          ref: ref,
+          style: selectInputStyles(themeTokens, inactive),
+          onFocus: handleFocus,
+          onBlur: handleBlur,
+          onMouseOver: handleMouseOver,
+          onMouseOut: handleMouseOut,
+          onChange: setValue,
+          value: currentValue,
+          inactive: inactive,
+          placeholder: placeholder !== undefined ? {
+            label: placeholder,
+            value: ''
+          } : undefined,
+          ...props,
+          nativeID: inputId,
+          testID: testID,
+          children: children
+        }), ValidationIconComponent && /*#__PURE__*/_jsx(View, {
+          pointerEvents: "none",
+          style: [staticStyles.iconContainer, selectValidationIconContainerStyles(themeTokens)],
+          children: /*#__PURE__*/_jsx(ValidationIconComponent, { ...selectValidationIconTokens(themeTokens)
+          })
+        }), IconComponent && Platform.OS !== 'android' &&
+        /*#__PURE__*/
+        // we can't hide the default caret of a native picker on android
+        _jsx(View, {
+          pointerEvents: "none",
+          style: [staticStyles.iconContainer, selectIconContainerStyles(themeTokens)],
+          children: /*#__PURE__*/_jsx(IconComponent, { ...selectIconTokens(themeTokens)
+          })
+        })]
+      });
+    }
+  });
+});
+Select.displayName = 'Select';
+Select.propTypes = { ...selectedSystemPropTypes,
+
+  /**
+   * Initial value for the uncontrolled version.
+   */
+  initialValue: PropTypes.string,
+
+  /**
+   * Current value to be set as selected.
+   */
+  value: PropTypes.string,
+
+  /**
+   * Callback to be called when the value changes.
+   */
+  onChange: PropTypes.func,
+
+  /**
+   * An array of items or item groups to be used as options.
+   */
+  children: componentPropType(['Item', 'Group']),
+
+  /**
+   * Whether the select is disabled.
+   */
+  inactive: PropTypes.bool,
+
+  /**
+   * Whether the select is read-only.
+   */
+  readOnly: PropTypes.bool,
+
+  /**
+   * A placeholder to provide instructions (such as "Please select...")
+   * as an unselectable option
+   */
+  placeholder: PropTypes.string,
+
+  /**
+   * Select tokens.
+   */
+  tokens: getTokensPropType('Select'),
+
+  /**
+   * Select variant.
+   */
+  variant: variantProp.propType,
+
+  /**
+   * Dedicated ID for testing.
+   */
+  testID: PropTypes.string
+};
+export default Select;
+const staticStyles = StyleSheet.create({
+  iconContainer: {
+    position: 'absolute',
+    right: 0,
+    bottom: 0
+  }
+});

package/lib-module/Select/index.js

@@ -0,0 +1,6 @@
+import Select from './Select';
+import Group from './Group';
+import Item from './Item';
+Select.Group = Group;
+Select.Item = Item;
+export default Select;

package/lib-module/SideNav/Item.js

@@ -0,0 +1,145 @@
+import React, { forwardRef } from 'react';
+import Pressable from "react-native-web/dist/exports/Pressable";
+import PropTypes from 'prop-types';
+import { a11yProps, getTokensPropType, hrefAttrsProp, linkProps, selectSystemProps, variantProp, viewProps } from '../utils';
+import { useThemeTokensCallback, verticalAlignRow } from '../ThemeProvider';
+import ItemContent from './ItemContent';
+import { jsx as _jsx } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, linkProps, viewProps]);
+
+function selectItemStyles(_ref) {
+  let {
+    backgroundColor,
+    borderColor,
+    borderWidth,
+    borderStyle,
+    paddingLeft,
+    paddingRight,
+    paddingTop,
+    paddingBottom,
+    justifyContent,
+    verticalAlign
+  } = _ref;
+  return {
+    backgroundColor,
+    borderTopColor: borderColor,
+    borderTopWidth: borderWidth,
+    borderTopStyle: borderStyle,
+    paddingLeft,
+    paddingRight,
+    paddingTop,
+    paddingBottom,
+    justifyContent,
+    ...verticalAlignRow(verticalAlign)
+  };
+}
+/**
+ `SideNav.Item` is a navigational element that is used within `SideNav` or `SideNav.ItemsGroup`.
+
+ This component can only be accessed as a name-spaced component: `SideNav.Item`.
+ */
+
+
+const Item = /*#__PURE__*/forwardRef((_ref2, ref) => {
+  let {
+    children,
+    itemId,
+    groupId,
+    onPress,
+    isActive = false,
+    isExpanded = false,
+    tokens,
+    variant,
+    href,
+    accessibilityRole = 'link',
+    testID,
+    ...props
+  } = _ref2;
+
+  const handlePress = () => onPress(itemId, groupId);
+
+  const {
+    hrefAttrs,
+    rest
+  } = hrefAttrsProp.bundle(props);
+  const selectedProps = selectProps({
+    accessibilityRole,
+    href,
+    onPress: handlePress,
+    hrefAttrs,
+    ...rest
+  });
+  const getTokens = useThemeTokensCallback('SideNavItem', tokens, variant);
+
+  const getAppearanceState = _ref3 => {
+    let {
+      hovered
+    } = _ref3;
+    return {
+      hover: hovered,
+      active: isActive,
+      expanded: isExpanded
+    };
+  };
+
+  const getPressableStyle = pressableState => selectItemStyles(getTokens(getAppearanceState(pressableState)));
+
+  return /*#__PURE__*/_jsx(Pressable, {
+    ref: ref,
+    style: getPressableStyle,
+    accessibilityState: {
+      selected: isActive
+    },
+    ...selectedProps,
+    children: pressableState => {
+      const themeTokens = getTokens(getAppearanceState(pressableState));
+      return /*#__PURE__*/_jsx(ItemContent, {
+        tokens: themeTokens,
+        children: children
+      });
+    }
+  });
+});
+Item.displayName = 'Item';
+Item.propTypes = { ...selectedSystemPropTypes,
+
+  /**
+   * Text content of the `Item`.
+   */
+  children: PropTypes.node.isRequired,
+
+  /**
+   * @ignore
+   * Set internally in `SideNav` render function - used to keep track of active item.
+   */
+  itemId: PropTypes.string,
+
+  /**
+   * @ignore
+   * Set internally in `SideNav` render function - used to keep track of expanded items groups.
+   */
+  groupId: PropTypes.string,
+  onPress: PropTypes.func,
+  href: PropTypes.string,
+
+  /**
+   * On Web if href is passed, React Native Web maps this object's props to
+   * `rel`, `target` and `download` attrs.
+   */
+  hrefAttrs: PropTypes.shape(hrefAttrsProp.types),
+
+  /**
+   * @ignore
+   * Set internally in `SideNav` render function.
+   */
+  isActive: PropTypes.bool,
+
+  /**
+   * @ignore
+   * Set internally in `SideNav.ItemsGroup` render function. Used to mark expanded `ItemsGroup` parent.
+   */
+  isExpanded: PropTypes.bool,
+  tokens: getTokensPropType('SideNavItem'),
+  variant: variantProp.propType
+};
+export default Item;

package/lib-module/SideNav/ItemContent.js

@@ -0,0 +1,48 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import View from "react-native-web/dist/exports/View";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import Typography from '../Typography';
+import { selectTokens, getTokensPropType } from '../utils';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Fragment as _Fragment } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+export function selectAccentStyles(tokens) {
+  return {
+    left: tokens.accentOffset,
+    top: tokens.accentPadding,
+    bottom: tokens.accentPadding,
+    backgroundColor: tokens.accentBackgroundColor,
+    width: tokens.accentWidth,
+    position: 'absolute'
+  };
+}
+/**
+ * Content inside an item or control in a SideNav, themed by the SideNavItem theme
+ */
+
+const ItemContent = _ref => {
+  let {
+    children,
+    tokens
+  } = _ref;
+  return /*#__PURE__*/_jsxs(_Fragment, {
+    children: [/*#__PURE__*/_jsx(Typography, {
+      tokens: selectTokens('Typography', tokens),
+      children: children
+    }), /*#__PURE__*/_jsx(View, {
+      style: [staticStyles.absolute, selectAccentStyles(tokens)]
+    })]
+  });
+};
+
+ItemContent.propTypes = {
+  tokens: getTokensPropType('SideNavItem'),
+  children: PropTypes.node
+};
+const staticStyles = StyleSheet.create({
+  absolute: {
+    position: 'absolute'
+  }
+});
+export default ItemContent;

package/lib-module/SideNav/ItemsGroup.js

@@ -0,0 +1,117 @@
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+import ItemContent from './ItemContent';
+import ExpandCollapse from '../ExpandCollapse';
+import { getTokensPropType, variantProp, componentPropType, selectTokens } from '../utils';
+import { useThemeTokensCallback } from '../ThemeProvider';
+/**
+ Expandable content areas for use within `SideNav`.
+
+ This component can only be accessed as a name-spaced component: `SideNav.ItemsGroup`.
+
+ `SideNav.ItemsGroup` contains a label and a list of items. Items can link to in-page elements or route to other pages.
+
+ ## Usage Criteria
+ - Use `SideNav.ItemsGroup` with large pages that have multiple sections
+ */
+
+import { jsx as _jsx } from "react/jsx-runtime";
+const ItemsGroup = /*#__PURE__*/forwardRef((_ref, ref) => {
+  let {
+    children,
+    label,
+    openGroups,
+    groupId,
+    isActive = false,
+    variant,
+    tokens,
+    itemTokens,
+    onToggle
+  } = _ref;
+
+  // A SideNav control uses the same style and theme as SideNavItem, with a 'parent' variant,
+  // plus control-specific tokens from the SideNavItemsGroup theme (e.g. open/close icon, etc).
+  const getAppearance = appearance => ({ ...variant,
+    ...appearance,
+    active: isActive
+  });
+
+  const getItemAppearance = appearance => ({ ...getAppearance(appearance),
+    type: 'parent'
+  });
+
+  const getGroupTokens = useThemeTokensCallback('SideNavItemsGroup', tokens, variant);
+
+  const getPanelTokens = appearance => selectTokens('ExpandCollapsePanel', getGroupTokens(getAppearance(appearance)));
+
+  const getItemTokens = useThemeTokensCallback('SideNavItem', itemTokens, variant);
+
+  const getControlTokens = appearance => selectTokens('ExpandCollapseControl', { ...getItemTokens(getItemAppearance(appearance)),
+    // main style from SideNavItem
+    ...getGroupTokens(getAppearance(appearance)) // control-specific tokens like icon etc
+
+  });
+
+  const controlContent = controlState => {
+    const currentItemTokens = getItemTokens(getItemAppearance(controlState));
+    return /*#__PURE__*/_jsx(ItemContent, {
+      tokens: currentItemTokens,
+      children: label
+    });
+  };
+
+  return /*#__PURE__*/_jsx(ExpandCollapse.Panel, {
+    ref: ref,
+    openIds: openGroups,
+    panelId: groupId,
+    onToggle: onToggle,
+    tokens: getPanelTokens,
+    controlTokens: getControlTokens,
+    control: controlContent,
+    accessibilityState: {
+      active: isActive
+    } // ExpandCollapse.Panel handles expanded state
+    ,
+    children: children
+  });
+});
+ItemsGroup.displayName = 'ItemsGroup';
+ItemsGroup.propTypes = {
+  /**
+   * Specifies the links contained within. It may only contain `SideNav.Item`.
+   */
+  children: componentPropType('Item'),
+
+  /**
+   * Text content of the group's parent `SideNav.Item`.
+   */
+  label: PropTypes.string.isRequired,
+
+  /**
+   * @ignore
+   * Set internally in `SideNav` render function - used to keep track of expanded items groups.
+   */
+  groupId: PropTypes.string,
+
+  /**
+   * @ignore
+   * Set internally in `SideNav` render function. Called when the group is expanded/collapsed.
+   */
+  onToggle: PropTypes.func,
+
+  /**
+   * @ignore
+   * Set internally in `SideNav` render function. Contains `groupId`s of currently open groups.
+   */
+  openGroups: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.string, PropTypes.number])),
+
+  /**
+   * @ignore
+   * Set internally in `SideNav` render function. Used to mark group containing the currently active `SideNav.Item`.
+   */
+  isActive: PropTypes.bool,
+  variant: variantProp.propType,
+  tokens: getTokensPropType('SideNavItemsGroup'),
+  itemTokens: getTokensPropType('SideNavItem')
+};
+export default ItemsGroup;