react-native-windows 0.75.4 → 0.76.0-preview.2

package/Libraries/Text/Text.js

@@ -8,8 +8,11 @@
  * @format
  */
 
+import type {TextStyleProp} from '../StyleSheet/StyleSheet';
+import type {____TextStyle_Internal as TextStyleInternal} from '../StyleSheet/StyleSheetTypes';
 import type {PressEvent} from '../Types/CoreEventTypes';
-import type {TextProps} from './TextProps';
+import type {NativeTextProps} from './TextNativeComponent';
+import type {PressRetentionOffset, TextProps} from './TextProps';
 
 import * as PressabilityDebug from '../Pressability/PressabilityDebug';
 import usePressability from '../Pressability/usePressability';
@@ -21,96 +24,351 @@ import {NativeText, NativeVirtualText} from './TextNativeComponent';
 import * as React from 'react';
 import {useContext, useMemo, useState} from 'react';
 
+type TextForwardRef = React.ElementRef<
+  typeof NativeText | typeof NativeVirtualText,
+>;
+
 /**
  * Text is the fundamental component for displaying text.
  *
  * @see https://reactnative.dev/docs/text
  */
-const Text: React.AbstractComponent<
-  TextProps,
-  React.ElementRef<typeof NativeText | typeof NativeVirtualText>,
-> = React.forwardRef((props: TextProps, forwardedRef) => {
-  const {
-    accessible,
-    accessibilityLabel,
-    accessibilityState,
-    allowFontScaling,
-    'aria-busy': ariaBusy,
-    'aria-checked': ariaChecked,
-    'aria-disabled': ariaDisabled,
-    'aria-expanded': ariaExpanded,
-    'aria-label': ariaLabel,
-    'aria-selected': ariaSelected,
-    ellipsizeMode,
-    disabled,
-    id,
-    nativeID,
-    numberOfLines,
-    onLongPress,
-    onPress,
-    onPressIn,
-    onPressOut,
-    onResponderGrant,
-    onResponderMove,
-    onResponderRelease,
-    onResponderTerminate,
-    onResponderTerminationRequest,
-    onStartShouldSetResponder,
-    pressRetentionOffset,
-    selectable,
-    selectionColor,
-    suppressHighlighting,
-    style,
-    ...restProps
-  } = props;
+const Text: React.AbstractComponent<TextProps, TextForwardRef> =
+  React.forwardRef(
+    (
+      {
+        accessible,
+        accessibilityLabel,
+        accessibilityState,
+        allowFontScaling,
+        'aria-busy': ariaBusy,
+        'aria-checked': ariaChecked,
+        'aria-disabled': ariaDisabled,
+        'aria-expanded': ariaExpanded,
+        'aria-label': ariaLabel,
+        'aria-selected': ariaSelected,
+        children,
+        ellipsizeMode,
+        disabled,
+        id,
+        nativeID,
+        numberOfLines,
+        onLongPress,
+        onPress,
+        onPressIn,
+        onPressOut,
+        onResponderGrant,
+        onResponderMove,
+        onResponderRelease,
+        onResponderTerminate,
+        onResponderTerminationRequest,
+        onStartShouldSetResponder,
+        pressRetentionOffset,
+        selectable,
+        selectionColor,
+        suppressHighlighting,
+        style,
+        ...restProps
+      }: TextProps,
+      forwardedRef,
+    ) => {
+      const _accessibilityLabel = ariaLabel ?? accessibilityLabel;
 
-  const [isHighlighted, setHighlighted] = useState(false);
+      let _accessibilityState: ?TextProps['accessibilityState'] =
+        accessibilityState;
+      if (
+        ariaBusy != null ||
+        ariaChecked != null ||
+        ariaDisabled != null ||
+        ariaExpanded != null ||
+        ariaSelected != null
+      ) {
+        if (_accessibilityState != null) {
+          _accessibilityState = {
+            busy: ariaBusy ?? _accessibilityState.busy,
+            checked: ariaChecked ?? _accessibilityState.checked,
+            disabled: ariaDisabled ?? _accessibilityState.disabled,
+            expanded: ariaExpanded ?? _accessibilityState.expanded,
+            selected: ariaSelected ?? _accessibilityState.selected,
+          };
+        } else {
+          _accessibilityState = {
+            busy: ariaBusy,
+            checked: ariaChecked,
+            disabled: ariaDisabled,
+            expanded: ariaExpanded,
+            selected: ariaSelected,
+          };
+        }
+      }
 
-  const _accessibilityLabel = ariaLabel ?? accessibilityLabel;
-
-  let _accessibilityState: ?TextProps['accessibilityState'] =
-    accessibilityState;
-  if (
-    ariaBusy != null ||
-    ariaChecked != null ||
-    ariaDisabled != null ||
-    ariaExpanded != null ||
-    ariaSelected != null
-  ) {
-    if (_accessibilityState != null) {
-      _accessibilityState = {
-        busy: ariaBusy ?? _accessibilityState.busy,
-        checked: ariaChecked ?? _accessibilityState.checked,
-        disabled: ariaDisabled ?? _accessibilityState.disabled,
-        expanded: ariaExpanded ?? _accessibilityState.expanded,
-        selected: ariaSelected ?? _accessibilityState.selected,
-      };
-    } else {
-      _accessibilityState = {
-        busy: ariaBusy,
-        checked: ariaChecked,
-        disabled: ariaDisabled,
-        expanded: ariaExpanded,
-        selected: ariaSelected,
-      };
-    }
-  }
+      const _accessibilityStateDisabled = _accessibilityState?.disabled;
+      const _disabled = disabled ?? _accessibilityStateDisabled;
 
-  const _accessibilityStateDisabled = _accessibilityState?.disabled;
-  const _disabled = disabled ?? _accessibilityStateDisabled;
+      const isPressable =
+        (onPress != null ||
+          onLongPress != null ||
+          onStartShouldSetResponder != null) &&
+        _disabled !== true;
 
-  const isPressable =
-    (onPress != null ||
-      onLongPress != null ||
-      onStartShouldSetResponder != null) &&
-    _disabled !== true;
+      // TODO: Move this processing to the view configuration.
+      const _selectionColor =
+        selectionColor == null ? null : processColor(selectionColor);
 
-  const initialized = useLazyInitialization(isPressable);
-  const config = useMemo(() => {
-    if (!initialized) {
-      return null;
-    }
+      let _style = style;
+      if (__DEV__) {
+        if (PressabilityDebug.isEnabled() && onPress != null) {
+          _style = [style, {color: 'magenta'}];
+        }
+      }
+
+      let _numberOfLines = numberOfLines;
+      if (_numberOfLines != null && !(_numberOfLines >= 0)) {
+        if (__DEV__) {
+          console.error(
+            `'numberOfLines' in <Text> must be a non-negative number, received: ${_numberOfLines}. The value will be set to 0.`,
+          );
+        }
+        _numberOfLines = 0;
+      }
+
+      let _selectable = selectable;
+
+      let processedStyle = flattenStyle<TextStyleProp>(_style);
+      if (processedStyle != null) {
+        let overrides: ?{...TextStyleInternal} = null;
+        if (typeof processedStyle.fontWeight === 'number') {
+          overrides = overrides || ({}: {...TextStyleInternal});
+          overrides.fontWeight =
+            // $FlowFixMe[incompatible-cast]
+            (processedStyle.fontWeight.toString(): TextStyleInternal['fontWeight']);
+        }
+
+        if (processedStyle.userSelect != null) {
+          _selectable = userSelectToSelectableMap[processedStyle.userSelect];
+          overrides = overrides || ({}: {...TextStyleInternal});
+          overrides.userSelect = undefined;
+        }
+
+        if (processedStyle.verticalAlign != null) {
+          overrides = overrides || ({}: {...TextStyleInternal});
+          overrides.textAlignVertical =
+            verticalAlignToTextAlignVerticalMap[processedStyle.verticalAlign];
+          overrides.verticalAlign = undefined;
+        }
+
+        if (overrides != null) {
+          // $FlowFixMe[incompatible-type]
+          _style = [_style, overrides];
+        }
+      }
+
+      const _nativeID = id ?? nativeID;
+
+      const hasTextAncestor = useContext(TextAncestor);
+      if (hasTextAncestor) {
+        if (isPressable) {
+          return (
+            <NativePressableVirtualText
+              ref={forwardedRef}
+              textProps={{
+                ...restProps,
+                accessibilityLabel: _accessibilityLabel,
+                accessibilityState: _accessibilityState,
+                nativeID: _nativeID,
+                numberOfLines: _numberOfLines,
+                selectable: _selectable,
+                selectionColor: _selectionColor,
+                style: _style,
+                disabled: disabled,
+                children,
+              }}
+              textPressabilityProps={{
+                onLongPress,
+                onPress,
+                onPressIn,
+                onPressOut,
+                onResponderGrant,
+                onResponderMove,
+                onResponderRelease,
+                onResponderTerminate,
+                onResponderTerminationRequest,
+                onStartShouldSetResponder,
+                pressRetentionOffset,
+                suppressHighlighting,
+              }}
+            />
+          );
+        }
+
+        return (
+          <NativeVirtualText
+            {...restProps}
+            accessibilityLabel={_accessibilityLabel}
+            accessibilityState={_accessibilityState}
+            isHighlighted={false}
+            isPressable={false}
+            nativeID={_nativeID}
+            numberOfLines={_numberOfLines}
+            ref={forwardedRef}
+            selectable={_selectable}
+            selectionColor={_selectionColor}
+            style={_style}
+            disabled={disabled}>
+            {children}
+          </NativeVirtualText>
+        );
+      }
+
+      // If the disabled prop and accessibilityState.disabled are out of sync but not both in
+      // falsy states we need to update the accessibilityState object to use the disabled prop.
+      if (
+        _disabled !== _accessibilityStateDisabled &&
+        ((_disabled != null && _disabled !== false) ||
+          (_accessibilityStateDisabled != null &&
+            _accessibilityStateDisabled !== false))
+      ) {
+        _accessibilityState = {..._accessibilityState, disabled: _disabled};
+      }
+
+      const _accessible = Platform.select({
+        ios: accessible !== false,
+        android:
+          accessible == null
+            ? onPress != null || onLongPress != null
+            : accessible,
+        default: accessible,
+      });
+
+      let nativeText = null;
+      if (isPressable) {
+        nativeText = (
+          <NativePressableText
+            ref={forwardedRef}
+            textProps={{
+              ...restProps,
+              accessibilityLabel: _accessibilityLabel,
+              accessibilityState: _accessibilityState,
+              accessible: _accessible,
+              allowFontScaling: allowFontScaling !== false,
+              disabled: _disabled,
+              ellipsizeMode: ellipsizeMode ?? 'tail',
+              nativeID: _nativeID,
+              numberOfLines: _numberOfLines,
+              selectable: _selectable,
+              selectionColor: _selectionColor,
+              style: _style,
+              children,
+            }}
+            textPressabilityProps={{
+              onLongPress,
+              onPress,
+              onPressIn,
+              onPressOut,
+              onResponderGrant,
+              onResponderMove,
+              onResponderRelease,
+              onResponderTerminate,
+              onResponderTerminationRequest,
+              onStartShouldSetResponder,
+              pressRetentionOffset,
+              suppressHighlighting,
+            }}
+          />
+        );
+      } else {
+        nativeText = (
+          <NativeText
+            {...restProps}
+            accessibilityLabel={_accessibilityLabel}
+            accessibilityState={_accessibilityState}
+            accessible={_accessible}
+            allowFontScaling={allowFontScaling !== false}
+            disabled={_disabled}
+            ellipsizeMode={ellipsizeMode ?? 'tail'}
+            isHighlighted={false}
+            nativeID={_nativeID}
+            numberOfLines={_numberOfLines}
+            ref={forwardedRef}
+            selectable={_selectable}
+            selectionColor={_selectionColor}
+            style={_style}>
+            {children}
+          </NativeText>
+        );
+      }
+
+      if (children == null) {
+        return nativeText;
+      }
+
+      // If the children do not contain a JSX element it would not be possible to have a
+      // nested `Text` component so we can skip adding the `TextAncestor` context wrapper
+      // which has a performance overhead. Since we do this for performance reasons we need
+      // to keep the check simple to avoid regressing overall perf. For this reason the
+      // `children.length` constant is set to `3`, this should be a reasonable tradeoff
+      // to capture the majority of `Text` uses but also not make this check too expensive.
+      if (Array.isArray(children) && children.length <= 3) {
+        let hasNonTextChild = false;
+        for (let child of children) {
+          if (child != null && typeof child === 'object') {
+            hasNonTextChild = true;
+            break;
+          }
+        }
+        if (!hasNonTextChild) {
+          return nativeText;
+        }
+      } else if (typeof children !== 'object') {
+        return nativeText;
+      }
+
+      return (
+        <TextAncestor.Provider value={true}>{nativeText}</TextAncestor.Provider>
+      );
+    },
+  );
+
+Text.displayName = 'Text';
 
+type TextPressabilityProps = $ReadOnly<{
+  onLongPress?: ?(event: PressEvent) => mixed,
+  onPress?: ?(event: PressEvent) => mixed,
+  onPressIn?: ?(event: PressEvent) => mixed,
+  onPressOut?: ?(event: PressEvent) => mixed,
+  onResponderGrant?: ?(event: PressEvent) => void,
+  onResponderMove?: ?(event: PressEvent) => void,
+  onResponderRelease?: ?(event: PressEvent) => void,
+  onResponderTerminate?: ?(event: PressEvent) => void,
+  onResponderTerminationRequest?: ?() => boolean,
+  onStartShouldSetResponder?: ?() => boolean,
+  pressRetentionOffset?: ?PressRetentionOffset,
+  suppressHighlighting?: ?boolean,
+}>;
+
+/**
+ * Hook that handles setting up Pressability of Text components.
+ *
+ * NOTE: This hook is relatively expensive so it should only be used absolutely necessary.
+ */
+function useTextPressability({
+  onLongPress,
+  onPress,
+  onPressIn,
+  onPressOut,
+  onResponderGrant,
+  onResponderMove,
+  onResponderRelease,
+  onResponderTerminate,
+  onResponderTerminationRequest,
+  onStartShouldSetResponder,
+  pressRetentionOffset,
+  suppressHighlighting,
+}: TextPressabilityProps) {
+  const [isHighlighted, setHighlighted] = useState(false);
+
+  // Setup pressability config and wrap callbacks needs to track the highlight state.
+  const config = useMemo(() => {
     let _onPressIn = onPressIn;
     let _onPressOut = onPressOut;
 
@@ -130,7 +388,7 @@ const Text: React.AbstractComponent<
     }
 
     return {
-      disabled: !isPressable,
+      disabled: false,
       pressRectOffset: pressRetentionOffset,
       onLongPress,
       onPress,
@@ -138,8 +396,6 @@ const Text: React.AbstractComponent<
       onPressOut: _onPressOut,
     };
   }, [
-    initialized,
-    isPressable,
     pressRetentionOffset,
     onLongPress,
     onPress,
@@ -148,7 +404,10 @@ const Text: React.AbstractComponent<
     suppressHighlighting,
   ]);
 
+  // Init the pressability class
   const eventHandlers = usePressability(config);
+
+  // Create NativeText event handlers which proxy events to pressability
   const eventHandlersForText = useMemo(
     () =>
       eventHandlers == null
@@ -199,128 +458,67 @@ const Text: React.AbstractComponent<
     ],
   );
 
-  // TODO: Move this processing to the view configuration.
-  const _selectionColor =
-    selectionColor == null ? null : processColor(selectionColor);
-
-  let _style = style;
-  if (__DEV__) {
-    if (PressabilityDebug.isEnabled() && onPress != null) {
-      _style = [style, {color: 'magenta'}];
-    }
-  }
+  // Return the highlight state and NativeText event handlers
+  return useMemo(
+    () => [isHighlighted, eventHandlersForText],
+    [isHighlighted, eventHandlersForText],
+  );
+}
 
-  let _numberOfLines = numberOfLines;
-  if (_numberOfLines != null && !(_numberOfLines >= 0)) {
-    if (__DEV__) {
-      console.error(
-        `'numberOfLines' in <Text> must be a non-negative number, received: ${_numberOfLines}. The value will be set to 0.`,
-      );
-    }
-    _numberOfLines = 0;
-  }
-
-  let _selectable = selectable;
-  const processedStyle = flattenStyle(_style);
-  if (processedStyle != null) {
-    if (typeof processedStyle.fontWeight === 'number') {
-      // $FlowFixMe[cannot-write]
-      processedStyle.fontWeight = processedStyle.fontWeight.toString();
-    }
+type NativePressableTextProps = $ReadOnly<{
+  textProps: NativeTextProps,
+  textPressabilityProps: TextPressabilityProps,
+}>;
 
-    if (processedStyle.userSelect != null) {
-      _selectable = userSelectToSelectableMap[processedStyle.userSelect];
-      // $FlowFixMe[cannot-write]
-      delete processedStyle.userSelect;
-    }
-
-    if (processedStyle.verticalAlign != null) {
-      // $FlowFixMe[cannot-write]
-      processedStyle.textAlignVertical =
-        verticalAlignToTextAlignVerticalMap[processedStyle.verticalAlign];
-      // $FlowFixMe[cannot-write]
-      delete processedStyle.verticalAlign;
-    }
-  }
-
-  const _nativeID = id ?? nativeID;
-
-  const hasTextAncestor = useContext(TextAncestor);
-  if (hasTextAncestor) {
-    return (
-      <NativeVirtualText
-        {...restProps}
-        {...eventHandlersForText}
-        accessibilityLabel={_accessibilityLabel}
-        accessibilityState={_accessibilityState}
-        isHighlighted={isHighlighted}
-        isPressable={isPressable}
-        nativeID={_nativeID}
-        numberOfLines={_numberOfLines}
-        ref={forwardedRef}
-        selectable={_selectable}
-        selectionColor={_selectionColor}
-        style={processedStyle}
-        disabled={disabled}
-      />
-    );
-  }
-
-  // If the disabled prop and accessibilityState.disabled are out of sync but not both in
-  // falsy states we need to update the accessibilityState object to use the disabled prop.
-  if (
-    _disabled !== _accessibilityStateDisabled &&
-    ((_disabled != null && _disabled !== false) ||
-      (_accessibilityStateDisabled != null &&
-        _accessibilityStateDisabled !== false))
-  ) {
-    _accessibilityState = {..._accessibilityState, disabled: _disabled};
-  }
-
-  const _accessible = Platform.select({
-    ios: accessible !== false,
-    android:
-      accessible == null ? onPress != null || onLongPress != null : accessible,
-    default: accessible,
-  });
+/**
+ * Wrap the NativeVirtualText component and initialize pressability.
+ *
+ * This logic is split out from the main Text component to enable the more
+ * expensive pressability logic to be only initialized when needed.
+ */
+const NativePressableVirtualText: React.AbstractComponent<
+  NativePressableTextProps,
+  TextForwardRef,
+> = React.forwardRef(({textProps, textPressabilityProps}, forwardedRef) => {
+  const [isHighlighted, eventHandlersForText] = useTextPressability(
+    textPressabilityProps,
+  );
 
   return (
-    <TextAncestor.Provider value={true}>
-      <NativeText
-        {...restProps}
-        {...eventHandlersForText}
-        accessibilityLabel={_accessibilityLabel}
-        accessibilityState={_accessibilityState}
-        accessible={_accessible}
-        allowFontScaling={allowFontScaling !== false}
-        disabled={_disabled}
-        ellipsizeMode={ellipsizeMode ?? 'tail'}
-        isHighlighted={isHighlighted}
-        nativeID={_nativeID}
-        numberOfLines={_numberOfLines}
-        ref={forwardedRef}
-        selectable={_selectable}
-        selectionColor={_selectionColor}
-        style={processedStyle}
-      />
-    </TextAncestor.Provider>
+    <NativeVirtualText
+      {...textProps}
+      {...eventHandlersForText}
+      isHighlighted={isHighlighted}
+      isPressable={true}
+      ref={forwardedRef}
+    />
   );
 });
 
-Text.displayName = 'Text';
-
 /**
- * Returns false until the first time `newValue` is true, after which this will
- * always return true. This is necessary to lazily initialize `Pressability` so
- * we do not eagerly create one for every pressable `Text` component.
+ * Wrap the NativeText component and initialize pressability.
+ *
+ * This logic is split out from the main Text component to enable the more
+ * expensive pressability logic to be only initialized when needed.
  */
-function useLazyInitialization(newValue: boolean): boolean {
-  const [oldValue, setValue] = useState(newValue);
-  if (!oldValue && newValue) {
-    setValue(newValue);
-  }
-  return oldValue;
-}
+const NativePressableText: React.AbstractComponent<
+  NativePressableTextProps,
+  TextForwardRef,
+> = React.forwardRef(({textProps, textPressabilityProps}, forwardedRef) => {
+  const [isHighlighted, eventHandlersForText] = useTextPressability(
+    textPressabilityProps,
+  );
+
+  return (
+    <NativeText
+      {...textProps}
+      {...eventHandlersForText}
+      isHighlighted={isHighlighted}
+      isPressable={true}
+      ref={forwardedRef}
+    />
+  );
+});
 
 const userSelectToSelectableMap = {
   auto: true,