@telus-uds/components-base 1.8.3 → 1.8.4

package/lib-module/FlexGrid/Col/Col.js

@@ -0,0 +1,276 @@
+import React, { forwardRef, useContext } from 'react';
+import PropTypes from 'prop-types';
+import Platform from "react-native-web/dist/exports/Platform";
+import StyleSheet from "react-native-web/dist/exports/StyleSheet";
+import View from "react-native-web/dist/exports/View";
+import { viewports } from '@telus-uds/system-constants';
+import GutterContext from '../providers/GutterContext';
+import { useViewport } from '../../ViewportProvider';
+import applyInheritance from '../helpers';
+import { responsiveProps } from '../../utils';
+import { jsx as _jsx } from "react/jsx-runtime";
+const Col = /*#__PURE__*/forwardRef((_ref, ref) => {
+  let {
+    horizontalAlign,
+    children,
+    xs,
+    sm,
+    md,
+    lg,
+    xl,
+    xsOffset,
+    smOffset,
+    mdOffset,
+    lgOffset,
+    xlOffset,
+    flex,
+    ...viewProps
+  } = _ref;
+  const gutter = useContext(GutterContext);
+  const viewPort = useViewport();
+  const hiddenLevels = applyInheritance([xs, sm, md, lg, xl]);
+
+  const getHorizontalAlignLevel = () => {
+    if (typeof horizontalAlign === 'object') {
+      return applyInheritance([horizontalAlign.xs, horizontalAlign.sm, horizontalAlign.md, horizontalAlign.lg, horizontalAlign.xl]);
+    }
+
+    if (typeof horizontalAlign === 'string') {
+      return [horizontalAlign, horizontalAlign, horizontalAlign, horizontalAlign, horizontalAlign];
+    }
+
+    return ['inherit', 'inherit', 'inherit', 'inherit', 'inherit'];
+  };
+
+  const horizontalAlignLevel = getHorizontalAlignLevel();
+
+  const toPercent = num => {
+    return "".concat(num / 12 * 100, "%");
+  };
+
+  const calculateWidth = value => {
+    if (typeof value === 'undefined') {
+      return {};
+    }
+
+    if (typeof value === 'number') {
+      const percent = toPercent(value);
+      return {
+        maxWidth: percent,
+        flexBasis: percent
+      };
+    }
+
+    return {
+      flexGrow: 1,
+      flexBasis: 0,
+      maxWidth: '100%'
+    };
+  };
+
+  const calculateOffset = value => {
+    if (typeof value === 'number') {
+      const percent = toPercent(value);
+      return {
+        marginLeft: percent
+      };
+    }
+
+    return {};
+  };
+
+  const sizeStyles = sizes => {
+    const currViewport = Object.keys(sizes).find(key => key.startsWith(viewPort));
+    const currSize = sizes[currViewport];
+    return { ...calculateWidth(currSize)
+    };
+  };
+
+  const offsetStyles = offsets => {
+    const currViewport = Object.keys(offsets).find(key => key.startsWith(viewPort));
+    const currOffset = offsets[currViewport];
+    return { ...calculateOffset(currOffset)
+    };
+  };
+
+  const gutterPadding = {
+    paddingLeft: gutter ? 16 : 0,
+    paddingRight: gutter ? 16 : 0
+  };
+  let hidingStyles = {}; // TODO: consider setting this to always 'flex' in a major release.
+  // `display: block` is invalid in native apps.
+  // See https://telusdigital.atlassian.net/browse/UDS1-92
+
+  const shown = !flex && Platform.OS === 'web' ? 'block' : 'flex';
+
+  if (viewPort === viewports.xs) {
+    hidingStyles = {
+      display: hiddenLevels[0] === 0 ? 'none' : shown,
+      textAlign: horizontalAlignLevel[0]
+    };
+  }
+
+  if (viewPort === viewports.sm) {
+    hidingStyles = {
+      display: hiddenLevels[1] === 0 ? 'none' : shown,
+      textAlign: horizontalAlignLevel[1]
+    };
+  }
+
+  if (viewPort === viewports.md) {
+    hidingStyles = {
+      display: hiddenLevels[2] === 0 ? 'none' : shown,
+      textAlign: horizontalAlignLevel[2]
+    };
+  }
+
+  if (viewPort === viewports.lg) {
+    hidingStyles = {
+      display: hiddenLevels[3] === 0 ? 'none' : shown,
+      textAlign: horizontalAlignLevel[3]
+    };
+  }
+
+  if (viewPort === viewports.xl) {
+    hidingStyles = {
+      display: hiddenLevels[4] === 0 ? 'none' : shown,
+      textAlign: horizontalAlignLevel[4]
+    };
+  }
+
+  const sizesArray = [xs, sm, md, lg, xl];
+  const offSetsArray = [xsOffset, smOffset, mdOffset, lgOffset, xlOffset];
+  const sizesWithIheritance = applyInheritance(sizesArray);
+  const offsetsWithIheritance = applyInheritance(offSetsArray);
+  const sizes = {
+    xs: sizesWithIheritance[0],
+    sm: sizesWithIheritance[1],
+    md: sizesWithIheritance[2],
+    lg: sizesWithIheritance[3],
+    xl: sizesWithIheritance[4]
+  };
+  const offsets = {
+    xs: offsetsWithIheritance[0],
+    sm: offsetsWithIheritance[1],
+    md: offsetsWithIheritance[2],
+    lg: offsetsWithIheritance[3],
+    xl: offsetsWithIheritance[4]
+  };
+  return /*#__PURE__*/_jsx(View, {
+    ref: ref,
+    ...viewProps,
+    style: [styles.col, gutterPadding, offsetStyles(offsets), sizeStyles(sizes), { ...hidingStyles
+    }],
+    children: children
+  });
+});
+Col.displayName = 'Col';
+const styles = StyleSheet.create({
+  col: {
+    flexGrow: 1,
+    flexShrink: 0,
+    flexBasis: 'auto',
+    maxWidth: '100%'
+  }
+});
+/*
+ * We're disabling default props since passing undefined props to
+ * the react-flexbox-grid component sets up blank classes that may cause
+ * styling issues.
+ */
+
+Col.propTypes = {
+  /**
+   * Specify number of columns within the 'xs' breakpoint range. `0` hides the column.
+   *
+   * `true` sets the column width automatically;
+   * `false` disables the prop
+   *
+   */
+  xs: PropTypes.oneOf([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, true, false]),
+
+  /**
+   * Specify number of columns within the 'sm' breakpoint range. `0` hides the column.
+   *
+   * `true` sets the column width automatically;
+   * `false` disables the prop
+   *
+   */
+  sm: PropTypes.oneOf([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, true, false]),
+
+  /**
+   * Specify number of columns within the 'md' breakpoint range. `0` hides the column.
+   *
+   * `true` sets the column width automatically;
+   * `false` disables the prop
+   *
+   */
+  md: PropTypes.oneOf([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, true, false]),
+
+  /**
+   * Specify number of columns within the 'lg' breakpoint range. `0` hides the column.
+   *
+   * `true` sets the column width automatically;
+   * `false` disables the prop
+   *
+   */
+  lg: PropTypes.oneOf([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, true, false]),
+
+  /**
+   * Specify number of columns after the 'xl' breakpoint. `0` hides the column.
+   *
+   * `true` sets the column width automatically;
+   * `false` disables the prop
+   *
+   */
+  xl: PropTypes.oneOf([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, true, false]),
+
+  /**
+   * Offset the specified number of columns within the 'xs' breakpoint range. `0` hides the column.
+   *
+   */
+  xsOffset: PropTypes.oneOf([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]),
+
+  /**
+   * Offset the specified number of columns within the 'sm' breakpoint range.
+   *
+   */
+  smOffset: PropTypes.oneOf([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]),
+
+  /**
+   * Offset the specified number of columns within the 'md' breakpoint range.
+   *
+   */
+  mdOffset: PropTypes.oneOf([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]),
+
+  /**
+   * Offset the specified number of columns within the 'lg' breakpoint range.
+   *
+   */
+  lgOffset: PropTypes.oneOf([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]),
+
+  /**
+   * Offset the specified number of columns within the 'xl' breakpoint range.
+   */
+  xlOffset: PropTypes.oneOf([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]),
+
+  /**
+   * The columns of the Grid. Will typically be `FlexGrid.Col` components.
+   */
+  children: PropTypes.node.isRequired,
+
+  /**
+   *
+   * Align content horizontally within the column.
+   *
+   * Accepts a `PropType.string` following the [responsive prop](#/Layout?id=responsive) structure.
+   */
+  horizontalAlign: responsiveProps.getTypeOptionallyByViewport(PropTypes.oneOf(['left', 'center', 'right'])),
+
+  /**
+   * (web only) Stretches the column to fill vertical space using `display: flex`.
+   * In native apps, FlexGrid.Col behaves as if this is always true (as do all `View`s).
+   */
+  flex: PropTypes.bool
+};
+export default Col;

package/lib-module/FlexGrid/Col/index.js

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

package/lib-module/FlexGrid/FlexGrid.js

@@ -0,0 +1,148 @@
+import React, { forwardRef } 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 { viewports } from '@telus-uds/system-constants';
+import Row from './Row';
+import Col from './Col';
+import { useViewport } from '../ViewportProvider';
+import GutterContext from './providers/GutterContext';
+import applyInheritance from './helpers';
+import { a11yProps, viewProps, getA11yPropsFromHtmlTag, layoutTags, selectSystemProps } from '../utils';
+import { jsx as _jsx } from "react/jsx-runtime";
+const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps]);
+/**
+ * A mobile-first flexbox grid.
+ */
+
+const FlexGrid = /*#__PURE__*/forwardRef((_ref, ref) => {
+  let {
+    limitWidth = true,
+    gutter = true,
+    outsideGutter = true,
+    xsReverse,
+    smReverse,
+    mdReverse,
+    lgReverse,
+    xlReverse,
+    tag,
+    accessibilityRole,
+    children,
+    ...rest
+  } = _ref;
+  const viewPort = useViewport();
+  const reverseLevel = applyInheritance([xsReverse, smReverse, mdReverse, lgReverse, xlReverse]);
+  const marginVertical = 0;
+  const marginHorizontal = outsideGutter ? 'auto' : -16;
+  const width = outsideGutter ? '100%' : 'auto';
+  let flexDirection;
+  let maxWidth;
+
+  if (viewPort === viewports.xs) {
+    // no maxWidth for xs
+    flexDirection = reverseLevel[0] ? 'column-reverse' : 'column';
+  }
+
+  if (viewPort === viewports.sm) {
+    maxWidth = limitWidth && viewports.map.get(viewports.sm);
+    flexDirection = reverseLevel[1] ? 'column-reverse' : 'column';
+  }
+
+  if (viewPort === viewports.md) {
+    maxWidth = limitWidth && viewports.map.get(viewports.md);
+    flexDirection = reverseLevel[2] ? 'column-reverse' : 'column';
+  }
+
+  if (viewPort === viewports.lg) {
+    maxWidth = limitWidth && viewports.map.get(viewports.lg);
+    flexDirection = reverseLevel[3] ? 'column-reverse' : 'column';
+  }
+
+  if (viewPort === viewports.xl) {
+    maxWidth = limitWidth && viewports.map.get(viewports.xl);
+    flexDirection = reverseLevel[4] ? 'column-reverse' : 'column';
+  }
+
+  const props = { ...getA11yPropsFromHtmlTag(tag, accessibilityRole),
+    ...selectProps(rest)
+  };
+  return /*#__PURE__*/_jsx(GutterContext.Provider, {
+    value: gutter,
+    children: /*#__PURE__*/_jsx(View, {
+      ref: ref,
+      ...props,
+      style: [styles.grid, {
+        marginHorizontal,
+        marginVertical,
+        width,
+        flexDirection,
+        maxWidth
+      }],
+      children: children
+    })
+  });
+});
+FlexGrid.displayName = 'FlexGrid';
+const styles = StyleSheet.create({
+  grid: {
+    flexWrap: 'wrap'
+  }
+});
+FlexGrid.propTypes = { ...selectedSystemPropTypes,
+
+  /**
+   * Whether or not to give the grid a fixed width. This also centres the grid horizontally.
+   */
+  limitWidth: PropTypes.bool,
+
+  /**
+   * Whether or not to include gutters in between columns.
+   */
+  gutter: PropTypes.bool,
+
+  /**
+   * Whether or not to include gutter at the ends to the left and right of the FlexGrid
+   */
+  outsideGutter: PropTypes.bool,
+
+  /**
+   * Choose if the item order should be reversed from the 'xs' breakpoint. When you pass in false, the order will be normal from the xs breakpoint. By default, it inherits the behaviour set by the preceding prop.
+   */
+  xsReverse: PropTypes.bool,
+
+  /**
+   * Choose if the item order should be reversed from the 'sm' breakpoint. When you pass in false, the order will be normal from the sm breakpoint. By default, it inherits the behaviour set by the preceding prop.
+   */
+  smReverse: PropTypes.bool,
+
+  /**
+   * Choose if the item order should be reversed from the 'md' breakpoint. When you pass in false, the order will be normal from the md breakpoint. By default, it inherits the behaviour set by the preceding prop.
+   */
+  mdReverse: PropTypes.bool,
+
+  /**
+   * Choose if the item order should be reversed from the 'lg' breakpoint. When you pass in false, the order will be normal from the lg breakpoint. By default, it inherits the behaviour set by the preceding prop.
+   */
+  lgReverse: PropTypes.bool,
+
+  /**
+   * Choose if the item order should be reversed from the 'xl' breakpoint. When you pass in false, the order will be normal from the xl breakpoint. By default, it inherits the behaviour set by the preceding prop.
+   */
+  xlReverse: PropTypes.bool,
+
+  /**
+   * Optional semantic HTML tag, to apply to the container on web. Does not change styling.
+   *
+   * In native apps, if a header tag is provided ("h1", "h2" etc) and accessibilityRole prop
+   * is not defined, the accessibilityRole will default to "heading".
+   */
+  tag: PropTypes.oneOf(layoutTags),
+
+  /**
+   * The rows and columns of the Grid. Will typically be `FlexGrid.Row` and `FlexGrid.Col` components.
+   */
+  children: PropTypes.node.isRequired
+};
+FlexGrid.Row = Row;
+FlexGrid.Col = Col;
+export default FlexGrid;

package/lib-module/FlexGrid/Row/Row.js

@@ -0,0 +1,184 @@
+import React, { forwardRef } 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 { viewports } from '@telus-uds/system-constants';
+import { useViewport } from '../../ViewportProvider';
+import applyInheritance from '../helpers';
+import { jsx as _jsx } from "react/jsx-runtime";
+
+const horizontalAlignStyles = horizontalAlign => {
+  switch (horizontalAlign) {
+    case 'start':
+      return {
+        justifyContent: 'flex-start',
+        textAlign: 'left'
+      };
+
+    case 'center':
+      return {
+        justifyContent: 'center',
+        textAlign: 'center'
+      };
+
+    case 'end':
+      return {
+        justifyContent: 'flex-end',
+        textAlign: 'right'
+      };
+
+    default:
+      return {};
+  }
+};
+
+const verticalAlignStyles = verticalAlign => {
+  switch (verticalAlign) {
+    case 'top':
+      return {
+        alignItems: 'flex-start'
+      };
+
+    case 'middle':
+      return {
+        alignItems: 'center'
+      };
+
+    case 'bottom':
+      return {
+        alignItems: 'flex-end'
+      };
+
+    default:
+      return {};
+  }
+};
+
+const distributeStyles = distribute => {
+  switch (distribute) {
+    case 'between':
+      return {
+        justifyContent: 'space-between'
+      };
+
+    case 'around':
+      return {
+        justifyContent: 'space-around'
+      };
+
+    default:
+      return {};
+  }
+};
+
+const Row = /*#__PURE__*/forwardRef((_ref, ref) => {
+  let {
+    horizontalAlign,
+    verticalAlign,
+    distribute,
+    xsReverse,
+    smReverse,
+    mdReverse,
+    lgReverse,
+    xlReverse,
+    children,
+    ...rest
+  } = _ref;
+  const viewPort = useViewport();
+  const reverseLevel = applyInheritance([xsReverse, smReverse, mdReverse, lgReverse, xlReverse]);
+  let flexDirection = '';
+  let flexWrap = '';
+
+  if (viewPort === viewports.xs) {
+    flexDirection = reverseLevel[0] ? 'row-reverse' : 'row';
+    flexWrap = reverseLevel[0] ? 'wrap-reverse' : 'wrap';
+  }
+
+  if (viewPort === viewports.sm) {
+    flexDirection = reverseLevel[1] ? 'row-reverse' : 'row';
+    flexWrap = reverseLevel[1] ? 'wrap-reverse' : 'wrap';
+  }
+
+  if (viewPort === viewports.md) {
+    flexDirection = reverseLevel[2] ? 'row-reverse' : 'row';
+    flexWrap = reverseLevel[2] ? 'wrap-reverse' : 'wrap';
+  }
+
+  if (viewPort === viewports.lg) {
+    flexDirection = reverseLevel[3] ? 'row-reverse' : 'row';
+    flexWrap = reverseLevel[3] ? 'wrap-reverse' : 'wrap';
+  }
+
+  if (viewPort === viewports.xl) {
+    flexDirection = reverseLevel[4] ? 'row-reverse' : 'row';
+    flexWrap = reverseLevel[4] ? 'wrap-reverse' : 'wrap';
+  }
+
+  return /*#__PURE__*/_jsx(View, {
+    ref: ref,
+    ...rest,
+    style: [styles.row, {
+      flexDirection,
+      flexWrap,
+      ...horizontalAlignStyles(horizontalAlign),
+      ...verticalAlignStyles(verticalAlign),
+      ...distributeStyles(distribute)
+    }],
+    children: children
+  });
+});
+Row.displayName = 'Row';
+const styles = StyleSheet.create({
+  row: {
+    width: '100%',
+    marginVertical: 0,
+    marginHorizontal: 'auto',
+    flexGrow: 0,
+    flexShrink: 1,
+    flexBasis: 'auto',
+    flexDirection: 'row'
+  }
+});
+Row.propTypes = {
+  /**
+   * Align columns horizontally within their row.
+   */
+  horizontalAlign: PropTypes.oneOf(['start', 'center', 'end']),
+
+  /**
+   * Align columns vertically within their row.
+   */
+  verticalAlign: PropTypes.oneOf(['top', 'middle', 'bottom']),
+
+  /**
+   * Distribute empty space around columns.
+   */
+  distribute: PropTypes.oneOf(['around', 'between']),
+
+  /**
+   * Choose if the item order should be reversed from the 'xs' breakpoint. When you pass in false, the order will be normal from the xs breakpoint. By default, it inherits the behaviour set by the preceding prop.
+   */
+  xsReverse: PropTypes.bool,
+
+  /**
+   * Choose if the item order should be reversed from the 'sm' breakpoint. When you pass in false, the order will be normal from the sm breakpoint. By default, it inherits the behaviour set by the preceding prop.
+   */
+  smReverse: PropTypes.bool,
+
+  /**
+   * Choose if the item order should be reversed from the 'md' breakpoint. When you pass in false, the order will be normal from the md breakpoint. By default, it inherits the behaviour set by the preceding prop.
+   */
+  mdReverse: PropTypes.bool,
+
+  /**
+   * Choose if the item order should be reversed from the 'lg' breakpoint. When you pass in false, the order will be normal from the lg breakpoint. By default, it inherits the behaviour set by the preceding prop.
+   */
+  lgReverse: PropTypes.bool,
+
+  /**
+   * Choose if the item order should be reversed from the 'xl' breakpoint. When you pass in false, the order will be normal from the xl breakpoint. By default, it inherits the behaviour set by the preceding prop.
+   */
+  xlReverse: PropTypes.bool,
+  children: PropTypes.node.isRequired
+};
+export default Row;

package/lib-module/FlexGrid/Row/index.js

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

package/lib-module/FlexGrid/helpers/index.js

@@ -0,0 +1,18 @@
+const applyInheritance = sizes => {
+  let prevSize;
+  return sizes.map((size, index) => {
+    if (size !== undefined) {
+      prevSize = size;
+      return size;
+    }
+
+    if (index) {
+      const value = prevSize;
+      return value;
+    }
+
+    return undefined;
+  });
+};
+
+export default applyInheritance;

package/lib-module/FlexGrid/index.js

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

package/lib-module/FlexGrid/providers/GutterContext.js

@@ -0,0 +1,3 @@
+import React from 'react';
+const GutterContext = /*#__PURE__*/React.createContext(false);
+export default GutterContext;