Align Flow with TS types and export relevant modules (#50322)

Summary:
Pull Request resolved: https://github.com/facebook/react-native/pull/50322

Changelog:
[Internal]

Reviewed By: huntie

Differential Revision: D71973327

fbshipit-source-id: ef3a6ad4c0ba6d32bfd1e4cc2ac8e0afac51e9fe
This commit is contained in:
Dawid Małecki
2025-03-28 02:47:22 -07:00
committed by Facebook GitHub Bot
parent 1f8d824e67
commit 6877263003
9 changed files with 87 additions and 22 deletions
@@ -43,7 +43,7 @@ type PressableBaseProps = $ReadOnly<{
* Either children or a render prop that receives a boolean reflecting whether
* the component is currently pressed.
*/
children: React.Node | ((state: PressableStateCallbackType) => React.Node),
children?: React.Node | ((state: PressableStateCallbackType) => React.Node),
/**
* Duration to wait after hover in before calling `onHoverIn`.
@@ -25,6 +25,8 @@ interface NativeModule {
}
export type {EventSubscription};
/** @deprecated Use `EventSubscription` instead. */
export type NativeEventSubscription = EventSubscription;
// $FlowFixMe[unclear-type] unclear type of events
type UnsafeObject = Object;
@@ -10,10 +10,10 @@
import type {
HostInstance,
LegacyHostInstanceMethods,
MeasureInWindowOnSuccessCallback,
MeasureLayoutOnSuccessCallback,
MeasureOnSuccessCallback,
NativeMethods,
} from '../../../src/private/types/HostInstance';
import type {
InternalInstanceHandle,
@@ -40,9 +40,7 @@ const noop = () => {};
/**
* This is used for refs on host components.
*/
export default class ReactFabricHostComponent
implements LegacyHostInstanceMethods
{
export default class ReactFabricHostComponent implements NativeMethods {
// These need to be accessible from `ReactFabricPublicInstanceUtils`.
__nativeTag: number;
__internalInstanceHandle: InternalInstanceHandle;
@@ -41,7 +41,7 @@ export type {
HostInstance as PublicInstance,
// These types are only necessary for Paper
LegacyHostInstanceMethods as LegacyPublicInstance,
NativeMethods as LegacyPublicInstance,
MeasureOnSuccessCallback,
MeasureInWindowOnSuccessCallback,
MeasureLayoutOnSuccessCallback,
@@ -1739,7 +1739,7 @@ export type PressableStateCallbackType = $ReadOnly<{
}>;
type PressableBaseProps = $ReadOnly<{
cancelable?: ?boolean,
children: React.Node | ((state: PressableStateCallbackType) => React.Node),
children?: React.Node | ((state: PressableStateCallbackType) => React.Node),
delayHoverIn?: ?number,
delayHoverOut?: ?number,
delayLongPress?: ?number,
@@ -4424,6 +4424,7 @@ exports[`public API should not change unintentionally Libraries/EventEmitter/Nat
removeListeners(count: number): void;
}
export type { EventSubscription };
export type NativeEventSubscription = EventSubscription;
type UnsafeObject = Object;
declare export default class NativeEventEmitter<
TEventToArgsMap: $ReadOnly<
@@ -7077,9 +7078,7 @@ declare export default typeof UIManagerJS;
`;
exports[`public API should not change unintentionally Libraries/ReactNative/ReactFabricPublicInstance/ReactFabricHostComponent.js 1`] = `
"declare export default class ReactFabricHostComponent
implements LegacyHostInstanceMethods
{
"declare export default class ReactFabricHostComponent implements NativeMethods {
constructor(
tag: number,
viewConfig: ViewConfig,
@@ -9305,7 +9304,8 @@ declare export default typeof rejectionTrackingOptions;
`;
exports[`public API should not change unintentionally Libraries/vendor/core/ErrorUtils.js 1`] = `
"declare export default ErrorUtilsT;
"export type ErrorUtils = ErrorUtilsT;
declare export default ErrorUtilsT;
"
`;
@@ -9575,6 +9575,7 @@ export { default as LogBox } from \\"./Libraries/LogBox/LogBox\\";
export { default as NativeAppEventEmitter } from \\"./Libraries/EventEmitter/RCTNativeAppEventEmitter\\";
export { default as NativeDialogManagerAndroid } from \\"./Libraries/NativeModules/specs/NativeDialogManagerAndroid\\";
export { default as NativeEventEmitter } from \\"./Libraries/EventEmitter/NativeEventEmitter\\";
export type { NativeEventSubscription } from \\"./Libraries/EventEmitter/NativeEventEmitter\\";
export { default as NativeModules } from \\"./Libraries/BatchedBridge/NativeModules\\";
export { default as Networking } from \\"./Libraries/Network/RCTNetworking\\";
export type {
@@ -9660,11 +9661,14 @@ export type {
export type * from \\"./Libraries/Types/CodegenTypesNamespace\\";
export type {
HostInstance,
NativeMethods,
MeasureInWindowOnSuccessCallback,
MeasureLayoutOnSuccessCallback,
MeasureOnSuccessCallback,
} from \\"./src/private/types/HostInstance\\";
export type { HostComponent } from \\"./src/private/types/HostComponent\\";
export type { ColorSchemeName } from \\"./src/private/specs_DEPRECATED/modules/NativeAppearance\\";
export type { ErrorUtils } from \\"./Libraries/vendor/core/ErrorUtils\\";
"
`;
@@ -9717,7 +9721,7 @@ export type MeasureLayoutOnSuccessCallback = (
width: number,
height: number
) => void;
export interface LegacyHostInstanceMethods {
export interface NativeMethods {
blur(): void;
focus(): void;
measure(callback: MeasureOnSuccessCallback): void;
@@ -9729,7 +9733,7 @@ export interface LegacyHostInstanceMethods {
): void;
setNativeProps(nativeProps: { ... }): void;
}
export type HostInstance = LegacyHostInstanceMethods;
export type HostInstance = NativeMethods;
"
`;
@@ -9758,7 +9762,7 @@ declare export function createReactNativeDocument(
exports[`public API should not change unintentionally src/private/webapis/dom/nodes/ReactNativeElement.js 1`] = `
"declare class ReactNativeElement
extends ReadOnlyElement
implements LegacyHostInstanceMethods
implements NativeMethods
{
constructor(
tag: number,
@@ -10,6 +10,8 @@
import type {ErrorUtilsT} from '@react-native/js-polyfills/error-guard';
export type ErrorUtils = ErrorUtilsT;
/**
* The particular require runtime that we are using looks for a global
* `ErrorUtils` object and if it exists, then it requires modules with the
+4
View File
@@ -296,6 +296,7 @@ export {default as NativeAppEventEmitter} from './Libraries/EventEmitter/RCTNati
export {default as NativeDialogManagerAndroid} from './Libraries/NativeModules/specs/NativeDialogManagerAndroid';
export {default as NativeEventEmitter} from './Libraries/EventEmitter/NativeEventEmitter';
export type {NativeEventSubscription} from './Libraries/EventEmitter/NativeEventEmitter';
export {default as NativeModules} from './Libraries/BatchedBridge/NativeModules';
export {default as Networking} from './Libraries/Network/RCTNetworking';
@@ -401,10 +402,13 @@ export type * from './Libraries/Types/CodegenTypesNamespace';
export type {
HostInstance,
NativeMethods,
MeasureInWindowOnSuccessCallback,
MeasureLayoutOnSuccessCallback,
MeasureOnSuccessCallback,
} from './src/private/types/HostInstance';
export type {HostComponent} from './src/private/types/HostComponent';
export type {ColorSchemeName} from './src/private/specs_DEPRECATED/modules/NativeAppearance';
export type {ErrorUtils} from './Libraries/vendor/core/ErrorUtils';
// #endregion
+61 -3
View File
@@ -32,19 +32,77 @@ export type MeasureLayoutOnSuccessCallback = (
) => void;
/**
* Current usages should migrate to this definition
* NativeMethods provides methods to access the underlying native component directly.
* This can be useful in cases when you want to focus a view or measure its on-screen dimensions,
* for example.
* The methods described here are available on most of the default components provided by React Native.
* Note, however, that they are not available on composite components that aren't directly backed by a
* native view. This will generally include most components that you define in your own app.
* For more information, see [Direct Manipulation](https://reactnative.dev/docs/direct-manipulation).
* @see https://github.com/facebook/react-native/blob/master/Libraries/Renderer/shims/ReactNativeTypes.js#L87
*/
export interface LegacyHostInstanceMethods {
export interface NativeMethods {
/**
* Removes focus from an input or view. This is the opposite of `focus()`.
*/
blur(): void;
/**
* Requests focus for the given input or view. The exact behavior triggered
* will depend on the platform and type of view.
*/
focus(): void;
/**
* Determines the location on screen, width, and height of the given view and
* returns the values via an async callback. If successful, the callback will
* be called with the following arguments:
*
* - x
* - y
* - width
* - height
* - pageX
* - pageY
*
* Note that these measurements are not available until after the rendering
* has been completed in native. If you need the measurements as soon as
* possible, consider using the [`onLayout`
* prop](docs/view.html#onlayout) instead.
*/
measure(callback: MeasureOnSuccessCallback): void;
/**
* Determines the location of the given view in the window and returns the
* values via an async callback. If the React root view is embedded in
* another native view, this will give you the absolute coordinates. If
* successful, the callback will be called with the following
* arguments:
*
* - x
* - y
* - width
* - height
*
* Note that these measurements are not available until after the rendering
* has been completed in native.
*/
measureInWindow(callback: MeasureInWindowOnSuccessCallback): void;
/**
* Like [`measure()`](#measure), but measures the view relative an ancestor,
* specified as `relativeToNativeComponentRef`. This means that the returned x, y
* are relative to the origin x, y of the ancestor view.
* _Can also be called with a relativeNativeNodeHandle but is deprecated._
*/
measureLayout(
relativeToNativeNode: number | HostInstance,
onSuccess: MeasureLayoutOnSuccessCallback,
onFail?: () => void,
): void;
/**
* This function sends props straight to native. They will not participate in
* future diff process - this means that if you do not include them in the
* next render, they will remain active (see [Direct
* Manipulation](https://reactnative.dev/docs/direct-manipulation)).
*/
setNativeProps(nativeProps: {...}): void;
}
export type HostInstance = LegacyHostInstanceMethods;
export type HostInstance = NativeMethods;
@@ -17,10 +17,10 @@ import type {
} from '../../../../../Libraries/Renderer/shims/ReactNativeTypes';
import type {
HostInstance,
LegacyHostInstanceMethods,
MeasureInWindowOnSuccessCallback,
MeasureLayoutOnSuccessCallback,
MeasureOnSuccessCallback,
NativeMethods,
} from '../../../types/HostInstance';
import type {InstanceHandle} from './internals/NodeInternals';
import type ReactNativeDocument from './ReactNativeDocument';
@@ -60,10 +60,7 @@ const noop = () => {};
// was slower than this method because the engine has to create an object than
// we then discard to create a new one.
class ReactNativeElement
extends ReadOnlyElement
implements LegacyHostInstanceMethods
{
class ReactNativeElement extends ReadOnlyElement implements NativeMethods {
// These need to be accessible from `ReactFabricPublicInstanceUtils`.
__nativeTag: number;
__internalInstanceHandle: InstanceHandle;