@office-iss/react-native-win32 0.70.2 → 0.71.0-preview.1

package/Libraries/Components/View/ViewAccessibility.d.ts

@@ -0,0 +1,360 @@
+/**
+ * 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.
+ *
+ * @format
+ */
+
+import {NativeSyntheticEvent} from '../../Types/CoreEventTypes';
+
+/**
+ * @see https://reactnative.dev/docs/accessibility#accessibility-properties
+ */
+export interface AccessibilityProps
+  extends AccessibilityPropsAndroid,
+    AccessibilityPropsIOS {
+  /**
+   * When true, indicates that the view is an accessibility element.
+   * By default, all the touchable elements are accessible.
+   */
+  accessible?: boolean | undefined;
+
+  /**
+   * Provides an array of custom actions available for accessibility.
+   */
+  accessibilityActions?: ReadonlyArray<AccessibilityActionInfo> | undefined;
+
+  /**
+   * 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.
+   */
+  accessibilityLabel?: string | undefined;
+
+  /**
+   * Alias for accessibilityLabel  https://reactnative.dev/docs/view#accessibilitylabel
+   * https://github.com/facebook/react-native/issues/34424
+   */
+  'aria-label'?: string | undefined;
+
+  /**
+   * Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
+   */
+  accessibilityRole?: AccessibilityRole | undefined;
+  /**
+   * Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
+   */
+  accessibilityState?: AccessibilityState | undefined;
+
+  /**
+   * alias for accessibilityState
+   *
+   * see https://reactnative.dev/docs/accessibility#accessibilitystate
+   */
+  'aria-busy'?: boolean | undefined;
+  'aria-checked'?: boolean | 'mixed' | undefined;
+  'aria-disabled'?: boolean | undefined;
+  'aria-expanded'?: boolean | undefined;
+  'aria-selected'?: boolean | undefined;
+
+  /**
+   * Represents the nativeID of the associated label text. When the assistive technology focuses on the component with this props, the text is read aloud.
+   *
+   * @platform android
+   */
+  'aria-labelledby'?: string | undefined;
+
+  /**
+   * 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.
+   */
+  accessibilityHint?: string | undefined;
+  /**
+   * Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars,
+   * it contains range information (minimum, current, and maximum).
+   */
+  accessibilityValue?: AccessibilityValue | undefined;
+
+  'aria-valuemax'?: AccessibilityValue['max'];
+  'aria-valuemin'?: AccessibilityValue['min'];
+  'aria-valuenow'?: AccessibilityValue['now'];
+  'aria-valuetext'?: AccessibilityValue['text'];
+  /**
+   * When `accessible` is true, the system will try to invoke this function when the user performs an accessibility custom action.
+   */
+  onAccessibilityAction?:
+    | ((event: AccessibilityActionEvent) => void)
+    | undefined;
+
+  /**
+   * [Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.
+   */
+  importantForAccessibility?:
+    | ('auto' | 'yes' | 'no' | 'no-hide-descendants')
+    | undefined;
+
+  /**
+   * A value indicating whether the accessibility elements contained within
+   * this accessibility element are hidden.
+   */
+  'aria-hidden'?: boolean | undefined;
+
+  'aria-live'?: ('polite' | 'assertive' | 'off') | undefined;
+  'aria-modal'?: boolean | undefined;
+
+  /**
+   * Indicates to accessibility services to treat UI component like a specific role.
+   */
+  role?: Role;
+}
+
+export type AccessibilityActionInfo = Readonly<{
+  name: AccessibilityActionName | string;
+  label?: string | undefined;
+}>;
+
+export type AccessibilityActionName =
+  /**
+   * Generated when a screen reader user double taps the component.
+   */
+  | 'activate'
+  /**
+   * Generated when a screen reader user increments an adjustable component.
+   */
+  | 'increment'
+  /**
+   * Generated when a screen reader user decrements an adjustable component.
+   */
+  | 'decrement'
+  /**
+   * Generated when a TalkBack user places accessibility focus on the component and double taps and holds one finger on the screen.
+   * @platform android
+   */
+  | 'longpress'
+  /**
+   * Generated when a VoiceOver user places focus on or inside the component and double taps with two fingers.
+   * @platform ios
+   * */
+  | 'magicTap'
+  /**
+   * Generated when a VoiceOver user places focus on or inside the component and performs a two finger scrub gesture (left, right, left).
+   * @platform ios
+   * */
+  | 'escape';
+
+export type AccessibilityActionEvent = NativeSyntheticEvent<
+  Readonly<{
+    actionName: string;
+  }>
+>;
+
+export interface AccessibilityState {
+  /**
+   * When true, informs accessible tools if the element is disabled
+   */
+  disabled?: boolean | undefined;
+  /**
+   * When true, informs accessible tools if the element is selected
+   */
+  selected?: boolean | undefined;
+  /**
+   * For items like Checkboxes and Toggle switches, reports their state to accessible tools
+   */
+  checked?: boolean | 'mixed' | undefined;
+  /**
+   *  When present, informs accessible tools if the element is busy
+   */
+  busy?: boolean | undefined;
+  /**
+   *  When present, informs accessible tools the element is expanded or collapsed
+   */
+  expanded?: boolean | undefined;
+}
+
+export interface AccessibilityValue {
+  /**
+   * The minimum value of this component's range. (should be an integer)
+   */
+  min?: number | undefined;
+
+  /**
+   * The maximum value of this component's range. (should be an integer)
+   */
+  max?: number | undefined;
+
+  /**
+   * The current value of this component's range. (should be an integer)
+   */
+  now?: number | undefined;
+
+  /**
+   * A textual description of this component's value. (will override minimum, current, and maximum if set)
+   */
+  text?: string | undefined;
+}
+
+export type AccessibilityRole =
+  | 'none'
+  | 'button'
+  | 'togglebutton'
+  | 'link'
+  | 'search'
+  | 'image'
+  | 'keyboardkey'
+  | 'text'
+  | 'adjustable'
+  | 'imagebutton'
+  | 'header'
+  | 'summary'
+  | 'alert'
+  | 'checkbox'
+  | 'combobox'
+  | 'menu'
+  | 'menubar'
+  | 'menuitem'
+  | 'progressbar'
+  | 'radio'
+  | 'radiogroup'
+  | 'scrollbar'
+  | 'spinbutton'
+  | 'switch'
+  | 'tab'
+  | 'tabbar'
+  | 'tablist'
+  | 'timer'
+  | 'list'
+  | 'toolbar';
+
+export interface AccessibilityPropsAndroid {
+  /**
+   * Indicates to accessibility services whether the user should be notified when this view changes.
+   * Works for Android API >= 19 only.
+   * See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.
+   * @platform android
+   */
+  accessibilityLiveRegion?: 'none' | 'polite' | 'assertive' | undefined;
+
+  /**
+   * 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. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.
+   *
+   * Possible values:
+   *      'auto' - The system determines whether the view is important for accessibility - default (recommended).
+   *      'yes' - The view is important for accessibility.
+   *      'no' - The view is not important for accessibility.
+   *      'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.
+   */
+  importantForAccessibility?:
+    | 'auto'
+    | 'yes'
+    | 'no'
+    | 'no-hide-descendants'
+    | undefined;
+}
+
+export interface AccessibilityPropsIOS {
+  /**
+   * A Boolean value indicating whether the accessibility elements contained within this accessibility element
+   * are hidden to the screen reader.
+   * @platform ios
+   */
+  accessibilityElementsHidden?: boolean | undefined;
+
+  /**
+   * A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
+   * @platform ios
+   */
+  accessibilityViewIsModal?: boolean | undefined;
+
+  /**
+   * When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
+   * @platform ios
+   */
+  onAccessibilityEscape?: (() => void) | undefined;
+
+  /**
+   * When `accessible` is true, the system will try to invoke this function when the user performs accessibility tap gesture.
+   * @platform ios
+   */
+  onAccessibilityTap?: (() => void) | undefined;
+
+  /**
+   * When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
+   * @platform ios
+   */
+  onMagicTap?: (() => void) | undefined;
+
+  /**
+   * https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios
+   * @platform ios
+   */
+  accessibilityIgnoresInvertColors?: boolean | undefined;
+}
+
+export type Role =
+  | 'alert'
+  | 'alertdialog'
+  | 'application'
+  | 'article'
+  | 'banner'
+  | 'button'
+  | 'cell'
+  | 'checkbox'
+  | 'columnheader'
+  | 'combobox'
+  | 'complementary'
+  | 'contentinfo'
+  | 'definition'
+  | 'dialog'
+  | 'directory'
+  | 'document'
+  | 'feed'
+  | 'figure'
+  | 'form'
+  | 'grid'
+  | 'group'
+  | 'heading'
+  | 'img'
+  | 'link'
+  | 'list'
+  | 'listitem'
+  | 'log'
+  | 'main'
+  | 'marquee'
+  | 'math'
+  | 'menu'
+  | 'menubar'
+  | 'menuitem'
+  | 'meter'
+  | 'navigation'
+  | 'none'
+  | 'note'
+  | 'option'
+  | 'presentation'
+  | 'progressbar'
+  | 'radio'
+  | 'radiogroup'
+  | 'region'
+  | 'row'
+  | 'rowgroup'
+  | 'rowheader'
+  | 'scrollbar'
+  | 'searchbox'
+  | 'separator'
+  | 'slider'
+  | 'spinbutton'
+  | 'status'
+  | 'summary'
+  | 'switch'
+  | 'tab'
+  | 'table'
+  | 'tablist'
+  | 'tabpanel'
+  | 'term'
+  | 'timer'
+  | 'toolbar'
+  | 'tooltip'
+  | 'tree'
+  | 'treegrid'
+  | 'treeitem';

package/Libraries/Components/View/ViewAccessibility.js

@@ -43,7 +43,76 @@ export type AccessibilityRole =
   | 'tablist'
   | 'timer'
   | 'list'
-  | 'toolbar';
+  | 'toolbar'
+  | 'grid';
+
+// Role types for web
+export type Role =
+  | 'alert'
+  | 'alertdialog'
+  | 'application'
+  | 'article'
+  | 'banner'
+  | 'button'
+  | 'cell'
+  | 'checkbox'
+  | 'columnheader'
+  | 'combobox'
+  | 'complementary'
+  | 'contentinfo'
+  | 'definition'
+  | 'dialog'
+  | 'directory'
+  | 'document'
+  | 'feed'
+  | 'figure'
+  | 'form'
+  | 'grid'
+  | 'group'
+  | 'heading'
+  | 'img'
+  | 'link'
+  | 'list'
+  | 'listitem'
+  | 'log'
+  | 'main'
+  | 'marquee'
+  | 'math'
+  | 'menu'
+  | 'menubar'
+  | 'menuitem'
+  | 'meter'
+  | 'navigation'
+  | 'none'
+  | 'note'
+  | 'option'
+  | 'presentation'
+  | 'progressbar'
+  | 'radio'
+  | 'radiogroup'
+  | 'region'
+  | 'row'
+  | 'rowgroup'
+  | 'rowheader'
+  | 'scrollbar'
+  | 'searchbox'
+  | 'separator'
+  | 'slider'
+  | 'spinbutton'
+  | 'status'
+  | 'summary'
+  | 'switch'
+  | 'tab'
+  | 'table'
+  | 'tablist'
+  | 'tabpanel'
+  | 'term'
+  | 'timer'
+  | 'toolbar'
+  | 'tooltip'
+  | 'tree'
+  | 'treegrid'
+  | 'treeitem';
 
 // the info associated with an accessibility action
 export type AccessibilityActionInfo = $ReadOnly<{

package/Libraries/Components/View/ViewNativeComponent.js

@@ -8,15 +8,15 @@
  * @format
  */
 
-import * as NativeComponentRegistry from '../../NativeComponent/NativeComponentRegistry';
 import type {
   HostComponent,
   PartialViewConfig,
 } from '../../Renderer/shims/ReactNativeTypes';
+
+import * as NativeComponentRegistry from '../../NativeComponent/NativeComponentRegistry';
 import codegenNativeCommands from '../../Utilities/codegenNativeCommands';
-import {type ViewProps as Props} from './ViewPropTypes';
 import Platform from '../../Utilities/Platform';
-
+import {type ViewProps as Props} from './ViewPropTypes';
 import * as React from 'react';
 
 export const __INTERNAL_VIEW_CONFIG: PartialViewConfig =

package/Libraries/Components/View/ViewPropTypes.d.ts

@@ -0,0 +1,245 @@
+/**
+ * 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.
+ *
+ * @format
+ */
+
+import type * as React from 'react';
+import {Insets} from '../../../types/public/Insets';
+import {GestureResponderHandlers} from '../../../types/public/ReactNativeRenderer';
+import {StyleProp} from '../../StyleSheet/StyleSheet';
+import {ViewStyle} from '../../StyleSheet/StyleSheetTypes';
+import {LayoutChangeEvent, PointerEvents} from '../../Types/CoreEventTypes';
+import {Touchable} from '../Touchable/Touchable';
+import {AccessibilityProps} from './ViewAccessibility';
+
+export type TVParallaxProperties = {
+  /**
+   * If true, parallax effects are enabled.  Defaults to true.
+   */
+  enabled?: boolean | undefined;
+
+  /**
+   * Defaults to 2.0.
+   */
+  shiftDistanceX?: number | undefined;
+
+  /**
+   * Defaults to 2.0.
+   */
+  shiftDistanceY?: number | undefined;
+
+  /**
+   * Defaults to 0.05.
+   */
+  tiltAngle?: number | undefined;
+
+  /**
+   * Defaults to 1.0
+   */
+  magnification?: number | undefined;
+
+  /**
+   * Defaults to 1.0
+   */
+  pressMagnification?: number | undefined;
+
+  /**
+   * Defaults to 0.3
+   */
+  pressDuration?: number | undefined;
+
+  /**
+   * Defaults to 0.3
+   */
+  pressDelay?: number | undefined;
+};
+
+export interface TVViewPropsIOS {
+  /**
+   * *(Apple TV only)* When set to true, this view will be focusable
+   * and navigable using the Apple TV remote.
+   *
+   * @platform ios
+   */
+  isTVSelectable?: boolean | undefined;
+
+  /**
+   * *(Apple TV only)* May be set to true to force the Apple TV focus engine to move focus to this view.
+   *
+   * @platform ios
+   */
+  hasTVPreferredFocus?: boolean | undefined;
+
+  /**
+   * *(Apple TV only)* Object with properties to control Apple TV parallax effects.
+   *
+   * @platform ios
+   */
+  tvParallaxProperties?: TVParallaxProperties | undefined;
+
+  /**
+   * *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 2.0.
+   *
+   * @platform ios
+   */
+  tvParallaxShiftDistanceX?: number | undefined;
+
+  /**
+   * *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 2.0.
+   *
+   * @platform ios
+   */
+  tvParallaxShiftDistanceY?: number | undefined;
+
+  /**
+   * *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 0.05.
+   *
+   * @platform ios
+   */
+  tvParallaxTiltAngle?: number | undefined;
+
+  /**
+   * *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 1.0.
+   *
+   * @platform ios
+   */
+  tvParallaxMagnification?: number | undefined;
+}
+
+export interface ViewPropsIOS extends TVViewPropsIOS {
+  /**
+   * Whether this view should be rendered as a bitmap before compositing.
+   *
+   * On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children;
+   * for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view
+   * and quickly composite it during each frame.
+   *
+   * Rasterization incurs an off-screen drawing pass and the bitmap consumes memory.
+   * Test and measure when using this property.
+   */
+  shouldRasterizeIOS?: boolean | undefined;
+}
+
+export interface ViewPropsAndroid {
+  /**
+   * 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.
+   */
+  collapsable?: boolean | undefined;
+
+  /**
+   * Whether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior.
+   * The default (false) falls back to drawing the component and its children
+   * with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value.
+   * This default may be noticeable and undesired in the case where the View you are setting an opacity on
+   * has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).
+   *
+   * Rendering offscreen to preserve correct alpha behavior is extremely expensive
+   * and hard to debug for non-native developers, which is why it is not turned on by default.
+   * If you do need to enable this property for an animation,
+   * consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame).
+   * If that property is enabled, this View will be rendered off-screen once,
+   * saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU.
+   */
+  needsOffscreenAlphaCompositing?: boolean | undefined;
+
+  /**
+   * Whether this view should render itself (and all of its children) into a single hardware texture on the GPU.
+   *
+   * On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale:
+   * in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be
+   * re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
+   */
+  renderToHardwareTextureAndroid?: boolean | undefined;
+
+  /**
+   * Whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
+   */
+  focusable?: boolean | undefined;
+}
+
+/**
+ * @see https://reactnative.dev/docs/view#props
+ */
+export interface ViewProps
+  extends ViewPropsAndroid,
+    ViewPropsIOS,
+    GestureResponderHandlers,
+    Touchable,
+    PointerEvents,
+    AccessibilityProps {
+  children?: React.ReactNode;
+  /**
+   * This defines how far a touch event can start away from the view.
+   * Typical interface guidelines recommend touch targets that are at least
+   * 30 - 40 points/density-independent pixels. If a Touchable view has
+   * a height of 20 the touchable height can be extended to 40 with
+   * hitSlop={{top: 10, bottom: 10, left: 0, right: 0}}
+   * NOTE The touch area never extends past the parent view bounds and
+   * the Z-index of sibling views always takes precedence if a touch
+   * hits two overlapping views.
+   */
+  hitSlop?: Insets | undefined;
+
+  /**
+   * Used to reference react managed views from native code.
+   */
+  id?: string | undefined;
+
+  /**
+   * Invoked on mount and layout changes with
+   *
+   * {nativeEvent: { layout: {x, y, width, height}}}.
+   */
+  onLayout?: ((event: LayoutChangeEvent) => void) | undefined;
+
+  /**
+   *
+   * In the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:
+   *
+   * .box-none {
+   *   pointer-events: none;
+   * }
+   * .box-none * {
+   *   pointer-events: all;
+   * }
+   *
+   * box-only is the equivalent of
+   *
+   * .box-only {
+   *   pointer-events: all;
+   * }
+   * .box-only * {
+   *   pointer-events: none;
+   * }
+   *
+   * But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes,
+   * we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform.
+   */
+  pointerEvents?: 'box-none' | 'none' | 'box-only' | 'auto' | undefined;
+
+  /**
+   *
+   * This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews,
+   * most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound.
+   * The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
+   */
+  removeClippedSubviews?: boolean | undefined;
+
+  style?: StyleProp<ViewStyle> | undefined;
+
+  /**
+   * Used to locate this view in end-to-end tests.
+   */
+  testID?: string | undefined;
+
+  /**
+   * Used to reference react managed views from native code.
+   */
+  nativeID?: string | undefined;
+}