react-native-windows 0.78.7 → 0.79.0-preview.1

package/Libraries/Components/View/ViewPropTypes.js

@@ -15,26 +15,22 @@ import type {ViewStyleProp} from '../../StyleSheet/StyleSheet';
 import type {
   BlurEvent,
   FocusEvent,
-  Layout,
-  LayoutEvent,
+  LayoutChangeEvent,
+  LayoutRectangle,
   MouseEvent,
   PointerEvent,
-  PressEvent,
+  GestureResponderEvent,
 } from '../../Types/CoreEventTypes';
 import type {
   AccessibilityActionEvent,
-  AccessibilityActionInfo,
-  AccessibilityRole,
-  AccessibilityState,
-  AccessibilityValue,
-  Role,
+  AccessibilityProps,
 } from './ViewAccessibility';
 import type {Node} from 'react';
 
-export type ViewLayout = Layout;
-export type ViewLayoutEvent = LayoutEvent;
+export type ViewLayout = LayoutRectangle;
+export type ViewLayoutEvent = LayoutChangeEvent;
 
-type DirectEventProps = $ReadOnly<{|
+type DirectEventProps = $ReadOnly<{
   /**
    * When `accessible` is true, the system will try to invoke this function
    * when the user performs an accessibility custom action.
@@ -61,7 +57,7 @@ type DirectEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onlayout
    */
-  onLayout?: ?(event: LayoutEvent) => mixed,
+  onLayout?: ?(event: LayoutChangeEvent) => mixed,
 
   /**
    * When `accessible` is `true`, the system will invoke this function when the
@@ -78,15 +74,15 @@ type DirectEventProps = $ReadOnly<{|
    * See https://reactnative.dev/docs/view#onaccessibilityescape
    */
   onAccessibilityEscape?: ?() => mixed,
-|}>;
+}>;
 
-type MouseEventProps = $ReadOnly<{|
+type MouseEventProps = $ReadOnly<{
   onMouseEnter?: ?(event: MouseEvent) => void,
   onMouseLeave?: ?(event: MouseEvent) => void,
-|}>;
+}>;
 
 // Experimental/Work in Progress Pointer Event Callbacks (not yet ready for use)
-type PointerEventProps = $ReadOnly<{|
+type PointerEventProps = $ReadOnly<{
   onClick?: ?(event: PointerEvent) => void,
   onClickCapture?: ?(event: PointerEvent) => void,
   onPointerEnter?: ?(event: PointerEvent) => void,
@@ -109,32 +105,32 @@ type PointerEventProps = $ReadOnly<{|
   onGotPointerCaptureCapture?: ?(e: PointerEvent) => void,
   onLostPointerCapture?: ?(e: PointerEvent) => void,
   onLostPointerCaptureCapture?: ?(e: PointerEvent) => void,
-|}>;
+}>;
 
-type FocusEventProps = $ReadOnly<{|
+type FocusEventProps = $ReadOnly<{
   onBlur?: ?(event: BlurEvent) => void,
   onBlurCapture?: ?(event: BlurEvent) => void,
   onFocus?: ?(event: FocusEvent) => void,
   onFocusCapture?: ?(event: FocusEvent) => void,
-|}>;
-
-type TouchEventProps = $ReadOnly<{|
-  onTouchCancel?: ?(e: PressEvent) => void,
-  onTouchCancelCapture?: ?(e: PressEvent) => void,
-  onTouchEnd?: ?(e: PressEvent) => void,
-  onTouchEndCapture?: ?(e: PressEvent) => void,
-  onTouchMove?: ?(e: PressEvent) => void,
-  onTouchMoveCapture?: ?(e: PressEvent) => void,
-  onTouchStart?: ?(e: PressEvent) => void,
-  onTouchStartCapture?: ?(e: PressEvent) => void,
-|}>;
+}>;
+
+type TouchEventProps = $ReadOnly<{
+  onTouchCancel?: ?(e: GestureResponderEvent) => void,
+  onTouchCancelCapture?: ?(e: GestureResponderEvent) => void,
+  onTouchEnd?: ?(e: GestureResponderEvent) => void,
+  onTouchEndCapture?: ?(e: GestureResponderEvent) => void,
+  onTouchMove?: ?(e: GestureResponderEvent) => void,
+  onTouchMoveCapture?: ?(e: GestureResponderEvent) => void,
+  onTouchStart?: ?(e: GestureResponderEvent) => void,
+  onTouchStartCapture?: ?(e: GestureResponderEvent) => void,
+}>;
 
 /**
  * For most touch interactions, you'll simply want to wrap your component in
  * `TouchableHighlight` or `TouchableOpacity`. Check out `Touchable.js`,
  * `ScrollResponder.js` and `ResponderEventPlugin.js` for more discussion.
  */
-type GestureResponderEventProps = $ReadOnly<{|
+export type GestureResponderHandlers = $ReadOnly<{
   /**
    * Does this view want to "claim" touch responsiveness? This is called for
    * every touch move on the `View` when it is not the responder.
@@ -144,7 +140,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onmoveshouldsetresponder
    */
-  onMoveShouldSetResponder?: ?(e: PressEvent) => boolean,
+  onMoveShouldSetResponder?: ?(e: GestureResponderEvent) => boolean,
 
   /**
    * If a parent `View` wants to prevent a child `View` from becoming responder
@@ -155,7 +151,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onMoveShouldsetrespondercapture
    */
-  onMoveShouldSetResponderCapture?: ?(e: PressEvent) => boolean,
+  onMoveShouldSetResponderCapture?: ?(e: GestureResponderEvent) => boolean,
 
   /**
    * The View is now responding for touch events. This is the time to highlight
@@ -169,7 +165,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onrespondergrant
    */
-  onResponderGrant?: ?(e: PressEvent) => void | boolean,
+  onResponderGrant?: ?(e: GestureResponderEvent) => void | boolean,
 
   /**
    * The user is moving their finger.
@@ -179,7 +175,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onrespondermove
    */
-  onResponderMove?: ?(e: PressEvent) => void,
+  onResponderMove?: ?(e: GestureResponderEvent) => void,
 
   /**
    * Another responder is already active and will not release it to that `View`
@@ -190,7 +186,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onresponderreject
    */
-  onResponderReject?: ?(e: PressEvent) => void,
+  onResponderReject?: ?(e: GestureResponderEvent) => void,
 
   /**
    * Fired at the end of the touch.
@@ -200,10 +196,10 @@ type GestureResponderEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onresponderrelease
    */
-  onResponderRelease?: ?(e: PressEvent) => void,
+  onResponderRelease?: ?(e: GestureResponderEvent) => void,
 
-  onResponderStart?: ?(e: PressEvent) => void,
-  onResponderEnd?: ?(e: PressEvent) => void,
+  onResponderStart?: ?(e: GestureResponderEvent) => void,
+  onResponderEnd?: ?(e: GestureResponderEvent) => void,
 
   /**
    * The responder has been taken from the `View`. Might be taken by other
@@ -216,7 +212,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onresponderterminate
    */
-  onResponderTerminate?: ?(e: PressEvent) => void,
+  onResponderTerminate?: ?(e: GestureResponderEvent) => void,
 
   /**
    * Some other `View` wants to become responder and is asking this `View` to
@@ -227,7 +223,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onresponderterminationrequest
    */
-  onResponderTerminationRequest?: ?(e: PressEvent) => boolean,
+  onResponderTerminationRequest?: ?(e: GestureResponderEvent) => boolean,
 
   /**
    * Does this view want to become responder on the start of a touch?
@@ -237,7 +233,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onstartshouldsetresponder
    */
-  onStartShouldSetResponder?: ?(e: PressEvent) => boolean,
+  onStartShouldSetResponder?: ?(e: GestureResponderEvent) => boolean,
 
   /**
    * If a parent `View` wants to prevent a child `View` from becoming responder
@@ -248,60 +244,24 @@ type GestureResponderEventProps = $ReadOnly<{|
    *
    * See https://reactnative.dev/docs/view#onstartshouldsetrespondercapture
    */
-  onStartShouldSetResponderCapture?: ?(e: PressEvent) => boolean,
-|}>;
+  onStartShouldSetResponderCapture?: ?(e: GestureResponderEvent) => boolean,
+}>;
 
-type AndroidDrawableThemeAttr = $ReadOnly<{|
+type AndroidDrawableThemeAttr = $ReadOnly<{
   type: 'ThemeAttrAndroid',
   attribute: string,
-|}>;
+}>;
 
-type AndroidDrawableRipple = $ReadOnly<{|
+type AndroidDrawableRipple = $ReadOnly<{
   type: 'RippleAndroid',
   color?: ?number,
   borderless?: ?boolean,
   rippleRadius?: ?number,
-|}>;
+}>;
 
 type AndroidDrawable = AndroidDrawableThemeAttr | AndroidDrawableRipple;
 
-type AndroidViewProps = $ReadOnly<{|
-  /**
-   * Identifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props,
-   * the text is read aloud. The value should should match the nativeID of the related element.
-   *
-   * @platform android
-   */
-  accessibilityLabelledBy?: ?string | ?Array<string>,
-
-  /**
-   * Identifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props,
-   * the text is read aloud. The value should should match the nativeID of the related element.
-   *
-   * @platform android
-   */
-  'aria-labelledby'?: ?string,
-
-  /**
-   * Indicates to accessibility services whether the user should be notified
-   * when this view changes. Works for Android API >= 19 only.
-   *
-   * @platform android
-   *
-   * See https://reactnative.dev/docs/view#accessibilityliveregion
-   */
-  accessibilityLiveRegion?: ?('none' | 'polite' | 'assertive'),
-
-  /**
-   * Indicates to accessibility services whether the user should be notified
-   * when this view changes. Works for Android API >= 19 only.
-   *
-   * @platform android
-   *
-   * See https://reactnative.dev/docs/view#accessibilityliveregion
-   */
-  'aria-live'?: ?('polite' | 'assertive' | 'off'),
-
+export type ViewPropsAndroid = $ReadOnly<{
   nativeBackgroundAndroid?: ?AndroidDrawable,
   nativeForegroundAndroid?: ?AndroidDrawable,
 
@@ -315,17 +275,6 @@ type AndroidViewProps = $ReadOnly<{|
    */
   renderToHardwareTextureAndroid?: ?boolean,
 
-  /**
-   * Controls how view is important for accessibility which is if it
-   * fires accessibility events and if it is reported to accessibility services
-   * that query the screen. Works for Android only.
-   *
-   * @platform android
-   *
-   * See https://reactnative.dev/docs/view#importantforaccessibility
-   */
-  importantForAccessibility?: ?('auto' | 'yes' | 'no' | 'no-hide-descendants'),
-
   /**
    * Whether to force the Android TV focus engine to move focus to this view.
    *
@@ -373,7 +322,7 @@ type AndroidViewProps = $ReadOnly<{|
    *
    * @platform android
    */
-  focusable?: boolean,
+  focusable?: ?boolean,
 
   /**
    * Indicates whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
@@ -393,70 +342,10 @@ type AndroidViewProps = $ReadOnly<{|
    *
    * @platform android
    */
-  onClick?: ?(event: PressEvent) => mixed,
-|}>;
-
-type IOSViewProps = $ReadOnly<{|
-  /**
-   * Prevents view from being inverted if set to true and color inversion is turned on.
-   *
-   * @platform ios
-   */
-  accessibilityIgnoresInvertColors?: ?boolean,
-
-  /**
-   * A value indicating whether VoiceOver should ignore the elements
-   * within views that are siblings of the receiver.
-   * Default is `false`.
-   *
-   * @platform ios
-   *
-   * See https://reactnative.dev/docs/view#accessibilityviewismodal
-   */
-  accessibilityViewIsModal?: ?boolean,
-
-  /**
-   * @platform ios
-   *
-   * See https://reactnative.dev/docs/view#accessibilityshowslargecontentviewer
-   */
-  accessibilityShowsLargeContentViewer?: ?boolean,
-
-  /**
-   * @platform ios
-   *
-   * See https://reactnative.dev/docs/view#accessibilitylargecontenttitle
-   */
-  accessibilityLargeContentTitle?: ?string,
-
-  /**
-   * The aria-modal attribute indicates content contained within a modal with aria-modal="true"
-   * should be accessible to the user.
-   * Default is `false`.
-   *
-   *  @platform ios
-   */
-  'aria-modal'?: ?boolean,
-
-  /**
-   * A value indicating whether the accessibility elements contained within
-   * this accessibility element are hidden.
-   *
-   * @platform ios
-   *
-   * See https://reactnative.dev/docs/view#accessibilityElementsHidden
-   */
-  accessibilityElementsHidden?: ?boolean,
-
-  /**
-   * Indicates to the accessibility services that the UI component is in
-   * a specific language. The provided string should be formatted following
-   * the BCP 47 specification (https://www.rfc-editor.org/info/bcp47).
-   *
-   * @platform ios
-   */
-  accessibilityLanguage?: ?Stringish,
+  onClick?: ?(event: GestureResponderEvent) => mixed,
+}>;
 
+export type ViewPropsIOS = $ReadOnly<{
   /**
    * Whether this `View` should be rendered as a bitmap before compositing.
    *
@@ -465,102 +354,12 @@ type IOSViewProps = $ReadOnly<{|
    * See https://reactnative.dev/docs/view#shouldrasterizeios
    */
   shouldRasterizeIOS?: ?boolean,
-|}>;
-
-export type ViewProps = $ReadOnly<{|
-  ...DirectEventProps,
-  ...GestureResponderEventProps,
-  ...MouseEventProps,
-  ...PointerEventProps,
-  ...FocusEventProps,
-  ...TouchEventProps,
-  ...AndroidViewProps,
-  ...IOSViewProps,
+}>;
 
+type ViewBaseProps = $ReadOnly<{
   children?: Node,
   style?: ?ViewStyleProp,
 
-  /**
-   * When `true`, indicates that the view is an accessibility element.
-   * By default, all the touchable elements are accessible.
-   *
-   * See https://reactnative.dev/docs/view#accessible
-   */
-  accessible?: ?boolean,
-
-  /**
-   * Overrides the text that's read by the screen reader when the user interacts
-   * with the element. By default, the label is constructed by traversing all
-   * the children and accumulating all the `Text` nodes separated by space.
-   *
-   * See https://reactnative.dev/docs/view#accessibilitylabel
-   */
-  accessibilityLabel?: ?Stringish,
-
-  /**
-   * An accessibility hint helps users understand what will happen when they perform
-   * an action on the accessibility element when that result is not obvious from the
-   * accessibility label.
-   *
-   *
-   * See https://reactnative.dev/docs/view#accessibilityHint
-   */
-  accessibilityHint?: ?Stringish,
-
-  /**
-   * Alias for accessibilityLabel  https://reactnative.dev/docs/view#accessibilitylabel
-   * https://github.com/facebook/react-native/issues/34424
-   */
-  'aria-label'?: ?Stringish,
-
-  /**
-   * Indicates to accessibility services to treat UI component like a specific role.
-   */
-  accessibilityRole?: ?AccessibilityRole,
-
-  /**
-   * Alias for accessibilityRole
-   */
-  role?: ?Role,
-
-  /**
-   * Indicates to accessibility services that UI Component is in a specific State.
-   */
-  accessibilityState?: ?AccessibilityState,
-  accessibilityValue?: ?AccessibilityValue,
-
-  /**
-   * alias for accessibilityState
-   * It represents textual description of a component's value, or for range-based components, such as sliders and progress bars.
-   */
-  'aria-valuemax'?: ?AccessibilityValue['max'],
-  'aria-valuemin'?: ?AccessibilityValue['min'],
-  'aria-valuenow'?: ?AccessibilityValue['now'],
-  'aria-valuetext'?: ?AccessibilityValue['text'],
-
-  /**
-   * Provides an array of custom actions available for accessibility.
-   *
-   */
-  accessibilityActions?: ?$ReadOnlyArray<AccessibilityActionInfo>,
-
-  /**
-   * alias for accessibilityState
-   *
-   * see https://reactnative.dev/docs/accessibility#accessibilitystate
-   */
-  'aria-busy'?: ?boolean,
-  'aria-checked'?: ?boolean | 'mixed',
-  'aria-disabled'?: ?boolean,
-  'aria-expanded'?: ?boolean,
-  'aria-selected'?: ?boolean,
-  /** A value indicating whether the accessibility elements contained within
-   * this accessibility element are hidden.
-   *
-   * See https://reactnative.dev/docs/view#aria-hidden
-   */
-  'aria-hidden'?: ?boolean,
-
   /**
    * Views that are only used to layout their children or otherwise don't draw
    * anything may be automatically removed from the native hierarchy as an
@@ -644,4 +443,17 @@ export type ViewProps = $ReadOnly<{|
    * See https://reactnative.dev/docs/view#removeclippedsubviews
    */
   removeClippedSubviews?: ?boolean,
-|}>;
+}>;
+
+export type ViewProps = $ReadOnly<{
+  ...DirectEventProps,
+  ...GestureResponderHandlers,
+  ...MouseEventProps,
+  ...PointerEventProps,
+  ...FocusEventProps,
+  ...TouchEventProps,
+  ...ViewPropsAndroid,
+  ...ViewPropsIOS,
+  ...AccessibilityProps,
+  ...ViewBaseProps,
+}>;