Use SSR-compatible slot implementation in CheckboxGroup/RadioGroup (#…

…3146) * Update slots for checkbox group and radio group * Update useSlot return type * Update exports test * Create .changeset/young-queens-notice.md * Update comment indentation
primer · Apr 10, 2023 · a19b721 · a19b721
1 parent d64b5c1
commit a19b721
Show file tree

Hide file tree

Showing 10 changed files with 126 additions and 131 deletions.
diff --git a/.changeset/young-queens-notice.md b/.changeset/young-queens-notice.md
@@ -0,0 +1,7 @@
+---
+"@primer/react": patch
+---
+
+`CheckboxGroup` and `RadioGroup` are now SSR-compatible. 
+
+Warning: In this new implementation, `CheckboxGroup.Caption`, `CheckboxGroup.Label,` and `CheckboxGroup.Validation` must be direct children of `CheckboxGroup`. The same applies to `RadioGroup`.
diff --git a/src/FormControl/FormControl.tsx b/src/FormControl/FormControl.tsx
@@ -16,7 +16,7 @@ import ValidationAnimationContainer from '../_ValidationAnimationContainer'
 import {get} from '../constants'
 import FormControlLeadingVisual from './_FormControlLeadingVisual'
 import {SxProp} from '../sx'
-import CheckboxOrRadioGroupContext from '../_CheckboxOrRadioGroup/_CheckboxOrRadioGroupContext'
+import {CheckboxOrRadioGroupContext} from '../_CheckboxOrRadioGroup'
 import InlineAutocomplete from '../drafts/InlineAutocomplete'
 
 export type FormControlProps = {
@@ -58,7 +58,7 @@ const FormControl = React.forwardRef<HTMLDivElement, FormControlProps>(
       InlineAutocomplete,
     ]
     const choiceGroupContext = useContext(CheckboxOrRadioGroupContext)
-    const disabled = choiceGroupContext?.disabled || disabledProp
+    const disabled = choiceGroupContext.disabled || disabledProp
     const id = useSSRSafeId(idProp)
     const validationChild = React.Children.toArray(children).find(child =>
       React.isValidElement(child) && child.type === FormControlValidation ? child : null,

diff --git a/src/_CheckboxOrRadioGroup/CheckboxOrRadioGroup.tsx b/src/_CheckboxOrRadioGroup/CheckboxOrRadioGroup.tsx
@@ -1,15 +1,14 @@
 import React from 'react'
+import styled from 'styled-components'
 import Box from '../Box'
-import {useSSRSafeId} from '../utils/ssr'
 import ValidationAnimationContainer from '../_ValidationAnimationContainer'
+import {get} from '../constants'
+import {useSSRSafeId} from '../utils/ssr'
 import CheckboxOrRadioGroupCaption from './_CheckboxOrRadioGroupCaption'
 import CheckboxOrRadioGroupLabel from './_CheckboxOrRadioGroupLabel'
 import CheckboxOrRadioGroupValidation from './_CheckboxOrRadioGroupValidation'
-import {Slots} from './slots'
-import styled from 'styled-components'
-import {get} from '../constants'
-import CheckboxOrRadioGroupContext from './_CheckboxOrRadioGroupContext'
 import VisuallyHidden from '../_VisuallyHidden'
+import {useSlots} from '../hooks/useSlots'
 import {SxProp} from '../sx'
 
 export type CheckboxOrRadioGroupProps = {
@@ -37,6 +36,8 @@ export type CheckboxOrRadioGroupContext = {
   captionId?: string
 } & CheckboxOrRadioGroupProps
 
+export const CheckboxOrRadioGroupContext = React.createContext<CheckboxOrRadioGroupContext>({})
+
 const Body = styled.div`
   display: flex;
   flex-direction: column;
@@ -57,6 +58,11 @@ const CheckboxOrRadioGroup: React.FC<React.PropsWithChildren<CheckboxOrRadioGrou
   required = false,
   sx,
 }) => {
+  const [slots, rest] = useSlots(children, {
+    caption: CheckboxOrRadioGroupCaption,
+    label: CheckboxOrRadioGroupLabel,
+    validation: CheckboxOrRadioGroupValidation,
+  })
   const labelChild = React.Children.toArray(children).find(
     child => React.isValidElement(child) && child.type === CheckboxOrRadioGroupLabel,
   )
@@ -67,8 +73,8 @@ const CheckboxOrRadioGroup: React.FC<React.PropsWithChildren<CheckboxOrRadioGrou
     React.isValidElement(child) && child.type === CheckboxOrRadioGroupCaption ? child : null,
   )
   const id = useSSRSafeId(idProp)
-  const validationMessageId = validationChild && `${id}-validationMessage`
-  const captionId = captionChild && `${id}-caption`
+  const validationMessageId = validationChild ? `${id}-validationMessage` : undefined
+  const captionId = captionChild ? `${id}-caption` : undefined
 
   if (!labelChild && !ariaLabelledby) {
     // eslint-disable-next-line no-console
@@ -77,79 +83,73 @@ const CheckboxOrRadioGroup: React.FC<React.PropsWithChildren<CheckboxOrRadioGrou
     )
   }
 
+  const isLegendVisible = React.isValidElement(labelChild) && !labelChild.props.visuallyHidden
+
   return (
-    <Slots
-      context={{
+    <CheckboxOrRadioGroupContext.Provider
+      value={{
         disabled,
         required,
         captionId,
         validationMessageId,
       }}
     >
-      {slots => {
-        const isLegendVisible = React.isValidElement(labelChild) && !labelChild.props.visuallyHidden
-
-        return (
-          <CheckboxOrRadioGroupContext.Provider value={{disabled}}>
-            <div>
-              <Box
-                border="none"
-                margin={0}
-                mb={validationChild ? 2 : undefined}
-                padding={0}
-                {...(labelChild && {
-                  as: 'fieldset',
-                  disabled,
-                })}
-                sx={sx}
-              >
-                {labelChild ? (
-                  /*
-                    Placing the caption text and validation text in the <legend> provides a better user
-                    experience for more screenreaders.
+      <div>
+        <Box
+          border="none"
+          margin={0}
+          mb={validationChild ? 2 : undefined}
+          padding={0}
+          {...(labelChild && {
+            as: 'fieldset',
+            disabled,
+          })}
+          sx={sx}
+        >
+          {labelChild ? (
+            /*
+              Placing the caption text and validation text in the <legend> provides a better user
+              experience for more screenreaders.
 
-                    Reference: https://blog.tenon.io/accessible-validation-of-checkbox-and-radiobutton-groups/
-                  */
-                  <Box as="legend" mb={isLegendVisible ? 2 : undefined} padding={0}>
-                    {slots.Label}
-                    {slots.Caption}
-                    {React.isValidElement(slots.Validation) && slots.Validation.props.children && (
-                      <VisuallyHidden>{slots.Validation.props.children}</VisuallyHidden>
-                    )}
-                  </Box>
-                ) : (
-                  /*
-                    If CheckboxOrRadioGroup.Label wasn't passed as a child, we don't render a <legend>
-                    but we still want to render a caption
-                  */
-                  slots.Caption
-                )}
-
-                <Body
-                  {...(!labelChild && {
-                    ['aria-labelledby']: ariaLabelledby,
-                    ['aria-describedby']: [validationMessageId, captionId].filter(Boolean).join(' '),
-                    as: 'div',
-                    role: 'group',
-                  })}
-                >
-                  {React.Children.toArray(children).filter(child => React.isValidElement(child))}
-                </Body>
-              </Box>
-              {validationChild && (
-                <ValidationAnimationContainer
-                  // If we have CheckboxOrRadioGroup.Label as a child, we render a screenreader-accessible validation message in the <legend>
-                  aria-hidden={Boolean(labelChild)}
-                  show
-                >
-                  {slots.Validation}
-                </ValidationAnimationContainer>
+              Reference: https://blog.tenon.io/accessible-validation-of-checkbox-and-radiobutton-groups/
+            */
+            <Box as="legend" mb={isLegendVisible ? 2 : undefined} padding={0}>
+              {slots.label}
+              {slots.caption}
+              {React.isValidElement(slots.validation) && slots.validation.props.children && (
+                <VisuallyHidden>{slots.validation.props.children}</VisuallyHidden>
               )}
-            </div>
-          </CheckboxOrRadioGroupContext.Provider>
-        )
-      }}
-    </Slots>
+            </Box>
+          ) : (
+            /*
+              If CheckboxOrRadioGroup.Label wasn't passed as a child, we don't render a <legend>
+              but we still want to render a caption
+            */
+            slots.caption
+          )}
+
+          <Body
+            {...(!labelChild && {
+              ['aria-labelledby']: ariaLabelledby,
+              ['aria-describedby']: [validationMessageId, captionId].filter(Boolean).join(' '),
+              as: 'div',
+              role: 'group',
+            })}
+          >
+            {React.Children.toArray(rest).filter(child => React.isValidElement(child))}
+          </Body>
+        </Box>
+        {validationChild && (
+          <ValidationAnimationContainer
+            // If we have CheckboxOrRadioGroup.Label as a child, we render a screenreader-accessible validation message in the <legend>
+            aria-hidden={Boolean(labelChild)}
+            show
+          >
+            {slots.validation}
+          </ValidationAnimationContainer>
+        )}
+      </div>
+    </CheckboxOrRadioGroupContext.Provider>
   )
 }
 

diff --git a/src/_CheckboxOrRadioGroup/_CheckboxOrRadioGroupCaption.tsx b/src/_CheckboxOrRadioGroup/_CheckboxOrRadioGroupCaption.tsx
@@ -2,16 +2,14 @@ import React from 'react'
 import Text from '../Text'
 import {SxProp} from '../sx'
 import {CheckboxOrRadioGroupContext} from './CheckboxOrRadioGroup'
-import {Slot} from './slots'
 
-const CheckboxOrRadioGroupCaption: React.FC<React.PropsWithChildren<SxProp>> = ({children, sx}) => (
-  <Slot name="Caption">
-    {({disabled, captionId}: CheckboxOrRadioGroupContext) => (
-      <Text color={disabled ? 'fg.muted' : 'fg.subtle'} fontSize={1} id={captionId} sx={sx}>
-        {children}
-      </Text>
-    )}
-  </Slot>
-)
+const CheckboxOrRadioGroupCaption: React.FC<React.PropsWithChildren<SxProp>> = ({children, sx}) => {
+  const {disabled, captionId} = React.useContext(CheckboxOrRadioGroupContext)
+  return (
+    <Text color={disabled ? 'fg.muted' : 'fg.subtle'} fontSize={1} id={captionId} sx={sx}>
+      {children}
+    </Text>
+  )
+}
 
 export default CheckboxOrRadioGroupCaption
diff --git a/src/_CheckboxOrRadioGroup/_CheckboxOrRadioGroupContext.tsx b/src/_CheckboxOrRadioGroup/_CheckboxOrRadioGroupContext.tsx
diff --git a/src/_CheckboxOrRadioGroup/_CheckboxOrRadioGroupLabel.tsx b/src/_CheckboxOrRadioGroup/_CheckboxOrRadioGroupLabel.tsx
@@ -1,9 +1,8 @@
 import React from 'react'
 import Box from '../Box'
-import {SxProp} from '../sx'
 import VisuallyHidden from '../_VisuallyHidden'
+import {SxProp} from '../sx'
 import {CheckboxOrRadioGroupContext} from './CheckboxOrRadioGroup'
-import {Slot} from './slots'
 
 export type CheckboxOrRadioGroupLabelProps = {
   /**
@@ -16,30 +15,29 @@ const CheckboxOrRadioGroupLabel: React.FC<React.PropsWithChildren<CheckboxOrRadi
   children,
   visuallyHidden = false,
   sx,
-}) => (
-  <Slot name="Label">
-    {({required, disabled}: CheckboxOrRadioGroupContext) => (
-      <VisuallyHidden
-        isVisible={!visuallyHidden}
-        title={required ? 'required field' : undefined}
-        sx={{
-          display: 'block',
-          color: disabled ? 'fg.muted' : undefined,
-          fontSize: 2,
-          ...sx,
-        }}
-      >
-        {required ? (
-          <Box display="flex" as="span">
-            <Box mr={1}>{children}</Box>
-            <span>*</span>
-          </Box>
-        ) : (
-          children
-        )}
-      </VisuallyHidden>
-    )}
-  </Slot>
-)
+}) => {
+  const {required, disabled} = React.useContext(CheckboxOrRadioGroupContext)
+  return (
+    <VisuallyHidden
+      isVisible={!visuallyHidden}
+      title={required ? 'required field' : undefined}
+      sx={{
+        display: 'block',
+        color: disabled ? 'fg.muted' : undefined,
+        fontSize: 2,
+        ...sx,
+      }}
+    >
+      {required ? (
+        <Box display="flex" as="span">
+          <Box mr={1}>{children}</Box>
+          <span>*</span>
+        </Box>
+      ) : (
+        children
+      )}
+    </VisuallyHidden>
+  )
+}
 
 export default CheckboxOrRadioGroupLabel
diff --git a/src/_CheckboxOrRadioGroup/_CheckboxOrRadioGroupValidation.tsx b/src/_CheckboxOrRadioGroup/_CheckboxOrRadioGroupValidation.tsx
@@ -3,7 +3,6 @@ import InputValidation from '../_InputValidation'
 import {SxProp} from '../sx'
 import {FormValidationStatus} from '../utils/types/FormValidationStatus'
 import {CheckboxOrRadioGroupContext} from './CheckboxOrRadioGroup'
-import {Slot} from './slots'
 
 export type CheckboxOrRadioGroupValidationProps = {
   /** Changes the visual style to match the validation status */
@@ -14,14 +13,13 @@ const CheckboxOrRadioGroupValidation: React.FC<React.PropsWithChildren<CheckboxO
   children,
   variant,
   sx,
-}) => (
-  <Slot name="Validation">
-    {({validationMessageId = ''}: CheckboxOrRadioGroupContext) => (
-      <InputValidation validationStatus={variant} id={validationMessageId} sx={sx}>
-        {children}
-      </InputValidation>
-    )}
-  </Slot>
-)
+}) => {
+  const {validationMessageId = ''} = React.useContext(CheckboxOrRadioGroupContext)
+  return (
+    <InputValidation validationStatus={variant} id={validationMessageId} sx={sx}>
+      {children}
+    </InputValidation>
+  )
+}
 
 export default CheckboxOrRadioGroupValidation
diff --git a/src/_CheckboxOrRadioGroup/index.ts b/src/_CheckboxOrRadioGroup/index.ts
@@ -1,2 +1,2 @@
-export {default} from './CheckboxOrRadioGroup'
+export {default, CheckboxOrRadioGroupContext} from './CheckboxOrRadioGroup'
 export type {CheckboxOrRadioGroupProps} from './CheckboxOrRadioGroup'
diff --git a/src/__tests__/CheckboxOrRadioGroup.test.tsx b/src/__tests__/CheckboxOrRadioGroup.test.tsx
@@ -3,7 +3,7 @@ import '@testing-library/jest-dom/extend-expect'
 import {render, within} from '@testing-library/react'
 import {Checkbox, FormControl, Radio, SSRProvider, TextInput} from '..'
 import {behavesAsComponent, checkExports} from '../utils/testing'
-import CheckboxOrRadioGroup from '../_CheckboxOrRadioGroup'
+import CheckboxOrRadioGroup, {CheckboxOrRadioGroupContext} from '../_CheckboxOrRadioGroup'
 
 const INPUT_GROUP_LABEL = 'Choices'
 
@@ -41,6 +41,7 @@ describe('CheckboxOrRadioGroup', () => {
   })
   checkExports('_CheckboxOrRadioGroup', {
     default: CheckboxOrRadioGroup,
+    CheckboxOrRadioGroupContext,
   })
   it('renders a group of inputs with a caption in the <legend>', () => {
     render(

diff --git a/src/hooks/useSlots.ts b/src/hooks/useSlots.ts
@@ -5,7 +5,7 @@ import {warning} from '../utils/warning'
 export type SlotConfig = Record<string, React.ComponentType<any>>
 
 type SlotElements<Type extends SlotConfig> = {
-  [Property in keyof Type]: React.ReactElement
+  [Property in keyof Type]: React.ReactElement<React.ComponentPropsWithoutRef<Type[Property]>, Type[Property]>
 }
 
 /**
@@ -52,7 +52,7 @@ export function useSlots<T extends SlotConfig>(
     }
 
     // If the child is a slot, add it to the `slots` object
-    slots[slotKey] = child
+    slots[slotKey] = child as React.ReactElement<React.ComponentPropsWithoutRef<T[keyof T]>, T[keyof T]>
   })
 
   return [slots, rest]