@telus-uds/components-base 0.0.2-prerelease.3 → 0.0.2-prerelease.7

package/lib/Button/ButtonGroup.js

@@ -1,27 +1,16 @@
 import React from 'react';
 import PropTypes from 'prop-types';
-import { View, Platform } from 'react-native';
+import { Platform } from 'react-native';
 import ButtonBase from './ButtonBase';
+import { StackWrap } from '../StackView';
 import { useViewport } from '../ViewportProvider';
-import { useThemeTokens } from '../ThemeProvider';
-import { a11yProps, pressProps, variantProp, getTokensPropType } from '../utils/propTypes';
+import { useThemeTokens, useThemeTokensCallback } from '../ThemeProvider';
+import { a11yProps, pressProps, variantProp, getTokensPropType, selectTokens } from '../utils/propTypes';
 import { useMultipleInputValues } from '../utils/input';
-
-const selectContainerStyles = ({
-  direction
-}) => ({
-  flexDirection: direction
-});
-
-const selectItemTokens = ({
-  gap
-}, index) => ({
-  marginLeft: index && gap
-});
+import { getPressHandlersWithArgs } from '../utils/pressability';
 
 const ButtonGroup = ({
   variant,
-  buttonVariant = {},
   tokens,
   items = [],
   values,
@@ -41,7 +30,12 @@ const ButtonGroup = ({
   const themeTokens = useThemeTokens('ButtonGroup', tokens, variant, {
     viewport
   });
-  const containerStyles = selectContainerStyles(themeTokens);
+  const stackTokens = selectTokens('StackView', themeTokens);
+  const {
+    direction,
+    space
+  } = themeTokens;
+  const getButtonTokens = useThemeTokensCallback('ButtonGroupItem', tokens, variant);
   const {
     currentValues,
     toggleOneValue
@@ -57,26 +51,22 @@ const ButtonGroup = ({
     ...rest
   });
   const itemA11yRole = a11y.accessibilityRole === 'radioGroup' ? 'radio' : 'checkbox';
-  return /*#__PURE__*/React.createElement(View, Object.assign({
-    style: containerStyles
-  }, a11y), items.map(({
+  return /*#__PURE__*/React.createElement(StackWrap, Object.assign({}, a11y, {
+    space: space,
+    direction: direction,
+    tokens: stackTokens
+  }), items.map(({
     label,
     id = label,
     accessibilityLabel
   }, index) => {
-    const itemTokens = selectItemTokens(themeTokens, index);
-    const isSelected = currentValues.includes(id); // Allow handlers to be passed down for blur, hover, focus, pressIn, etc
+    const isSelected = currentValues.includes(id); // Pass an object of relevant component state as first argument for any passed-in press handlers
 
-    const pressHandlers = Object.fromEntries(Object.entries(pressProps.select(rest)).map(([key, handler]) => ({
-      [key]: args => {
-        // Pass each handler data on this button and current selection
-        handler({
-          id,
-          label,
-          currentValues
-        }, ...args);
-      }
-    })));
+    const pressHandlers = getPressHandlersWithArgs(rest, [{
+      id,
+      label,
+      currentValues
+    }]);
 
     const handlePress = () => {
       if (pressHandlers.onPress) pressHandlers.onPress();
@@ -89,29 +79,15 @@ const ButtonGroup = ({
       },
       accessibilityRole: itemA11yRole,
       accessibilityLabel,
-      ...Platform.select({
-        web: {
-          // accessibilityPosInSet etc exists in React Native Web main branch
-          // but not in a release compatible with Expo etc; just use `aria-*`
-          'aria-setsize': items.length,
-          'aria-posinset': index + 1
-        },
-        default: {}
-      })
+      ...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
-    // See also: TODO: make margin the responsibility of a parent
-    // https://github.com/telus/universal-design-system/issues/525
 
     return /*#__PURE__*/React.createElement(ButtonBase, Object.assign({
       key: id
     }, pressHandlers, {
       onPress: handlePress,
-      variant: {
-        component: 'ButtonGroup',
-        ...buttonVariant
-      },
-      tokens: itemTokens,
+      tokens: getButtonTokens,
       selected: isSelected,
       inactive: inactive
     }, itemA11y), label);
@@ -122,7 +98,6 @@ ButtonGroup.propTypes = { ...a11yProps.propTypes,
   ...pressProps.propTypes,
   tokens: getTokensPropType('ButtonGroup'),
   variant: variantProp.propType,
-  buttonVariant: variantProp.propType,
 
   /**
    * The maximum number of items a user may select at once. Defaults to 1 and behaves

package/lib/Button/ButtonLink.js

@@ -2,6 +2,7 @@ import React from 'react';
 import ButtonBase from './ButtonBase';
 import buttonPropTypes from './propTypes';
 import { a11yProps, hrefAttrsProp, linkProps } from '../utils/propTypes';
+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.
@@ -9,14 +10,18 @@ import { a11yProps, hrefAttrsProp, linkProps } from '../utils/propTypes';
 
 const ButtonLink = ({
   accessibilityRole = 'link',
+  tokens,
+  variant,
   ...props
 }) => {
   const {
     hrefAttrs,
     rest
   } = hrefAttrsProp.bundle(props);
+  const getTokens = useThemeTokensCallback('Button', tokens, variant);
   return /*#__PURE__*/React.createElement(ButtonBase, Object.assign({
     accessibilityRole: accessibilityRole,
+    tokens: getTokens,
     hrefAttrs: hrefAttrs
   }, rest));
 };

package/lib/Checkbox/Checkbox.js

@@ -0,0 +1,308 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Pressable, StyleSheet, Text, View } from 'react-native';
+import CheckboxInput from './CheckboxInput'; // @todo move `LabelContent` outside of the `InputLabel` and fix
+// the issue with the cursor not being pointer on Web
+
+import CheckboxLabel from '../InputLabel/LabelContent';
+import Feedback from '../Feedback';
+import StackView from '../StackView';
+import { applyShadowToken, applyTextStyles, useThemeTokensCallback } from '../ThemeProvider';
+import { getTokensPropType, useInputValue, variantProp } from '../utils';
+import { a11yProps } from '../utils/propTypes';
+import useUniqueId from '../utils/useUniqueId';
+
+const selectInputStyles = ({
+  iconBackgroundColor,
+  inputBorderColor,
+  inputBorderRadius,
+  inputBorderWidth,
+  inputBackgroundColor,
+  inputHeight,
+  inputOutlineColor,
+  inputOutlineWidth,
+  inputShadow,
+  inputWidth
+}, isChecked) => ({
+  borderColor: inputBorderColor,
+  borderWidth: inputBorderWidth,
+  borderRadius: inputBorderRadius,
+  backgroundColor: isChecked ? iconBackgroundColor : inputBackgroundColor,
+  outlineStyle: 'solid',
+  outlineColor: inputOutlineColor,
+  outlineWidth: inputOutlineWidth,
+  height: inputHeight,
+  width: inputWidth,
+  ...applyShadowToken(inputShadow)
+});
+
+const selectLabelStyles = ({
+  labelColor,
+  labelFontName,
+  labelFontSize,
+  labelFontWeight,
+  labelMarginLeft,
+  labelLineHeight
+}) => ({
+  marginLeft: labelMarginLeft,
+  ...applyTextStyles({
+    color: labelColor,
+    fontName: labelFontName,
+    fontWeight: labelFontWeight,
+    fontSize: labelFontSize,
+    lineHeight: labelLineHeight
+  })
+});
+
+const selectContainerStyles = ({
+  containerMarginBottom
+}) => ({
+  marginBottom: containerMarginBottom
+});
+
+const selectIconTokens = ({
+  iconColor,
+  iconSize
+}) => ({
+  color: iconColor,
+  size: iconSize
+});
+
+const selectFeedbackTokens = ({
+  feedbackMarginBottom,
+  feedbackMarginTop,
+  feedbackPosition
+}) => ({
+  feedbackPosition,
+  feedbackMarginBottom,
+  feedbackMarginTop
+});
+/**
+ * Basic Checkbox component.
+ *
+ * ## Component API
+ *
+ * Use `label` prop to provide a label for the checkbox.
+ * For a disabled `Checkbox` set the `inactive` prop to `true`.
+ *
+ * ### Controlled version
+ *
+ * If the checkbox is controlled from outside, it needs to receive `checked` and `onChange` props.
+ *
+ * ### Uncontrolled version
+ *
+ * In case of uncontrolled checkbox you can use `defaultChecked` prop to provide the initial value.
+ * Whenever the checkbox gets toggled, it calls the `onChange` callback with the new value (boolean).
+ *
+ * ### Using within forms
+ *
+ * You can pass `name` and `value` props if you need a particular checkbox to be a part of a group of
+ * checkboxes on a form.
+ *
+ * ### Validation and feedback
+ *
+ * You can use the `feedback` prop to provide a comment related to the checkbox element. If the comment
+ * is related to a validation error, the checkbox and the feedback can be styled accordingly by setting
+ * the `error` prop to `true` (can also be done without feedback).
+ *
+ * ## A11y guidelines
+ *
+ * Checkbox component accepts all the common accessibility props, but also sets some defaults, including
+ * accessibility role `'checkbox'` and accessibility state that depends on the other props (`checked`, `inactive`)
+ * or the internal state in case of uncontrolled checkbox.
+ *
+ */
+
+
+const Checkbox = ({
+  checked,
+  defaultChecked,
+  error = false,
+  feedback,
+  id,
+  inactive,
+  label,
+  name,
+  onChange,
+  tokens,
+  value,
+  variant,
+  ...rest
+}) => {
+  const {
+    currentValue: isChecked,
+    setValue: setIsChecked,
+    isControlled
+  } = useInputValue({
+    value: checked,
+    initialValue: defaultChecked,
+    onChange
+  }, 'useCheckboxValue');
+  const getTokens = useThemeTokensCallback('Checkbox', tokens, {
+    checked: isChecked,
+    inactive,
+    error,
+    ...variant
+  });
+  const defaultTokens = getTokens();
+  const {
+    feedbackMarginBottom,
+    feedbackMarginTop,
+    feedbackPosition
+  } = selectFeedbackTokens(defaultTokens);
+  const styles = StyleSheet.create({
+    feedbackContainer: {
+      marginTop: feedbackMarginTop,
+      marginBottom: feedbackMarginBottom
+    }
+  });
+
+  const handleChange = () => {
+    if (!inactive) {
+      setIsChecked(!isChecked);
+    }
+  };
+
+  const accessibilityProps = a11yProps.select(rest);
+  const uniqueId = useUniqueId('checkbox');
+  const inputId = id ?? uniqueId; // @todo our current version of React Native Web doesn't include
+  // keyboard support on `Pressable` (which starts with 0.15.3), so
+  // the complete accessibility of the `Checkbox` component on Web
+  // (namely, change on key pressed) is pending RNW upgrade
+  // (see https://github.com/necolas/react-native-web/issues/1950)
+
+  return /*#__PURE__*/React.createElement(View, {
+    style: staticStyles.wrapper
+  }, /*#__PURE__*/React.createElement(StackView, {
+    direction: feedbackPosition === 'top' ? 'column-reverse' : 'column',
+    space: 0
+  }, /*#__PURE__*/React.createElement(Pressable, Object.assign({
+    disabled: inactive,
+    onPress: handleChange,
+    accessibilityRole: "checkbox",
+    accessibilityState: {
+      checked: isChecked,
+      disabled: inactive
+    }
+  }, accessibilityProps), ({
+    focused: focus,
+    hovered: hover,
+    pressed
+  }) => {
+    const {
+      icon: IconComponent,
+      ...stateTokens
+    } = getTokens({
+      focus,
+      hover,
+      pressed
+    });
+    const iconTokens = selectIconTokens(stateTokens);
+    return /*#__PURE__*/React.createElement(View, {
+      style: [staticStyles.container, selectContainerStyles(stateTokens)]
+    }, /*#__PURE__*/React.createElement(View, {
+      style: StyleSheet.flatten([staticStyles.defaultInputStyles, selectInputStyles(stateTokens, isChecked)]),
+      testID: "Checkbox-Input"
+    }, /*#__PURE__*/React.createElement(CheckboxInput, {
+      checked: isChecked,
+      defaultChecked: defaultChecked,
+      disabled: inactive,
+      id: inputId,
+      isControlled: isControlled,
+      name: name,
+      value: value
+    }), isChecked && IconComponent && /*#__PURE__*/React.createElement(IconComponent, {
+      tokens: iconTokens,
+      testID: "Checkbox-Icon"
+    })), Boolean(label) && /*#__PURE__*/React.createElement(Text, {
+      style: selectLabelStyles(stateTokens)
+    }, /*#__PURE__*/React.createElement(CheckboxLabel, {
+      forId: inputId
+    }, label)));
+  }), Boolean(feedback) && /*#__PURE__*/React.createElement(View, {
+    style: styles.feedbackContainer
+  }, /*#__PURE__*/React.createElement(Feedback, {
+    title: feedback,
+    variant: {
+      icon: error === true
+    },
+    validation: error === true ? 'error' : undefined
+  }))));
+};
+
+Checkbox.propTypes = { ...a11yProps.propTypes,
+
+  /**
+   * Use `checked` for controlled Checkbox. For uncontrolled Checkbox, use the `defaultChecked` prop.
+   */
+  checked: PropTypes.bool,
+
+  /**
+   * Use `defaultChecked` to provide the initial value for an uncontrolled Checkbox.
+   */
+  defaultChecked: PropTypes.bool,
+
+  /**
+   * A detailed description of related validation error or additional instructions (depending on the `error` prop).
+   */
+  feedback: PropTypes.string,
+
+  /**
+   * Checkbox ID.
+   */
+  id: PropTypes.string,
+
+  /**
+   * Whether the corresponding input is disabled or active.
+   */
+  inactive: PropTypes.bool,
+
+  /**
+   * The label.
+   */
+  label: PropTypes.string,
+
+  /**
+   * Associate this checkbox with a group (set as the name attribute).
+   */
+  name: PropTypes.string,
+
+  /**
+   * Whether the underlying input triggered a validation error or not.
+   */
+  error: PropTypes.bool,
+
+  /**
+   * The value. Must be unique within the group.
+   */
+  value: PropTypes.oneOfType([PropTypes.string, PropTypes.number, PropTypes.bool]),
+
+  /**
+   * Callback called when a controlled checkbox gets interacted with.
+   */
+  onChange: PropTypes.func,
+
+  /**
+   * Checkbox tokens.
+   */
+  tokens: getTokensPropType('Checkbox'),
+
+  /**
+   * Checkbox variant.
+   */
+  variant: variantProp.propType
+};
+export default Checkbox;
+const staticStyles = StyleSheet.create({
+  wrapper: {
+    backgroundColor: 'transparent'
+  },
+  container: {
+    flexDirection: 'row',
+    alignItems: 'center'
+  },
+  defaultInputStyles: {
+    alignItems: 'center',
+    justifyContent: 'center'
+  }
+});

package/lib/Checkbox/CheckboxInput.native.js

@@ -0,0 +1,6 @@
+/**
+ * There's no checkbox input on native platforms, so this is a noop.
+ */
+const CheckboxInput = () => null;
+
+export default CheckboxInput;

package/lib/Checkbox/CheckboxInput.web.js

@@ -0,0 +1,57 @@
+import React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+/**
+ * On Web we need to include an actual input but hide it.
+ */
+
+const CheckboxInput = /*#__PURE__*/forwardRef(({
+  checked,
+  defaultChecked,
+  disabled,
+  id,
+  isControlled,
+  name,
+  onChange,
+  value
+}, ref) => {
+  const handleClick = event => {
+    // Cancel the click dispatched via the label tag, since it's already wrapped
+    // in <Pressable>
+    event.preventDefault();
+    event.stopPropagation();
+  };
+
+  return /*#__PURE__*/React.createElement("input", {
+    checked: isControlled ? checked : undefined,
+    defaultChecked: isControlled ? undefined : defaultChecked,
+    disabled: disabled,
+    hidden: true,
+    id: id,
+    name: name,
+    onChange: onChange,
+    onClick: handleClick,
+    ref: ref,
+    type: "checkbox",
+    value: value
+  });
+});
+CheckboxInput.displayName = 'CheckboxInput';
+CheckboxInput.propTypes = {
+  checked: PropTypes.bool,
+  defaultChecked: PropTypes.bool,
+  disabled: PropTypes.bool,
+  id: PropTypes.string.isRequired,
+  isControlled: PropTypes.bool.isRequired,
+  name: PropTypes.string,
+  onChange: PropTypes.func,
+  value: PropTypes.string
+};
+CheckboxInput.defaultProps = {
+  checked: undefined,
+  defaultChecked: undefined,
+  disabled: false,
+  name: undefined,
+  onChange: () => {},
+  value: undefined
+};
+export default CheckboxInput;

package/lib/Checkbox/index.js

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

package/lib/Divider/Divider.js

@@ -2,7 +2,13 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { View, StyleSheet, Platform } from 'react-native';
 import { useThemeTokens } from '../ThemeProvider';
-import { getTokensPropType, variantProp } from '../utils/propTypes';
+import Spacer from '../Spacer';
+import { getTokensPropType, variantProp, spacingProps } from '../utils';
+/**
+ * @typedef {import('../utils/propTypes.js').SpacingIndex} SpacingIndex
+ * @typedef {import('../utils/propTypes.js').SpacingObject} SpacingObject
+ */
+
 /**
  * A basic divider component, horizontal by default. Color and thickness can be controlled by theme.
  * Divider is based on the flexbox model and uses `alignSelf: flex` to span its flex parent.
@@ -15,6 +21,26 @@ import { getTokensPropType, variantProp } from '../utils/propTypes';
  *
  * In a flexbox row, vertical dividers will automatically size to their parent height.
  *
+ * ## Space
+ *
+ * Use this to create **space either side of the divider**. For simple cases, pass a number referring to
+ * a position on the theme's spacing scale; for example, this will put a Spacer of the smallest supported
+ * size either side of the divider:
+ *
+ * ```jsx
+ * <Divider space={1} />
+ * ```
+ *
+ * `space` prop uses `useSpacingScale` and may accept a {@link SpacingObject} or a {@link SpacingIndex} number.
+ *
+ * To **reduce the length of a divider** as well as creating space between it and its neighbours, wrap it in
+ * a `Box` component. For example, this will have the second-smallest theme-supported spacing value between
+ * the dividing line and its neighbours, and will shorten the line at either end by the same amount:
+ *
+ * ```jsx
+ * <Box space={2}><Divider /></Box>
+ * ```
+ *
  * ## Accessibility
  *
  * For accessibility purposes a divider component will be described with ARIA attributes, i.e. `role="separator"` and `aria-orientation="vertical/horizontal"`.
@@ -23,6 +49,7 @@ import { getTokensPropType, variantProp } from '../utils/propTypes';
 const Divider = ({
   variant,
   vertical = false,
+  space,
   tokens,
   testID
 }) => {
@@ -43,14 +70,25 @@ const Divider = ({
     accessibilityRole: 'separator'
   } : // There are no such equivalent attributes for native
   {};
-  return /*#__PURE__*/React.createElement(View, Object.assign({
+  const divider = /*#__PURE__*/React.createElement(View, Object.assign({
     style: [styles.divider, borderStyles],
     testID: testID
   }, a11y));
+  if (!space) return divider;
+  const spacerProps = {
+    space,
+    direction: vertical ? 'row' : 'column'
+  };
+  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Spacer, Object.assign({}, spacerProps, {
+    testID: testID ? `${testID}-Spacer-before` : undefined
+  })), divider, /*#__PURE__*/React.createElement(Spacer, Object.assign({}, spacerProps, {
+    testID: testID ? `${testID}-Spacer-after` : undefined
+  })));
 };
 
 Divider.propTypes = {
   tokens: getTokensPropType('Divider'),
+  space: spacingProps.types.spacingValue,
   variant: variantProp.propType,
 
   /**