@office-iss/react-native-win32 0.0.0-canary.28 → 0.0.0-canary.280

package/Libraries/Components/View/ViewPropTypes.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -10,33 +10,30 @@
 
 'use strict';
 
+import type {EdgeInsetsOrSizeProp} from '../../StyleSheet/EdgeInsetsPropType';
+import type {ViewStyleProp} from '../../StyleSheet/StyleSheet';
 import type {
   BlurEvent,
   FocusEvent,
-  MouseEvent,
-  PressEvent,
   Layout,
   LayoutEvent,
+  MouseEvent,
+  PointerEvent,
+  PressEvent,
 } from '../../Types/CoreEventTypes';
-import type {EdgeInsetsProp} from '../../StyleSheet/EdgeInsetsPropType';
-import type {Node} from 'react';
-import type {ViewStyleProp} from '../../StyleSheet/StyleSheet';
 import type {
+  AccessibilityActionEvent,
+  AccessibilityActionInfo,
   AccessibilityRole,
   AccessibilityState,
   AccessibilityValue,
-  AccessibilityActionEvent,
-  AccessibilityActionInfo,
+  Role,
 } from './ViewAccessibility';
+import type {Node} from 'react';
 
 export type ViewLayout = Layout;
 export type ViewLayoutEvent = LayoutEvent;
 
-type BubblingEventProps = $ReadOnly<{|
-  onBlur?: ?(event: BlurEvent) => mixed,
-  onFocus?: ?(event: FocusEvent) => mixed,
-|}>;
-
 type DirectEventProps = $ReadOnly<{|
   /**
    * When `accessible` is true, the system will try to invoke this function
@@ -49,7 +46,7 @@ type DirectEventProps = $ReadOnly<{|
    * When `accessible` is true, the system will try to invoke this function
    * when the user performs accessibility tap gesture.
    *
-   * See https://reactnative.dev/docs/view.html#onaccessibilitytap
+   * See https://reactnative.dev/docs/view#onaccessibilitytap
    */
   onAccessibilityTap?: ?() => mixed,
 
@@ -62,7 +59,7 @@ type DirectEventProps = $ReadOnly<{|
    * the new layout may not yet be reflected on the screen at the time the
    * event is received, especially if a layout animation is in progress.
    *
-   * See https://reactnative.dev/docs/view.html#onlayout
+   * See https://reactnative.dev/docs/view#onlayout
    */
   onLayout?: ?(event: LayoutEvent) => mixed,
 
@@ -70,7 +67,7 @@ type DirectEventProps = $ReadOnly<{|
    * When `accessible` is `true`, the system will invoke this function when the
    * user performs the magic tap gesture.
    *
-   * See https://reactnative.dev/docs/view.html#onmagictap
+   * See https://reactnative.dev/docs/view#onmagictap
    */
   onMagicTap?: ?() => mixed,
 
@@ -78,14 +75,47 @@ type DirectEventProps = $ReadOnly<{|
    * When `accessible` is `true`, the system will invoke this function when the
    * user performs the escape gesture.
    *
-   * See https://reactnative.dev/docs/view.html#onaccessibilityescape
+   * See https://reactnative.dev/docs/view#onaccessibilityescape
    */
   onAccessibilityEscape?: ?() => mixed,
 |}>;
 
 type MouseEventProps = $ReadOnly<{|
-  onMouseEnter?: (event: MouseEvent) => void,
-  onMouseLeave?: (event: MouseEvent) => void,
+  onMouseEnter?: ?(event: MouseEvent) => void,
+  onMouseLeave?: ?(event: MouseEvent) => void,
+|}>;
+
+// Experimental/Work in Progress Pointer Event Callbacks (not yet ready for use)
+type PointerEventProps = $ReadOnly<{|
+  onClick?: ?(event: PointerEvent) => void,
+  onClickCapture?: ?(event: PointerEvent) => void,
+  onPointerEnter?: ?(event: PointerEvent) => void,
+  onPointerEnterCapture?: ?(event: PointerEvent) => void,
+  onPointerLeave?: ?(event: PointerEvent) => void,
+  onPointerLeaveCapture?: ?(event: PointerEvent) => void,
+  onPointerMove?: ?(event: PointerEvent) => void,
+  onPointerMoveCapture?: ?(event: PointerEvent) => void,
+  onPointerCancel?: ?(e: PointerEvent) => void,
+  onPointerCancelCapture?: ?(e: PointerEvent) => void,
+  onPointerDown?: ?(e: PointerEvent) => void,
+  onPointerDownCapture?: ?(e: PointerEvent) => void,
+  onPointerUp?: ?(e: PointerEvent) => void,
+  onPointerUpCapture?: ?(e: PointerEvent) => void,
+  onPointerOver?: ?(e: PointerEvent) => void,
+  onPointerOverCapture?: ?(e: PointerEvent) => void,
+  onPointerOut?: ?(e: PointerEvent) => void,
+  onPointerOutCapture?: ?(e: PointerEvent) => void,
+  onGotPointerCapture?: ?(e: PointerEvent) => void,
+  onGotPointerCaptureCapture?: ?(e: PointerEvent) => void,
+  onLostPointerCapture?: ?(e: PointerEvent) => void,
+  onLostPointerCaptureCapture?: ?(e: PointerEvent) => void,
+|}>;
+
+type FocusEventProps = $ReadOnly<{|
+  onBlur?: ?(event: BlurEvent) => void,
+  onBlurCapture?: ?(event: BlurEvent) => void,
+  onFocus?: ?(event: FocusEvent) => void,
+  onFocusCapture?: ?(event: FocusEvent) => void,
 |}>;
 
 type TouchEventProps = $ReadOnly<{|
@@ -112,7 +142,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    * `View.props.onMoveShouldSetResponder: (event) => [true | false]`, where
    * `event` is a synthetic touch event as described above.
    *
-   * See https://reactnative.dev/docs/view.html#onmoveshouldsetresponder
+   * See https://reactnative.dev/docs/view#onmoveshouldsetresponder
    */
   onMoveShouldSetResponder?: ?(e: PressEvent) => boolean,
 
@@ -123,7 +153,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    * `View.props.onMoveShouldSetResponderCapture: (event) => [true | false]`,
    * where `event` is a synthetic touch event as described above.
    *
-   * See https://reactnative.dev/docs/view.html#onMoveShouldsetrespondercapture
+   * See https://reactnative.dev/docs/view#onMoveShouldsetrespondercapture
    */
   onMoveShouldSetResponderCapture?: ?(e: PressEvent) => boolean,
 
@@ -134,10 +164,10 @@ type GestureResponderEventProps = $ReadOnly<{|
    * `View.props.onResponderGrant: (event) => {}`, where `event` is a synthetic
    * touch event as described above.
    *
-   * PanResponder includes a note `// TODO: t7467124 investigate if this can be removed` that
-   * should help fixing this return type.
+   * Return true from this callback to prevent any other native components from
+   * becoming responder until this responder terminates (Android-only).
    *
-   * See https://reactnative.dev/docs/view.html#onrespondergrant
+   * See https://reactnative.dev/docs/view#onrespondergrant
    */
   onResponderGrant?: ?(e: PressEvent) => void | boolean,
 
@@ -147,7 +177,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    * `View.props.onResponderMove: (event) => {}`, where `event` is a synthetic
    * touch event as described above.
    *
-   * See https://reactnative.dev/docs/view.html#onrespondermove
+   * See https://reactnative.dev/docs/view#onrespondermove
    */
   onResponderMove?: ?(e: PressEvent) => void,
 
@@ -158,7 +188,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    * `View.props.onResponderReject: (event) => {}`, where `event` is a
    * synthetic touch event as described above.
    *
-   * See https://reactnative.dev/docs/view.html#onresponderreject
+   * See https://reactnative.dev/docs/view#onresponderreject
    */
   onResponderReject?: ?(e: PressEvent) => void,
 
@@ -168,7 +198,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    * `View.props.onResponderRelease: (event) => {}`, where `event` is a
    * synthetic touch event as described above.
    *
-   * See https://reactnative.dev/docs/view.html#onresponderrelease
+   * See https://reactnative.dev/docs/view#onresponderrelease
    */
   onResponderRelease?: ?(e: PressEvent) => void,
 
@@ -184,7 +214,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    * `View.props.onResponderTerminate: (event) => {}`, where `event` is a
    * synthetic touch event as described above.
    *
-   * See https://reactnative.dev/docs/view.html#onresponderterminate
+   * See https://reactnative.dev/docs/view#onresponderterminate
    */
   onResponderTerminate?: ?(e: PressEvent) => void,
 
@@ -195,7 +225,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    * `View.props.onResponderTerminationRequest: (event) => {}`, where `event`
    * is a synthetic touch event as described above.
    *
-   * See https://reactnative.dev/docs/view.html#onresponderterminationrequest
+   * See https://reactnative.dev/docs/view#onresponderterminationrequest
    */
   onResponderTerminationRequest?: ?(e: PressEvent) => boolean,
 
@@ -205,7 +235,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    * `View.props.onStartShouldSetResponder: (event) => [true | false]`, where
    * `event` is a synthetic touch event as described above.
    *
-   * See https://reactnative.dev/docs/view.html#onstartshouldsetresponder
+   * See https://reactnative.dev/docs/view#onstartshouldsetresponder
    */
   onStartShouldSetResponder?: ?(e: PressEvent) => boolean,
 
@@ -216,7 +246,7 @@ type GestureResponderEventProps = $ReadOnly<{|
    * `View.props.onStartShouldSetResponderCapture: (event) => [true | false]`,
    * where `event` is a synthetic touch event as described above.
    *
-   * See https://reactnative.dev/docs/view.html#onstartshouldsetrespondercapture
+   * See https://reactnative.dev/docs/view#onstartshouldsetrespondercapture
    */
   onStartShouldSetResponderCapture?: ?(e: PressEvent) => boolean,
 |}>;
@@ -230,45 +260,37 @@ type AndroidDrawableRipple = $ReadOnly<{|
   type: 'RippleAndroid',
   color?: ?number,
   borderless?: ?boolean,
+  rippleRadius?: ?number,
 |}>;
 
 type AndroidDrawable = AndroidDrawableThemeAttr | AndroidDrawableRipple;
 
 type AndroidViewProps = $ReadOnly<{|
-  nativeBackgroundAndroid?: ?AndroidDrawable,
-  nativeForegroundAndroid?: ?AndroidDrawable,
-
   /**
-   * Whether this `View` should render itself (and all of its children) into a
-   * single hardware texture on the GPU.
+   * 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
-   *
-   * See https://reactnative.dev/docs/view.html#rendertohardwaretextureandroid
    */
-  renderToHardwareTextureAndroid?: ?boolean,
+  accessibilityLabelledBy?: ?string | ?Array<string>,
 
   /**
-   * 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
-   * optimization. Set this property to `false` to disable this optimization and
-   * ensure that this `View` exists in the native view hierarchy.
+   * 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
-   *
-   * See https://reactnative.dev/docs/view.html#collapsable
    */
-  collapsable?: ?boolean,
+  'aria-labelledby'?: ?string,
 
   /**
-   * Whether this `View` needs to rendered offscreen and composited with an
-   * alpha in order to preserve 100% correct colors and blending behavior.
+   * 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.html#needsoffscreenalphacompositing
+   * See https://reactnative.dev/docs/view#accessibilityliveregion
    */
-  needsOffscreenAlphaCompositing?: ?boolean,
+  accessibilityLiveRegion?: ?('none' | 'polite' | 'assertive'),
 
   /**
    * Indicates to accessibility services whether the user should be notified
@@ -276,9 +298,22 @@ type AndroidViewProps = $ReadOnly<{|
    *
    * @platform android
    *
-   * See https://reactnative.dev/docs/view.html#accessibilityliveregion
+   * See https://reactnative.dev/docs/view#accessibilityliveregion
    */
-  accessibilityLiveRegion?: ?('none' | 'polite' | 'assertive'),
+  'aria-live'?: ?('polite' | 'assertive' | 'off'),
+
+  nativeBackgroundAndroid?: ?AndroidDrawable,
+  nativeForegroundAndroid?: ?AndroidDrawable,
+
+  /**
+   * Whether this `View` should render itself (and all of its children) into a
+   * single hardware texture on the GPU.
+   *
+   * @platform android
+   *
+   * See https://reactnative.dev/docs/view#rendertohardwaretextureandroid
+   */
+  renderToHardwareTextureAndroid?: ?boolean,
 
   /**
    * Controls how view is important for accessibility which is if it
@@ -287,7 +322,7 @@ type AndroidViewProps = $ReadOnly<{|
    *
    * @platform android
    *
-   * See https://reactnative.dev/docs/view.html#importantforaccessibility
+   * See https://reactnative.dev/docs/view#importantforaccessibility
    */
   importantForAccessibility?: ?('auto' | 'yes' | 'no' | 'no-hide-descendants'),
 
@@ -340,6 +375,19 @@ type AndroidViewProps = $ReadOnly<{|
    */
   focusable?: boolean,
 
+  /**
+   * Indicates whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
+   * See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex
+   * for more details.
+   *
+   * Supports the following values:
+   * -  0 (View is focusable)
+   * - -1 (View is not focusable)
+   *
+   * @platform android
+   */
+  tabIndex?: 0 | -1,
+
   /**
    * The action to perform when this `View` is clicked on by a non-touch click, eg. enter key on a hardware keyboard.
    *
@@ -363,35 +411,68 @@ type IOSViewProps = $ReadOnly<{|
    *
    * @platform ios
    *
-   * See https://reactnative.dev/docs/view.html#accessibilityviewismodal
+   * 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.html#accessibilityElementsHidden
+   * 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,
+
   /**
    * Whether this `View` should be rendered as a bitmap before compositing.
    *
    * @platform ios
    *
-   * See https://reactnative.dev/docs/view.html#shouldrasterizeios
+   * See https://reactnative.dev/docs/view#shouldrasterizeios
    */
   shouldRasterizeIOS?: ?boolean,
 |}>;
 
 export type ViewProps = $ReadOnly<{|
-  ...BubblingEventProps,
   ...DirectEventProps,
   ...GestureResponderEventProps,
   ...MouseEventProps,
+  ...PointerEventProps,
+  ...FocusEventProps,
   ...TouchEventProps,
   ...AndroidViewProps,
   ...IOSViewProps,
@@ -403,7 +484,7 @@ export type ViewProps = $ReadOnly<{|
    * When `true`, indicates that the view is an accessibility element.
    * By default, all the touchable elements are accessible.
    *
-   * See https://reactnative.dev/docs/view.html#accessible
+   * See https://reactnative.dev/docs/view#accessible
    */
   accessible?: ?boolean,
 
@@ -412,7 +493,7 @@ export type ViewProps = $ReadOnly<{|
    * 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.html#accessibilitylabel
+   * See https://reactnative.dev/docs/view#accessibilitylabel
    */
   accessibilityLabel?: ?Stringish,
 
@@ -422,33 +503,96 @@ export type ViewProps = $ReadOnly<{|
    * accessibility label.
    *
    *
-   * See https://reactnative.dev/docs/view.html#accessibilityHint
+   * 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
+   * optimization. Set this property to `false` to disable this optimization and
+   * ensure that this `View` exists in the native view hierarchy.
+   *
+   * See https://reactnative.dev/docs/view#collapsable
+   */
+  collapsable?: ?boolean,
+
+  /**
+   * Setting to false prevents direct children of the view from being removed
+   * from the native view hierarchy, similar to the effect of setting
+   * `collapsable={false}` on each child.
+   */
+  collapsableChildren?: ?boolean,
+
+  /**
+   * Used to locate this view from native classes. Has precedence over `nativeID` prop.
+   *
+   * > This disables the 'layout-only view removal' optimization for this view!
+   *
+   * See https://reactnative.dev/docs/view#id
+   */
+  id?: string,
+
   /**
    * Used to locate this view in end-to-end tests.
    *
    * > This disables the 'layout-only view removal' optimization for this view!
    *
-   * See https://reactnative.dev/docs/view.html#testid
+   * See https://reactnative.dev/docs/view#testid
    */
   testID?: ?string,
 
@@ -457,10 +601,18 @@ export type ViewProps = $ReadOnly<{|
    *
    * > This disables the 'layout-only view removal' optimization for this view!
    *
-   * See https://reactnative.dev/docs/view.html#nativeid
+   * See https://reactnative.dev/docs/view#nativeid
    */
   nativeID?: ?string,
 
+  /**
+   * Whether this `View` needs to rendered offscreen and composited with an
+   * alpha in order to preserve 100% correct colors and blending behavior.
+   *
+   * See https://reactnative.dev/docs/view#needsoffscreenalphacompositing
+   */
+  needsOffscreenAlphaCompositing?: ?boolean,
+
   /**
    * This defines how far a touch event can start away from the view.
    * Typical interface guidelines recommend touch targets that are at least
@@ -470,14 +622,14 @@ export type ViewProps = $ReadOnly<{|
    * > of sibling views always takes precedence if a touch hits two overlapping
    * > views.
    *
-   * See https://reactnative.dev/docs/view.html#hitslop
+   * See https://reactnative.dev/docs/view#hitslop
    */
-  hitSlop?: ?EdgeInsetsProp,
+  hitSlop?: ?EdgeInsetsOrSizeProp,
 
   /**
    * Controls whether the `View` can be the target of touch events.
    *
-   * See https://reactnative.dev/docs/view.html#pointerevents
+   * See https://reactnative.dev/docs/view#pointerevents
    */
   pointerEvents?: ?('auto' | 'box-none' | 'box-only' | 'none'),
 
@@ -489,7 +641,7 @@ export type ViewProps = $ReadOnly<{|
    * subviews must also have `overflow: hidden`, as should the containing view
    * (or one of its superviews).
    *
-   * See https://reactnative.dev/docs/view.html#removeclippedsubviews
+   * See https://reactnative.dev/docs/view#removeclippedsubviews
    */
   removeClippedSubviews?: ?boolean,
 |}>;