Merge branch 'main' into slots-layout-effect

iansan5653 · web-flow · commit b5dbe134b275 · 2022-08-04T20:48:56.000-04:00
diff --git a/.changeset/red-wombats-whisper.md b/.changeset/red-wombats-whisper.md
@@ -0,0 +1,5 @@
+---
+"@primer/react": patch
+---
+
+Replace `useCombinedRefs` with `useRefObjectAsForwardedRef`
diff --git a/.github/workflows/deploy_preview.yml b/.github/workflows/deploy_preview.yml
@@ -9,13 +9,18 @@ permissions:
 
 jobs:
   deploy-preview:
-    if: ${{ github.repository == 'primer/react' }}
+    # if the source repository for pull request is a fork, we don't want to run this workflow,
+    # we run deploy_preview_forks.yml which uses pull_request_target instead.
+    # see https://github.com/primer/react/pull/2207 for details
+    if: ${{ github.event.pull_request.head.repo.full_name == 'primer/react' }} # source repository for pull_request
     name: Preview
     uses: primer/.github/.github/workflows/deploy_preview.yml@main
     permissions:
       contents: read
       pages: write
       id-token: write
+    secrets:
+      gh_token: ${{ secrets.GITHUB_TOKEN }}
     with:
       node_version: 14
       install: npm ci && cd docs && npm ci && cd ..
diff --git a/.github/workflows/deploy_preview_forks.yml b/.github/workflows/deploy_preview_forks.yml
@@ -0,0 +1,23 @@
+name: Deploy (fork)
+on:
+  pull_request_target:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy-preview:
+    if: ${{ github.repository == 'primer/react' }} # target repository for pull_request
+    name: Preview
+    uses: primer/.github/.github/workflows/deploy_preview.yml@main
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    with:
+      node_version: 14
+      install: npm ci && cd docs && npm ci && cd ..
+      build: npm run build:docs:preview
+      output_dir: docs/public
diff --git a/.github/workflows/deploy_production.yml b/.github/workflows/deploy_production.yml
@@ -37,6 +37,8 @@ jobs:
     needs: [guard]
     if: ${{ needs.guard.outputs.should_deploy == 'true' }}
     uses: primer/.github/.github/workflows/deploy.yml@main
+    secrets:
+      gh_token: ${{ secrets.GITHUB_TOKEN }}
     with:
       node_version: 14
       install: npm ci && cd docs && npm ci && cd ..
diff --git a/docs/content/ActionMenu.mdx b/docs/content/ActionMenu.mdx
@@ -72,7 +72,7 @@ import {ActionMenu} from '@primer/react'
 
 ### With a custom anchor
 
-You can choose to have a different _anchor_ for the Menu dependending on the application's context.
+You can choose to have a different _anchor_ for the Menu depending on the application's context.
 
 &nbsp;
 
diff --git a/docs/content/Autocomplete.mdx b/docs/content/Autocomplete.mdx
@@ -314,7 +314,7 @@ render(<CustomSortAfterMenuClose />)
 
 #### Custom filtering
 
-In this example, we show any items who's `text` **contains** the input value. By default, we only show items that start with the input value.
+In this example, we show any items whose `text` **contains** the input value. By default, we only show items that start with the input value.
 
 ```javascript live noinline
 const CustomSearchFilter = () => {
diff --git a/docs/content/FormControl.mdx b/docs/content/FormControl.mdx
@@ -350,7 +350,7 @@ render(ValidationExample)
 
 ### FormControl
 
-The container that handles the layout and passes the relevant IDs and ARIA attributes it's children.
+The container that handles the layout and passes the relevant IDs and ARIA attributes its children.
 
 <PropsTable>
   <PropsTableRow
diff --git a/docs/content/drafts/Dialog.mdx b/docs/content/drafts/Dialog.mdx
@@ -10,7 +10,7 @@ import {Dialog} from '@primer/react/drafts'
 
 import State from '../../components/State'
 
-The dialog component the Primer implementation of the ARIA design pattern [Dialog](https://www.w3.org/TR/wai-aria-practices-1.1/#dialog_modal). A dialog is a type of overlay that can be used for confirming actions, asking for disambiguation, and presenting small forms. They generally allow the user to focus on a quick task without having to navigate to a different page.
+The dialog component is the Primer implementation of the ARIA design pattern [Dialog](https://www.w3.org/TR/wai-aria-practices-1.1/#dialog_modal). A dialog is a type of overlay that can be used for confirming actions, asking for disambiguation, and presenting small forms. They generally allow the user to focus on a quick task without having to navigate to a different page.
 
 **Dialogs appear in the page after a direct user interaction**. Don't show dialogs on page load or as system alerts.
 
diff --git a/src/Autocomplete/AutocompleteInput.tsx b/src/Autocomplete/AutocompleteInput.tsx
@@ -2,7 +2,6 @@ import React, {
   ChangeEventHandler,
   FocusEventHandler,
   KeyboardEventHandler,
-  MutableRefObject,
   useCallback,
   useContext,
   useEffect,
@@ -11,7 +10,7 @@ import React, {
 import {ForwardRefComponent as PolymorphicForwardRefComponent} from '@radix-ui/react-polymorphic'
 import {AutocompleteContext} from './AutocompleteContext'
 import TextInput from '../TextInput'
-import {useCombinedRefs} from '../hooks/useCombinedRefs'
+import {useRefObjectAsForwardedRef} from '../hooks/useRefObjectAsForwardedRef'
 import {ComponentProps} from '../utils/types'
 
 type InternalAutocompleteInputProps = {
@@ -39,7 +38,7 @@ const AutocompleteInput = React.forwardRef(
       setShowMenu,
       showMenu
     } = autocompleteContext
-    const combinedInputRef = useCombinedRefs(inputRef, forwardedRef)
+    useRefObjectAsForwardedRef(forwardedRef, inputRef)
     const [highlightRemainingText, setHighlightRemainingText] = useState<boolean>(true)
 
     const handleInputFocus: FocusEventHandler<HTMLInputElement> = useCallback(
@@ -58,12 +57,12 @@ const AutocompleteInput = React.forwardRef(
         // this prevents the menu from hiding when the user is clicking an option in the Autoselect.Menu,
         // but still hides the menu when the user blurs the input by tabbing out or clicking somewhere else on the page
         setTimeout(() => {
-          if (document.activeElement !== combinedInputRef.current) {
+          if (document.activeElement !== inputRef.current) {
             setShowMenu(false)
           }
         }, 0)
       },
-      [onBlur, setShowMenu, combinedInputRef]
+      [onBlur, setShowMenu, inputRef]
     )
 
     const handleInputChange: ChangeEventHandler<HTMLInputElement> = useCallback(
@@ -157,7 +156,7 @@ const AutocompleteInput = React.forwardRef(
         onKeyDown={handleInputKeyDown}
         onKeyPress={onInputKeyPress}
         onKeyUp={handleInputKeyUp}
-        ref={combinedInputRef as MutableRefObject<HTMLInputElement>}
+        ref={inputRef}
         aria-controls={`${id}-listbox`}
         aria-autocomplete="both"
         role="combobox"
diff --git a/src/Autocomplete/AutocompleteOverlay.tsx b/src/Autocomplete/AutocompleteOverlay.tsx
@@ -3,7 +3,7 @@ import {useAnchoredPosition} from '../hooks'
 import Overlay, {OverlayProps} from '../Overlay'
 import {ComponentProps} from '../utils/types'
 import {AutocompleteContext} from './AutocompleteContext'
-import {useCombinedRefs} from '../hooks/useCombinedRefs'
+import {useRefObjectAsForwardedRef} from '../hooks/useRefObjectAsForwardedRef'
 
 type AutocompleteOverlayInternalProps = {
   /**
@@ -39,7 +39,7 @@ function AutocompleteOverlay({
     [showMenu, selectedItemLength]
   )
 
-  const combinedOverlayRef = useCombinedRefs(scrollContainerRef, floatingElementRef)
+  useRefObjectAsForwardedRef(scrollContainerRef, floatingElementRef)
 
   const closeOptionList = useCallback(() => {
     setShowMenu(false)
@@ -55,7 +55,7 @@ function AutocompleteOverlay({
       preventFocusOnOpen={true}
       onClickOutside={closeOptionList}
       onEscape={closeOptionList}
-      ref={combinedOverlayRef as React.RefObject<HTMLDivElement>}
+      ref={floatingElementRef as React.RefObject<HTMLDivElement>}
       top={position?.top}
       left={position?.left}
       visibility={showMenu ? 'visible' : 'hidden'}
diff --git a/src/Dialog.tsx b/src/Dialog.tsx
@@ -7,7 +7,7 @@ import useDialog from './hooks/useDialog'
 import sx, {SxProp} from './sx'
 import Text from './Text'
 import {ComponentProps} from './utils/types'
-import {useCombinedRefs} from './hooks/useCombinedRefs'
+import {useRefObjectAsForwardedRef} from './hooks/useRefObjectAsForwardedRef'
 
 const noop = () => null
 
@@ -95,7 +95,8 @@ type InternalDialogProps = {
 const Dialog = forwardRef<HTMLDivElement, InternalDialogProps>(
   ({children, onDismiss = noop, isOpen, initialFocusRef, returnFocusRef, ...props}, forwardedRef) => {
     const overlayRef = useRef(null)
-    const modalRef = useCombinedRefs(forwardedRef)
+    const modalRef = useRef<HTMLDivElement>(null)
+    useRefObjectAsForwardedRef(forwardedRef, modalRef)
     const closeButtonRef = useRef(null)
 
     const onCloseClick = () => {
diff --git a/src/Dialog/Dialog.tsx b/src/Dialog/Dialog.tsx
@@ -11,7 +11,7 @@ import {XIcon} from '@primer/octicons-react'
 import {useFocusZone} from '../hooks/useFocusZone'
 import {FocusKeys} from '@primer/behaviors'
 import Portal from '../Portal'
-import {useCombinedRefs} from '../hooks/useCombinedRefs'
+import {useRefObjectAsForwardedRef} from '../hooks/useRefObjectAsForwardedRef'
 import {useSSRSafeId} from '@react-aria/ssr'
 
 const ANIMATION_DURATION = '200ms'
@@ -274,7 +274,7 @@ const _Dialog = React.forwardRef<HTMLDivElement, React.PropsWithChildren<DialogP
   const defaultedProps = {...props, title, subtitle, role, dialogLabelId, dialogDescriptionId}
 
   const dialogRef = useRef<HTMLDivElement>(null)
-  const combinedRef = useCombinedRefs(dialogRef, forwardedRef)
+  useRefObjectAsForwardedRef(forwardedRef, dialogRef)
   const backdropRef = useRef<HTMLDivElement>(null)
   useFocusTrap({containerRef: dialogRef, restoreFocusOnCleanUp: true, initialFocusRef: autoFocusedFooterButtonRef})
 
@@ -297,7 +297,7 @@ const _Dialog = React.forwardRef<HTMLDivElement, React.PropsWithChildren<DialogP
           <StyledDialog
             width={width}
             height={height}
-            ref={combinedRef}
+            ref={dialogRef}
             role={role}
             aria-labelledby={dialogLabelId}
             aria-describedby={dialogDescriptionId}
diff --git a/src/Overlay.tsx b/src/Overlay.tsx
@@ -6,7 +6,7 @@ import {AriaRole, Merge} from './utils/types'
 import {useOverlay, TouchOrMouseEvent} from './hooks'
 import Portal from './Portal'
 import sx, {SxProp} from './sx'
-import {useCombinedRefs} from './hooks/useCombinedRefs'
+import {useRefObjectAsForwardedRef} from './hooks/useRefObjectAsForwardedRef'
 import type {AnchorSide} from '@primer/behaviors'
 import {useTheme} from './ThemeProvider'
 import {ForwardRefComponent as PolymorphicForwardRefComponent} from '@radix-ui/react-polymorphic'
@@ -142,7 +142,7 @@ const Overlay = React.forwardRef<HTMLDivElement, OwnOverlayProps>(
     forwardedRef
   ): ReactElement => {
     const overlayRef = useRef<HTMLDivElement>(null)
-    const combinedRef = useCombinedRefs(overlayRef, forwardedRef)
+    useRefObjectAsForwardedRef(forwardedRef, overlayRef)
     const {theme} = useTheme()
     const slideAnimationDistance = parseInt(get('space.2')(theme).replace('px', ''))
     const slideAnimationEasing = get('animation.easeOutCubic')(theme)
@@ -158,10 +158,10 @@ const Overlay = React.forwardRef<HTMLDivElement, OwnOverlayProps>(
     })
 
     useEffect(() => {
-      if (height === 'initial' && combinedRef.current?.clientHeight) {
-        combinedRef.current.style.height = `${combinedRef.current.clientHeight}px`
+      if (height === 'initial' && overlayRef.current?.clientHeight) {
+        overlayRef.current.style.height = `${overlayRef.current.clientHeight}px`
       }
-    }, [height, combinedRef])
+    }, [height])
 
     useLayoutEffect(() => {
       const {x, y} = getSlideAnimationStartingVector(anchorSide)
@@ -185,7 +185,7 @@ const Overlay = React.forwardRef<HTMLDivElement, OwnOverlayProps>(
           height={height}
           role={role}
           {...rest}
-          ref={combinedRef}
+          ref={overlayRef}
           style={
             {
               top: `${top || 0}px`,
diff --git a/src/TextInputWithTokens.tsx b/src/TextInputWithTokens.tsx
@@ -3,8 +3,7 @@ import {isFocusable} from '@primer/behaviors/utils'
 import {omit} from '@styled-system/props'
 import React, {FocusEventHandler, KeyboardEventHandler, MouseEventHandler, RefObject, useRef, useState} from 'react'
 import Box from './Box'
-import {useProvidedRefOrCreate} from './hooks'
-import {useCombinedRefs} from './hooks/useCombinedRefs'
+import {useRefObjectAsForwardedRef} from './hooks/useRefObjectAsForwardedRef'
 import {useFocusZone} from './hooks/useFocusZone'
 import Text from './Text'
 import {TextInputProps} from './TextInput'
@@ -93,12 +92,11 @@ function TextInputWithTokensInnerComponent<TokenComponentType extends AnyReactCo
     visibleTokenCount,
     ...rest
   }: TextInputWithTokensProps<TokenComponentType>,
-  externalRef: React.ForwardedRef<HTMLInputElement>
+  forwardedRef: React.ForwardedRef<HTMLInputElement>
 ) {
   const {onBlur, onFocus, onKeyDown, ...inputPropsRest} = omit(rest)
-  const ref = useProvidedRefOrCreate<HTMLInputElement>(externalRef as React.RefObject<HTMLInputElement>)
-  const localInputRef = useRef<HTMLInputElement>(null)
-  const combinedInputRef = useCombinedRefs(localInputRef, ref)
+  const ref = useRef<HTMLInputElement>(null)
+  useRefObjectAsForwardedRef(forwardedRef, ref)
   const [selectedTokenIndex, setSelectedTokenIndex] = useState<number | undefined>()
   const [tokensAreTruncated, setTokensAreTruncated] = useState<boolean>(Boolean(visibleTokenCount))
   const {containerRef} = useFocusZone(
@@ -124,7 +122,7 @@ function TextInputWithTokensInnerComponent<TokenComponentType extends AnyReactCo
         }
 
         if (nextIndex > tokens.length || nextIndex < 1) {
-          return combinedInputRef.current || undefined
+          return ref.current || undefined
         }
 
         return containerRef.current?.children[nextIndex] as HTMLElement
@@ -230,7 +228,7 @@ function TextInputWithTokensInnerComponent<TokenComponentType extends AnyReactCo
   }
 
   const focusInput: MouseEventHandler = () => {
-    combinedInputRef.current?.focus()
+    ref.current?.focus()
   }
 
   const preventTokenClickPropagation: MouseEventHandler = event => {
@@ -323,7 +321,7 @@ function TextInputWithTokensInnerComponent<TokenComponentType extends AnyReactCo
           }}
         >
           <UnstyledTextInput
-            ref={combinedInputRef}
+            ref={ref}
             disabled={disabled}
             onFocus={handleInputFocus}
             onBlur={handleInputBlur}
diff --git a/src/drafts/InlineAutocomplete/InlineAutocomplete.tsx b/src/drafts/InlineAutocomplete/InlineAutocomplete.tsx
@@ -1,6 +1,5 @@
 import React, {cloneElement, useRef} from 'react'
 import Box from '../../Box'
-import {useCombinedRefs} from '../../hooks/useCombinedRefs'
 import {useSyntheticChange} from '../hooks/useSyntheticChange'
 import Portal from '../../Portal'
 import {BetterSystemStyleObject} from '../../sx'
@@ -14,6 +13,7 @@ import {
   requireChildrenToBeInput
 } from './utils'
 import AutocompleteSuggestions from './_AutocompleteSuggestions'
+import {useRefObjectAsForwardedRef} from '../../hooks'
 
 export type InlineAutocompleteProps = {
   /** Register the triggers that can cause suggestions to appear. */
@@ -86,7 +86,9 @@ const InlineAutocomplete = ({
   // Forward accessibility props so it works with FormControl
   ...forwardProps
 }: InlineAutocompleteProps & React.ComponentProps<'textarea' | 'input'>) => {
-  const inputRef = useCombinedRefs(children.ref)
+  const inputRef = useRef<HTMLInputElement & HTMLTextAreaElement>(null)
+  useRefObjectAsForwardedRef(children.ref ?? noop, inputRef)
+
   const externalInput = requireChildrenToBeInput(children, inputRef)
 
   const emitSyntheticChange = useSyntheticChange({
diff --git a/src/hooks/index.ts b/src/hooks/index.ts
@@ -13,3 +13,4 @@ export {useProvidedStateOrCreate} from './useProvidedStateOrCreate'
 export {useMenuInitialFocus} from './useMenuInitialFocus'
 export {useMenuKeyboardNavigation} from './useMenuKeyboardNavigation'
 export {useMnemonics} from './useMnemonics'
+export {useRefObjectAsForwardedRef} from './useRefObjectAsForwardedRef'
diff --git a/src/hooks/useCombinedRefs.ts b/src/hooks/useCombinedRefs.ts
diff --git a/src/hooks/useRefObjectAsForwardedRef.ts b/src/hooks/useRefObjectAsForwardedRef.ts
@@ -0,0 +1,12 @@
+import {ForwardedRef, RefObject, useImperativeHandle} from 'react'
+
+/**
+ * Use a ref object as the imperative handle for a forwarded ref. This can be used to
+ * synchronize the ref object with the forwarded ref and allow local access the reference
+ * instance with `.current`.
+ *
+ * **NOTE**: The `refObject` should be passed to the underlying element, NOT the `forwardedRef`.
+ */
+export function useRefObjectAsForwardedRef<T>(forwardedRef: ForwardedRef<T>, refObject: RefObject<T>): void {
+  useImperativeHandle<T | null, T | null>(forwardedRef, () => refObject.current)
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@primer/react": patch
 +---
++
 +Replace `useCombinedRefs` with `useRefObjectAsForwardedRef`