@telus-uds/components-base 1.66.0 → 1.67.1

package/src/Modal/Modal.jsx

@@ -23,6 +23,7 @@ import { useViewport } from '../ViewportProvider'
 import IconButton from '../IconButton'
 import dictionary from './dictionary'
 import useScrollBlocking from '../utils/useScrollBlocking'
+import ModalContent from './ModalContent'
 
 const [selectProps, selectedSystemPropTypes] = selectSystemProps([a11yProps, viewProps])
 
@@ -57,7 +58,7 @@ const selectModalStyles = ({
   height,
   paddingLeft,
   paddingRight,
-  paddingTop,
+  paddingTop: Platform.OS !== 'web' ? 16 + paddingTop : paddingTop, // the 16 additions are due to the border that is present in the mobile version
   paddingBottom,
   ...applyShadowToken(shadow)
 })
@@ -69,7 +70,11 @@ const selectBackdropStyles = ({ backdropColor, backdropOpacity }) => ({
 
 const selectCloseButtonContainerStyles = ({ paddingRight, paddingTop }) => ({
   paddingRight,
-  paddingTop
+  paddingTop: Platform.OS !== 'web' ? 24 + paddingTop : paddingTop // The 24 additions are due to the border that is present in the mobile version for the close button
+})
+
+const selectScrollViewStyles = () => ({
+  flex: 1
 })
 
 /**
@@ -87,7 +92,31 @@ const selectCloseButtonContainerStyles = ({ paddingRight, paddingTop }) => ({
  * - Don’t use modals consecutively
  */
 const Modal = forwardRef(
-  ({ children, isOpen, onClose, maxWidth, tokens, variant, copy, closeButton, ...rest }, ref) => {
+  (
+    {
+      children,
+      isOpen,
+      onClose,
+      maxWidth,
+      tokens,
+      copy,
+      closeButton,
+      onCancel = onClose,
+      onConfirm,
+      heading,
+      headingLevel,
+      subHeading,
+      subHeadingSize,
+      bodyText,
+      variant = {},
+      confirmButtonText,
+      confirmButtonVariant,
+      cancelButtonText,
+      cancelButtonType,
+      ...rest
+    },
+    ref
+  ) => {
     const viewport = useViewport()
     const themeTokens = useThemeTokens('Modal', tokens, variant, { viewport, maxWidth })
     const modalRef = useScrollBlocking(isOpen)
@@ -142,7 +171,27 @@ const Modal = forwardRef(
                   )}
                 </View>
               )}
-              {children}
+              <ModalContent
+                tokens={tokens}
+                variant={variant}
+                onCancel={onCancel}
+                onConfirm={onConfirm}
+                heading={heading}
+                headingLevel={headingLevel}
+                subHeading={subHeading}
+                subHeadingSize={subHeadingSize}
+                bodyText={bodyText}
+                confirmButtonText={confirmButtonText}
+                confirmButtonVariant={confirmButtonVariant}
+                cancelButtonText={cancelButtonText}
+                cancelButtonType={cancelButtonType}
+              >
+                {Platform !== 'web' ? (
+                  <ScrollView style={selectScrollViewStyles}>{children}</ScrollView>
+                ) : (
+                  { children }
+                )}
+              </ModalContent>
             </View>
           </View>
           {/* when a modal becomes open its first focusable element is being automatically focused */}
@@ -181,7 +230,51 @@ Modal.propTypes = {
   /**
    * Pass a react node to override the default close button or pass `null` to hide the close button.
    */
-  closeButton: PropTypes.node
+  closeButton: PropTypes.node,
+  /**
+   * Receive a string to set the heading of the modal.
+   */
+  heading: PropTypes.string,
+  /**
+   * Receive h3 or h4 to define the level of the heading.
+   */
+  headingLevel: PropTypes.oneOf(['h3', 'h4']),
+  /**
+   * Receive a string to set the sub heading of the modal.
+   */
+  subHeading: PropTypes.string,
+  /**
+   * Receive small, medium or large to set the size of the sub heading.
+   */
+  subHeadingSize: PropTypes.oneOf(['small', 'medium', 'large']),
+  /**
+   * Receive a string to set the bodyText of the modal.
+   */
+  bodyText: PropTypes.string,
+  /**
+   * Receive a string text for the confirm button.
+   */
+  confirmButtonText: PropTypes.string,
+  /**
+   * Receives a variant of button for the confirm button.
+   */
+  confirmButtonVariant: PropTypes.object,
+  /**
+   * Receive a function for the onConfirm event in the confirm button.
+   */
+  onConfirm: PropTypes.func,
+  /**
+   * Receive a string text for the cancel button.
+   */
+  cancelButtonText: PropTypes.string,
+  /**
+   * Receives a variant of button for the cancel button.
+   */
+  cancelButtonType: PropTypes.elementType, // TODO: figure out a way of passing an icon to the TextButton
+  /**
+   * Receive a function for the onCancel event in the cancel button.
+   */
+  onCancel: PropTypes.func
 }
 
 export default Modal

package/src/Modal/ModalContent.jsx

@@ -0,0 +1,171 @@
+import React, { useState } from 'react'
+import { View, StyleSheet, Platform } from 'react-native'
+import PropTypes from 'prop-types'
+import Box from '../Box'
+import { Button } from '../Button'
+import { TextButton } from '../Link'
+import Spacer from '../Spacer'
+import Typography from '../Typography'
+import { useThemeTokens } from '../ThemeProvider'
+import { useViewport } from '../ViewportProvider'
+
+const ModalContent = ({
+  heading,
+  headingLevel = 'h3',
+  subHeading,
+  subHeadingSize = 'medium',
+  bodyText,
+  confirmButtonText,
+  confirmButtonVariant = { priority: 'high' },
+  onConfirm,
+  tokens,
+  variant,
+  cancelButtonText,
+  cancelButtonType: CancelButton = TextButton,
+  children,
+  onCancel
+}) => {
+  const { headingColor, cancelButtonColor, ...themeTokens } = useThemeTokens(
+    'Modal',
+    tokens,
+    variant
+  )
+  const [scrollContainerHeight, setScrollContainerHeight] = useState(0)
+  const [scrollContentHeight, setScrollContentHeight] = useState(0)
+  const viewport = useViewport()
+
+  const handleContainerLayout = ({
+    nativeEvent: {
+      layout: { height }
+    }
+  }) => setScrollContainerHeight(height)
+  const onContentSizeChange = (_, height) => setScrollContentHeight(height)
+  const isContentOverflowing = scrollContentHeight > scrollContainerHeight
+
+  const hasConfirmButton = confirmButtonText !== undefined && onConfirm !== undefined
+  const hasCancelButton = cancelButtonText !== undefined && onCancel !== undefined
+  const hasHeadingSection = Boolean(heading || subHeading)
+
+  const selectFooterContainerStyles = ({
+    paddingLeft,
+    paddingRight,
+    paddingTop,
+    marginLeft,
+    marginRight,
+    borderColor,
+    gap,
+    direction,
+    hasBorder
+  }) => ({
+    flexDirection: direction,
+    alignItems: 'center',
+    gap,
+    marginLeft: -marginLeft,
+    marginRight: -marginRight,
+    paddingLeft,
+    paddingRight,
+    paddingTop,
+    borderTopColor: hasBorder ? borderColor : 'transparent',
+    borderTopWidth: hasBorder ? 1 : 0
+  })
+
+  const headingStyles = {
+    flexDirection: 'column',
+    paddingTop: 8,
+    paddingRight: themeTokens.headingPaddingRight
+  }
+
+  const subheadingStyles = {
+    marginTop: themeTokens.subHeadingMarginTop
+  }
+
+  return (
+    <View style={styles.modalContent}>
+      {hasHeadingSection && (
+        <View style={headingStyles}>
+          {heading && (
+            <Typography
+              variant={{ size: headingLevel }}
+              tokens={{ color: headingColor }}
+              heading={headingLevel}
+            >
+              {heading}
+            </Typography>
+          )}
+          {subHeading && (
+            <View style={subheadingStyles}>
+              <Typography variant={{ size: subHeadingSize }}>{subHeading}</Typography>
+            </View>
+          )}
+          {Boolean(bodyText && hasHeadingSection) && <Spacer space={3} />}
+        </View>
+      )}
+      {bodyText && (
+        <Box
+          scroll={{ onContentSizeChange, showsVerticalScrollIndicator: true }}
+          onLayout={handleContainerLayout}
+        >
+          <Typography>{bodyText}</Typography>
+        </Box>
+      )}
+      {children}
+      {(hasConfirmButton || hasCancelButton) && (
+        <View
+          style={[
+            selectFooterContainerStyles({
+              ...themeTokens,
+              hasBorder: isContentOverflowing
+            })
+          ]}
+        >
+          {hasConfirmButton && (
+            <Button
+              variant={confirmButtonVariant}
+              tokens={{ width: viewport === 'xs' || viewport === 'sm' ? '100%' : undefined }}
+              onPress={onConfirm}
+            >
+              {confirmButtonText}
+            </Button>
+          )}
+          {hasCancelButton ? (
+            <View style={styles.styledTextButtonContainer}>
+              <CancelButton tokens={{ color: cancelButtonColor }} onPress={onCancel}>
+                {cancelButtonText}
+              </CancelButton>
+            </View>
+          ) : null}
+        </View>
+      )}
+    </View>
+  )
+}
+
+const styles = StyleSheet.create({
+  modalContent: {
+    flex: 1,
+    flexDirection: 'column',
+    minHeight: Platform.OS === 'web' ? '100%' : 'auto'
+  },
+  styledTextButtonContainer: {
+    flex: 1
+  }
+})
+
+ModalContent.propTypes = {
+  tokens: PropTypes.object,
+  variant: PropTypes.object,
+  heading: PropTypes.string,
+  headingLevel: PropTypes.oneOf(['h3', 'h4']),
+  subHeading: PropTypes.string,
+  subHeadingSize: PropTypes.oneOf(['small', 'medium', 'large']),
+  bodyText: PropTypes.string,
+  confirmButtonText: PropTypes.string,
+  confirmButtonVariant: PropTypes.object,
+  onConfirm: PropTypes.func,
+  cancelButtonText: PropTypes.string,
+  cancelButtonType: PropTypes.elementType, // TODO: figure out a way of passing an icon to the TextButton
+  children: PropTypes.node,
+  onCancel: PropTypes.func
+}
+
+export default ModalContent

package/src/RadioCard/RadioCardGroup.jsx

@@ -99,10 +99,30 @@ const RadioCardGroup = forwardRef(
     ref
   ) => {
     const viewport = useViewport()
-    const { space, fieldSpace, direction } = useThemeTokens('RadioCardGroup', tokens, variant, {
+    const {
+      space,
+      fieldSpace,
+      direction,
+      showIcon,
+      outlineWidth,
+      borderTopLeftRadius,
+      borderTopRightRadius,
+      borderBottomLeftRadius,
+      borderBottomRightRadius,
+      outlineOffset
+    } = useThemeTokens('RadioCardGroup', tokens, variant, {
       viewport
     })
 
+    const borderTokens = {
+      outlineWidth,
+      borderTopLeftRadius,
+      borderTopRightRadius,
+      borderBottomLeftRadius,
+      borderBottomRightRadius,
+      outlineOffset
+    }
+
     const { currentValue, setValue } = useInputValue({
       value: checkedId,
       initialValue: initialCheckedId,
@@ -134,7 +154,8 @@ const RadioCardGroup = forwardRef(
         inactive={inactive || readOnly}
         validation={validation}
         showErrorBorder
-        showIcon
+        tokens={borderTokens}
+        showIcon={showIcon}
         accessibilityRole="radiogroup"
         {...selectProps(rest)}
       >

package/src/index.js

@@ -9,6 +9,7 @@ export { default as Listbox } from './Listbox'
 export { default as Checkbox } from './Checkbox'
 export * from './Checkbox'
 export { default as CheckboxCard } from './CheckboxCard'
+export { default as CheckboxCardGroup } from './CheckboxCardGroup'
 export { default as Divider } from './Divider'
 export { default as ExpandCollapse, Accordion } from './ExpandCollapse'
 export { default as Feedback } from './Feedback'