chore: Rename getEventTargets -> getPropagationTargets

Author: pzaczkiewicz-athenahealth

packages/@adobe/react-spectrum/src/menu/useCloseOnScroll.ts

@@ -13,7 +13,7 @@
 import {addEvent} from 'react-aria/private/utils/domHelpers';
 import {
   getEventTarget,
-  getEventTargets,
+  getPropagationTargets,
   nodeContains
 } from 'react-aria/private/utils/shadowdom/DOMFunctions';
 import {RefObject} from '@react-types/shared';
@@ -68,6 +68,6 @@ export function useCloseOnScroll(opts: CloseOnScrollOptions): void {
       }
     };
 
-    return addEvent(getEventTargets(window, triggerRef.current), 'scroll', onScroll, true);
+    return addEvent(getPropagationTargets(window, triggerRef.current), 'scroll', onScroll, true);
   }, [isOpen, onClose, triggerRef]);
 }

packages/react-aria/exports/domHelpers.ts

@@ -0,0 +1,6 @@
+export {
+  getOwnerDocument,
+  getOwnerWindow,
+  isShadowRoot,
+  addEvent
+} from '../src/utils/domHelpers';

packages/react-aria/exports/index.ts

@@ -157,6 +157,12 @@ export {useTooltipTrigger} from '../src/tooltip/useTooltipTrigger';
 export {useTree} from '../src/tree/useTree';
 export {useTreeItem} from '../src/tree/useTreeItem';
 export {chain} from '../src/utils/chain';
+export {
+  getOwnerDocument,
+  getOwnerWindow,
+  isShadowRoot,
+  addEvent
+} from '../src/utils/domHelpers'
 export {mergeProps} from '../src/utils/mergeProps';
 export {mergeRefs} from '../src/utils/mergeRefs';
 export {useId} from '../src/utils/useId';

packages/react-aria/exports/private/utils/shadowdom/DOMFunctions.ts

@@ -1,6 +1,6 @@
 export {
   getEventTarget,
-  getEventTargets,
+  getPropagationTargets,
   nodeContains,
   isFocusWithin,
   getActiveElement

packages/react-aria/src/overlays/useCloseOnScroll.ts

@@ -11,7 +11,7 @@
  */
 
 import {addEvent} from '../utils/domHelpers';
-import {getEventTarget, getEventTargets, nodeContains} from '../utils/shadowdom/DOMFunctions';
+import {getEventTarget, getPropagationTargets, nodeContains} from '../utils/shadowdom/DOMFunctions';
 import {RefObject} from '@react-types/shared';
 import {useEffect} from 'react';
 
@@ -61,6 +61,6 @@ export function useCloseOnScroll(opts: CloseOnScrollOptions): void {
       }
     };
 
-    return addEvent(getEventTargets(window, triggerRef.current), 'scroll', onScroll, true);
+    return addEvent(getPropagationTargets(window, triggerRef.current), 'scroll', onScroll, true);
   }, [isOpen, onClose, triggerRef]);
 }

packages/react-aria/src/utils/domHelpers.ts

@@ -39,11 +39,21 @@ export function isShadowRoot(node: Node | null): node is ShadowRoot {
  * Attaches an event listener on target(s) and returns a cleanup function.
  *
  * Some events are `composed: false` and do not propagate out of shadow roots,
- * even in the capture phase — notably `scroll` and `scrollend`. For those, a
- * listener on `window`/`document` alone will miss scrolls that happen inside a
- * shadow root. Pass the array from `getEventTargets(global, refNode)`
+ * even in the capture phase. For those, a listener on `window`/`document` alone
+ * will miss events that fire inside a shadow root. Pass the array from
+ * `getPropagationTargets(global, refNode)`
  * (react-aria/private/utils/shadowdom/DOMFunctions) as `target` so the listener
  * is attached to the global target *and* every enclosing shadow root.
+ *
+ * Known `composed: false` events (non-exhaustive):
+ * - `scroll`
+ * - `scrollend`
+ * - `change`
+ * - `submit`
+ * - `reset`
+ * - `select`
+ * - `selectstart`
+ * - `slotchange`
  */
 export function addEvent<T extends EventTarget, K extends keyof EventMapType<Exclude<T, null>>>(
   target: T | EventTarget[] | null,

packages/react-aria/src/utils/shadowdom/DOMFunctions.ts

@@ -90,10 +90,20 @@ export function getEventTarget<T extends Event | SyntheticEvent>(event: T): Even
  *
  * Returns `[global, ...shadowRoots]`, where shadowRoots are the ShadowRoots
  * enclosing `refNode` that lie between it and `global`. Needed for events that
- * don't compose (e.g. scroll, scrollend), which do not propagate out of shadow
- * roots even in the capture phase. Pass the result straight to `addEvent`.
+ * are `composed: false` and do not propagate out of shadow roots even in the
+ * capture phase. Pass the result straight to `addEvent` (react-aria/domHelpers).
+ *
+ * Known `composed: false` events (non-exhaustive):
+ * - `scroll`
+ * - `scrollend`
+ * - `change`
+ * - `submit`
+ * - `reset`
+ * - `select`
+ * - `selectstart`
+ * - `slotchange`
  */
-export function getEventTargets(
+export function getPropagationTargets(
   global: EventTarget,
   refNode: Node | null | undefined
 ): EventTarget[] {

packages/react-aria/src/virtualizer/ScrollView.tsx

@@ -12,7 +12,7 @@
 
 import {addEvent} from '../utils/domHelpers';
 import {flushSync} from 'react-dom';
-import {getEventTarget, getEventTargets, nodeContains} from '../utils/shadowdom/DOMFunctions';
+import {getEventTarget, getPropagationTargets, nodeContains} from '../utils/shadowdom/DOMFunctions';
 import {getScrollLeft} from './utils';
 import {Point, Rect, Size} from 'react-stately/useVirtualizerState';
 import React, {
@@ -221,7 +221,7 @@ export function useScrollView(
   // When inside a shadow DOM, also attach to each shadow root in the ancestor chain since scroll
   // events have composed: false and don't propagate out of shadow roots.
   useEffect(() => {
-    return addEvent(getEventTargets(document, ref.current), 'scroll', onScroll, true);
+    return addEvent(getPropagationTargets(document, ref.current), 'scroll', onScroll, true);
   }, [onScroll, ref]);
 
   useEffect(() => {