react-native-tvos 0.86.0-2 → 0.87.0-0

package/Libraries/Components/Keyboard/Keyboard.js

@@ -42,7 +42,13 @@ type BaseKeyboardEvent = {
 
 export type AndroidKeyboardEvent = Readonly<{
   ...BaseKeyboardEvent,
+  /**
+   * Always set to 0 on Android.
+   */
   duration: 0,
+  /**
+   * Always set to "keyboard" on Android.
+   */
   easing: 'keyboard',
 }>;
 
@@ -62,47 +68,8 @@ type KeyboardEventDefinitions = {
 };
 
 /**
- * `Keyboard` module to control keyboard events.
- *
- * ### Usage
- *
- * The Keyboard module allows you to listen for native events and react to them, as
- * well as make changes to the keyboard, like dismissing it.
- *
- *```
- * import React, { Component } from 'react';
- * import { Keyboard, TextInput } from 'react-native';
- *
- * class Example extends Component {
- *   componentWillMount () {
- *     this.keyboardDidShowListener = Keyboard.addListener('keyboardDidShow', this._keyboardDidShow);
- *     this.keyboardDidHideListener = Keyboard.addListener('keyboardDidHide', this._keyboardDidHide);
- *   }
- *
- *   componentWillUnmount () {
- *     this.keyboardDidShowListener.remove();
- *     this.keyboardDidHideListener.remove();
- *   }
- *
- *   _keyboardDidShow () {
- *     alert('Keyboard Shown');
- *   }
- *
- *   _keyboardDidHide () {
- *     alert('Keyboard Hidden');
- *   }
- *
- *   render() {
- *     return (
- *       <TextInput
- *         onSubmitEditing={Keyboard.dismiss}
- *       />
- *     );
- *   }
- * }
- *```
+ * Module to control keyboard events and make changes to the keyboard.
  */
-
 class KeyboardImpl {
   _currentlyShowing: ?KeyboardEvent;
 
@@ -123,28 +90,18 @@ class KeyboardImpl {
   }
 
   /**
-   * The `addListener` function connects a JavaScript function to an identified native
-   * keyboard notification event.
-   *
-   * This function then returns the reference to the listener.
-   *
-   * @param {string} eventName The `nativeEvent` is the string that identifies the event you're listening for.  This
-   *can be any of the following:
+   * Listen for native keyboard notification events.
    *
-   * - `keyboardWillShow`
-   * - `keyboardDidShow`
-   * - `keyboardWillHide`
-   * - `keyboardDidHide`
-   * - `keyboardWillChangeFrame`
-   * - `keyboardDidChangeFrame`
+   * Available events are: `keyboardWillShow`, `keyboardDidShow`,
+   * `keyboardWillHide`, `keyboardDidHide`, `keyboardWillChangeFrame`, and
+   * `keyboardDidChangeFrame`. Only `keyboardDidShow` and `keyboardDidHide`
+   * are available on Android.
    *
    * Android versions prior to API 30 rely on observing layout changes when
    * `android:windowSoftInputMode` is set to `adjustResize` or `adjustPan`.
    *
-   * `keyboardWillShow` as well as `keyboardWillHide` are not available on Android since there is
-   * no native corresponding event.
-   *
-   * @param {function} callback function to be called when the event fires.
+   * @param {string} eventName The native event name to listen for.
+   * @param {function} callback Function to be called when the event fires.
    */
   addListener<K extends keyof KeyboardEventDefinitions>(
     eventType: K,
@@ -180,15 +137,15 @@ class KeyboardImpl {
   }
 
   /**
-   * Return the metrics of the soft-keyboard if visible.
+   * Return the metrics of the soft keyboard if visible.
    */
   metrics(): ?KeyboardMetrics {
     return this._currentlyShowing?.endCoordinates;
   }
 
   /**
-   * Useful for syncing TextInput (or other keyboard accessory view) size of
-   * position changes with keyboard movements.
+   * Sync `TextInput` (or other keyboard accessory view) size or position
+   * changes with keyboard movements.
    */
   scheduleLayoutAnimation(event: KeyboardEvent): void {
     const {duration, easing} = event;
@@ -204,6 +161,12 @@ class KeyboardImpl {
   }
 }
 
+/**
+ * `Keyboard` module to control keyboard events and make changes to the
+ * keyboard, like dismissing it.
+ *
+ * @see https://reactnative.dev/docs/keyboard
+ */
 const Keyboard: KeyboardImpl = new KeyboardImpl();
 
 export default Keyboard;

package/Libraries/Components/Keyboard/KeyboardAvoidingView.js

@@ -26,6 +26,7 @@ import Keyboard from './Keyboard';
 import * as React from 'react';
 import {createRef} from 'react';
 
+/** @build-types emit-as-interface Uniwind compatibility */
 export type KeyboardAvoidingViewProps = Readonly<{
   ...ViewProps,
 
@@ -35,19 +36,22 @@ export type KeyboardAvoidingViewProps = Readonly<{
   behavior?: ?('height' | 'position' | 'padding'),
 
   /**
-   * Style of the content container when `behavior` is 'position'.
+   * The style of the content container (View) when `behavior` is 'position'.
    */
   contentContainerStyle?: ?ViewStyleProp,
 
   /**
-   * Controls whether this `KeyboardAvoidingView` instance should take effect.
-   * This is useful when more than one is on the screen. Defaults to true.
+   * Whether the `KeyboardAvoidingView` is enabled.
+   *
+   * @default `true`
    */
   enabled?: ?boolean,
 
   /**
-   * Distance between the top of the user screen and the React Native view. This
-   * may be non-zero in some cases. Defaults to 0.
+   * Distance between the top of the user screen and the React Native view,
+   * may be non-zero in some use cases.
+   *
+   * @default `0`
    */
   keyboardVerticalOffset?: number,
 }>;
@@ -57,8 +61,10 @@ type KeyboardAvoidingViewState = {
 };
 
 /**
- * View that moves out of the way when the keyboard appears by automatically
- * adjusting its height, position, or bottom padding.
+ * Automatically adjusts its height, position, or bottom padding based on the
+ * keyboard height to remain visible while the virtual keyboard is displayed.
+ *
+ * @see https://reactnative.dev/docs/keyboardavoidingview
  */
 class KeyboardAvoidingView extends React.Component<
   KeyboardAvoidingViewProps,
@@ -297,4 +303,6 @@ class KeyboardAvoidingView extends React.Component<
   }
 }
 
+export type KeyboardAvoidingViewInstance = KeyboardAvoidingView;
+
 export default KeyboardAvoidingView;

package/Libraries/Components/Pressable/Pressable.js

@@ -8,6 +8,7 @@
  * @format
  */
 
+import type {HostInstance} from '../../../src/private/types/HostInstance';
 import type {ViewStyleProp} from '../../StyleSheet/StyleSheet';
 import type {
   BlurEvent,
@@ -31,6 +32,8 @@ import useAndroidRippleForView, {
 import * as React from 'react';
 import {memo, useMemo, useRef, useState} from 'react';
 
+export type PressableInstance = HostInstance;
+
 export type {PressableAndroidRippleConfig};
 
 export type PressableStateCallbackType = Readonly<{
@@ -61,28 +64,36 @@ type PressableBaseProps = Readonly<{
   cancelable?: ?boolean,
 
   /**
-   * Either children or a render prop that receives a boolean reflecting whether
+   * Either children or a function that receives a boolean reflecting whether
    * the component is currently pressed.
    */
   children?: React.Node | ((state: PressableStateCallbackType) => React.Node),
 
   /**
    * Duration to wait after hover in before calling `onHoverIn`.
+   *
+   * @platform macos windows
    */
   delayHoverIn?: ?number,
 
   /**
    * Duration to wait after hover out before calling `onHoverOut`.
+   *
+   * @platform macos windows
    */
   delayHoverOut?: ?number,
 
   /**
    * Duration (in milliseconds) from `onPressIn` before `onLongPress` is called.
+   *
+   * @default `500`
    */
   delayLongPress?: ?number,
 
   /**
    * Whether the press behavior is disabled.
+   *
+   * @default `false`
    */
   disabled?: ?boolean,
 
@@ -94,6 +105,8 @@ type PressableBaseProps = Readonly<{
   /**
    * Additional distance outside of this view in which a touch is considered a
    * press before `onPressOut` is triggered.
+   *
+   * @default `{bottom: 30, left: 20, right: 20, top: 20}`
    */
   pressRetentionOffset?: ?RectOrSize,
 
@@ -103,36 +116,38 @@ type PressableBaseProps = Readonly<{
   onLayout?: ?(event: LayoutChangeEvent) => unknown,
 
   /**
-   * Called when the hover is activated to provide visual feedback.
+   * Called when the hover is activated.
    */
   onHoverIn?: ?(event: MouseEvent) => unknown,
 
   /**
-   * Called when the hover is deactivated to undo visual feedback.
+   * Called when the hover is deactivated.
    */
   onHoverOut?: ?(event: MouseEvent) => unknown,
 
   /**
-   * Called when a long-tap gesture is detected.
+   * Called if the time after `onPressIn` lasts longer than `delayLongPress`.
    */
   onLongPress?: ?(event: GestureResponderEvent) => unknown,
 
   /**
-   * Called when a single tap gesture is detected.
+   * Called after `onPressOut`.
    */
   onPress?: ?(event: GestureResponderEvent) => unknown,
 
   /**
-   * Called when a touch is engaged before `onPress`.
+   * Called immediately when a touch is engaged, before `onPressOut` and
+   * `onPress`.
    */
   onPressIn?: ?(event: GestureResponderEvent) => unknown,
+
   /**
    * Called when the press location moves.
    */
   onPressMove?: ?(event: GestureResponderEvent) => unknown,
 
   /**
-   * Called when a touch is released before `onPress`.
+   * Called when a touch is released.
    */
   onPressOut?: ?(event: GestureResponderEvent) => unknown,
 
@@ -156,12 +171,17 @@ type PressableBaseProps = Readonly<{
   testID?: ?string,
 
   /**
-   * If true, doesn't play system sound on touch.
+   * If true, doesn't play Android system sound on press.
+   *
+   * @platform android
+   * @default `false`
    */
   android_disableSound?: ?boolean,
 
   /**
-   * Enables the Android ripple effect and configures its color.
+   * Enables the Android ripple effect and configures its properties.
+   *
+   * @platform android
    */
   android_ripple?: ?PressableAndroidRippleConfig,
 
@@ -171,11 +191,13 @@ type PressableBaseProps = Readonly<{
   testOnly_pressed?: ?boolean,
 
   /**
-   * Duration to wait after press down before calling `onPressIn`.
+   * Duration (in milliseconds) to wait after press down before calling
+   * `onPressIn`.
    */
   unstable_pressDelay?: ?number,
 }>;
 
+/** @build-types emit-as-interface Uniwind compatibility */
 export type PressableProps = Readonly<{
   // Pressability may override `onMouseEnter` and `onMouseLeave` to
   // implement `onHoverIn` and `onHoverOut` in a platform-agnostic way.
@@ -188,17 +210,17 @@ export type PressableProps = Readonly<{
   ...TVProps,
 }>;
 
-type Instance = React.ElementRef<typeof View>;
-
 /**
- * Component used to build display components that should respond to whether the
- * component is currently pressed or not.
+ * A Core Component wrapper that can detect various stages of press
+ * interactions on any of its defined children.
+ *
+ * @see https://reactnative.dev/docs/pressable
  */
 function Pressable({
   ref: forwardedRef,
   ...props
 }: {
-  ref?: React.RefSetter<Instance>,
+  ref?: React.RefSetter<PressableInstance>,
   ...PressableProps,
 }): React.Node {
   const {
@@ -245,7 +267,7 @@ function Pressable({
     ...restProps
   } = props;
 
-  const viewRef = useRef<Instance | null>(null);
+  const viewRef = useRef<PressableInstance | null>(null);
   const mergedRef = useMergeRefs(forwardedRef, viewRef);
 
   const android_rippleConfig = useAndroidRippleForView(android_ripple, viewRef);
@@ -412,6 +434,6 @@ const MemoedPressable = memo(Pressable);
 MemoedPressable.displayName = 'Pressable';
 
 export default MemoedPressable as component(
-  ref?: React.RefSetter<React.ElementRef<typeof View>>,
+  ref?: React.RefSetter<PressableInstance>,
   ...props: PressableProps
 );

package/Libraries/Components/ProgressBarAndroid/ProgressBarAndroid.android.js

@@ -8,12 +8,15 @@
  * @format
  */
 
+import type {HostInstance} from '../../../src/private/types/HostInstance';
 import type {ProgressBarAndroidProps} from './ProgressBarAndroidTypes';
 
 import ProgressBarAndroidNativeComponent from './ProgressBarAndroidNativeComponent';
 
 const React = require('react');
 
+export type ProgressBarAndroidInstance = HostInstance;
+
 export type {ProgressBarAndroidProps};
 
 /**
@@ -40,9 +43,7 @@ export type {ProgressBarAndroidProps};
  * ```
  */
 const ProgressBarAndroid: component(
-  ref?: React.RefSetter<
-    React.ElementRef<typeof ProgressBarAndroidNativeComponent>,
-  >,
+  ref?: React.RefSetter<ProgressBarAndroidInstance>,
   ...props: ProgressBarAndroidProps
 ) = function ProgressBarAndroid({
   ref: forwardedRef,
@@ -52,9 +53,7 @@ const ProgressBarAndroid: component(
   animating = true,
   ...restProps
 }: {
-  ref?: React.RefSetter<
-    React.ElementRef<typeof ProgressBarAndroidNativeComponent>,
-  >,
+  ref?: React.RefSetter<ProgressBarAndroidInstance>,
   ...ProgressBarAndroidProps,
 }) {
   return (

package/Libraries/Components/ProgressBarAndroid/ProgressBarAndroid.js

@@ -10,11 +10,13 @@
 
 'use strict';
 
-import typeof ProgressBarAndroidNativeComponentType from './ProgressBarAndroidNativeComponent';
+import type {HostInstance} from '../../../src/private/types/HostInstance';
 import type {ProgressBarAndroidProps} from './ProgressBarAndroidTypes';
 
 import Platform from '../../Utilities/Platform';
 
+export type ProgressBarAndroidInstance = HostInstance;
+
 export type {ProgressBarAndroidProps};
 
 // A utility type to preserve the semantics of the union uses in the definition
@@ -30,9 +32,7 @@ type Omit<T, K> = T extends any ? Pick<T, Exclude<keyof T, K>> : T;
  * @deprecated
  */
 let ProgressBarAndroid: component(
-  ref?: React.RefSetter<
-    React.ElementRef<ProgressBarAndroidNativeComponentType>,
-  >,
+  ref?: React.RefSetter<ProgressBarAndroidInstance>,
   ...props: Omit<ProgressBarAndroidProps, empty>
 );
 

package/Libraries/Components/ProgressBarAndroid/ProgressBarAndroidNativeComponent.js

@@ -8,5 +8,5 @@
  * @format
  */
 
-export * from '../../../src/private/specs_DEPRECATED/components/ProgressBarAndroidNativeComponent';
-export {default} from '../../../src/private/specs_DEPRECATED/components/ProgressBarAndroidNativeComponent';
+export * from '../../../src/private/components/progressbarandroid/specs/ProgressBarAndroidNativeComponent';
+export {default} from '../../../src/private/components/progressbarandroid/specs/ProgressBarAndroidNativeComponent';

package/Libraries/Components/ProgressBarAndroid/ProgressBarAndroidTypes.js

@@ -20,10 +20,23 @@ import type {ViewProps} from '../View/ViewPropTypes';
 type DeterminateProgressBarAndroidStyleAttrProp = {
   styleAttr: 'Horizontal',
   indeterminate: false,
+  /**
+   * The progress value (between 0 and 1).
+   */
   progress: number,
 };
 
 type IndeterminateProgressBarAndroidStyleAttrProp = {
+  /**
+   * Style of the ProgressBar. One of:
+   *     Horizontal
+   *     Normal (default)
+   *     Small
+   *     Large
+   *     Inverse
+   *     SmallInverse
+   *     LargeInverse
+   */
   styleAttr:
     | 'Horizontal'
     | 'Normal'
@@ -32,6 +45,10 @@ type IndeterminateProgressBarAndroidStyleAttrProp = {
     | 'Inverse'
     | 'SmallInverse'
     | 'LargeInverse',
+  /**
+   * If the progress bar will show indeterminate progress.
+   * Note that this can only be false if styleAttr is Horizontal.
+   */
   indeterminate: true,
 };
 

package/Libraries/Components/RefreshControl/AndroidSwipeRefreshLayoutNativeComponent.js

@@ -8,5 +8,5 @@
  * @format
  */
 
-export * from '../../../src/private/specs_DEPRECATED/components/AndroidSwipeRefreshLayoutNativeComponent';
-export {default} from '../../../src/private/specs_DEPRECATED/components/AndroidSwipeRefreshLayoutNativeComponent';
+export * from '../../../src/private/components/refreshcontrol/specs/AndroidSwipeRefreshLayoutNativeComponent';
+export {default} from '../../../src/private/components/refreshcontrol/specs/AndroidSwipeRefreshLayoutNativeComponent';

package/Libraries/Components/RefreshControl/PullToRefreshViewNativeComponent.js

@@ -8,7 +8,7 @@
  * @format
  */
 
-export * from '../../../src/private/specs_DEPRECATED/components/PullToRefreshViewNativeComponent';
-import PullToRefreshViewNativeComponent from '../../../src/private/specs_DEPRECATED/components/PullToRefreshViewNativeComponent';
+export * from '../../../src/private/components/refreshcontrol/specs/PullToRefreshViewNativeComponent';
+import PullToRefreshViewNativeComponent from '../../../src/private/components/refreshcontrol/specs/PullToRefreshViewNativeComponent';
 
 export default PullToRefreshViewNativeComponent;

package/Libraries/Components/RefreshControl/RefreshControl.js

@@ -24,33 +24,53 @@ const Platform = require('../../Utilities/Platform').default;
 export type RefreshControlPropsIOS = Readonly<{
   /**
    * The color of the refresh indicator.
+   *
+   * @platform ios
    */
   tintColor?: ?ColorValue,
-  /**
-   * Title color.
-   */
-  titleColor?: ?ColorValue,
+
   /**
    * The title displayed under the refresh indicator.
+   *
+   * @platform ios
    */
   title?: ?string,
-}>;
 
-export type RefreshControlPropsAndroid = Readonly<{
   /**
-   * Whether the pull to refresh functionality is enabled.
+   * The color of the refresh indicator title.
+   *
+   * @platform ios
    */
-  enabled?: ?boolean,
+  titleColor?: ?ColorValue,
+}>;
+
+export type RefreshControlPropsAndroid = Readonly<{
   /**
    * The colors (at least one) that will be used to draw the refresh indicator.
+   *
+   * @platform android
    */
   colors?: ?ReadonlyArray<ColorValue>,
+
+  /**
+   * Whether the pull to refresh functionality is enabled.
+   *
+   * @default `true`
+   * @platform android
+   */
+  enabled?: ?boolean,
+
   /**
    * The background color of the refresh indicator.
+   *
+   * @platform android
    */
   progressBackgroundColor?: ?ColorValue,
+
   /**
    * Size of the refresh indicator.
+   *
+   * @platform android
    */
   size?: ?('default' | 'large'),
 }>;
@@ -67,11 +87,14 @@ type RefreshControlBaseProps = Readonly<{
   refreshing: boolean,
 
   /**
-   * Progress view top offset
+   * Progress view top offset.
+   *
+   * @default `0`
    */
   progressViewOffset?: ?number,
 }>;
 
+/** @build-types emit-as-interface Uniwind compatibility */
 export type RefreshControlProps = Readonly<{
   ...ViewProps,
   ...RefreshControlPropsIOS,
@@ -80,49 +103,14 @@ export type RefreshControlProps = Readonly<{
 }>;
 
 /**
- * This component is used inside a ScrollView or ListView to add pull to refresh
- * functionality. When the ScrollView is at `scrollY: 0`, swiping down
- * triggers an `onRefresh` event.
- *
- * ### Usage example
- *
- * ``` js
- * class RefreshableList extends Component {
- *   constructor(props) {
- *     super(props);
- *     this.state = {
- *       refreshing: false,
- *     };
- *   }
+ * Used inside a `ScrollView` to add pull to refresh functionality. When the
+ * `ScrollView` is at `scrollY: 0`, swiping down triggers an `onRefresh` event.
  *
- *   _onRefresh() {
- *     this.setState({refreshing: true});
- *     fetchData().then(() => {
- *       this.setState({refreshing: false});
- *     });
- *   }
+ * **Note:** `refreshing` is a controlled prop, this is why it needs to be set
+ * to `true` in the `onRefresh` function otherwise the refresh indicator will
+ * stop immediately.
  *
- *   render() {
- *     return (
- *       <ListView
- *         refreshControl={
- *           <RefreshControl
- *             refreshing={this.state.refreshing}
- *             onRefresh={this._onRefresh.bind(this)}
- *           />
- *         }
- *         ...
- *       >
- *       ...
- *       </ListView>
- *     );
- *   }
- *   ...
- * }
- * ```
- *
- * __Note:__ `refreshing` is a controlled prop, this is why it needs to be set to true
- * in the `onRefresh` function otherwise the refresh indicator will stop immediately.
+ * @see https://reactnative.dev/docs/refreshcontrol
  */
 class RefreshControl extends React.Component<RefreshControlProps> {
   _nativeRef: ?React.ElementRef<
@@ -204,4 +192,6 @@ class RefreshControl extends React.Component<RefreshControlProps> {
   };
 }
 
+export type RefreshControlInstance = RefreshControl;
+
 export default RefreshControl;

package/Libraries/Components/SafeAreaView/RCTSafeAreaViewNativeComponent.js

@@ -8,5 +8,5 @@
  * @format
  */
 
-export * from '../../../src/private/specs_DEPRECATED/components/RCTSafeAreaViewNativeComponent';
-export {default} from '../../../src/private/specs_DEPRECATED/components/RCTSafeAreaViewNativeComponent';
+export * from '../../../src/private/components/safeareaview/specs/RCTSafeAreaViewNativeComponent';
+export {default} from '../../../src/private/components/safeareaview/specs/RCTSafeAreaViewNativeComponent';

package/Libraries/Components/SafeAreaView/SafeAreaView.js

@@ -8,24 +8,24 @@
  * @format
  */
 
+import type {HostInstance} from '../../../src/private/types/HostInstance';
 import type {ViewProps} from '../View/ViewPropTypes';
 
 import Platform from '../../Utilities/Platform';
 import View from '../View/View';
 import * as React from 'react';
 
+export type SafeAreaViewInstance = HostInstance;
+
 /**
- * Renders nested content and automatically applies paddings reflect the portion
- * of the view that is not covered by navigation bars, tab bars, toolbars, and
- * other ancestor views.
+ * Renders content within the safe area boundaries of a device. Currently only applicable to iOS devices with iOS version 11 or later. Automatically applies padding to reflect the portion of the view not covered by navigation bars, tab bars, toolbars, and other ancestor views.
  *
- * Moreover, and most importantly, Safe Area's paddings reflect physical
- * limitation of the screen, such as rounded corners or camera notches (aka
- * sensor housing area on iPhone X).
- * @deprecated Use `react-native-safe-area-context` instead. This component will be removed in a future release.
+ * @see https://reactnative.dev/docs/safeareaview
+ * @deprecated Use `react-native-safe-area-context` instead.
+ * @platform ios
  */
 const SafeAreaView: component(
-  ref?: React.RefSetter<React.ElementRef<typeof View>>,
+  ref?: React.RefSetter<SafeAreaViewInstance>,
   ...props: ViewProps
 ) = Platform.select({
   ios: require('./RCTSafeAreaViewNativeComponent').default,