Skip to content

Align to canonical *Instance types in component ref annotations (#56951)#56951

Closed
huntie wants to merge 6 commits into
facebook:mainfrom
huntie:export-D106144380
Closed

Align to canonical *Instance types in component ref annotations (#56951)#56951
huntie wants to merge 6 commits into
facebook:mainfrom
huntie:export-D106144380

Conversation

@huntie
Copy link
Copy Markdown
Member

@huntie huntie commented May 23, 2026

Summary:

Update all ref parameters, ref-returning props, and useRef calls in built-in components to use the canonical *Instance types introduced in the previous diff.

As a side benefit, using these now-edge APIs means we can eliminate a number of deeper internal types from the public API surface (see API snapshot updates).

Changes

  • Replace inline React.ElementRef<typeof NativeComponent> patterns with the canonical *Instance type in each component declaration and its inline destructuring type.
  • Replace useRef<React.ElementRef<...>> with useRef<*Instance> (Pressable, Switch).
  • Replace hostRef prop types with the component *Instance type (TouchableHighlight, TouchableOpacity).
  • Update ModalBaseProps.modalRef and ModalRefProps.ref from deprecated PublicModalInstance to ModalInstance.

Removed aliases

  • ButtonRef (Button.js) — inlined into ButtonInstance
  • SwitchRef (Switch.js) — replaced by SwitchInstance
  • TextForwardRef (Text.js) — replaced by TextInstance
  • type Instance (Pressable.js) — replaced by PressableInstance
  • HostComponent<empty> import (ActivityIndicator.js) — no longer needed
  • ProgressBarAndroidNativeComponentType typeof import (ProgressBarAndroid.js) — no longer needed

Changelog: [Internal]

Reviewed By: rubennorte

Differential Revision: D106144380

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 23, 2026
@github-actions
Copy link
Copy Markdown

Warning

JavaScript API change detected

This PR commits an update to ReactNativeApi.d.ts, indicating a change to React Native's public JavaScript API.

  • Please include a clear changelog message.
  • This change will be subject to additional review.

This change was flagged as: POTENTIALLY_BREAKING

@meta-codesync
Copy link
Copy Markdown

meta-codesync Bot commented May 23, 2026

@huntie has exported this pull request. If you are a Meta employee, you can view the originating Diff in D106144380.

huntie added 4 commits June 2, 2026 09:26
Summary:
Pull Request resolved: facebook#56950

Add `pointerEvents` to `TextProps` in the Flow source. This prop is supported at the native layer — `BaseParagraphProps` (the C++ props struct for Text/Paragraph) extends `ViewProps`, which includes `pointerEvents`. The old hand-written TypeScript types (`Text.d.ts`) already declared this prop, but the Flow source did not, causing a gap in the auto-generated strict API types (`types_generated`).

Changelog:
[General][Fixed] - **Strict TypeScript API**: Add missing `pointerEvents` prop to `Text` component

Differential Revision: D106183960
Summary:
Pull Request resolved: facebook#57047

**Motivation**

`NativeDialogManagerAndroid` is an internal native module used by `Alert` and `PermissionsAndroid` on Android, not an intended root React Native public API.

**Notes**

- `NativeDialogManagerAndroid` wasn't defined on our manual public TypeScript types — so was never discoverable via TypeScript auto-import.
- Appears unused by open source consumers with public code on GitHub ([search](https://github.com/search?type=code&q=NativeDialogManagerAndroid++NOT+is%3Aarchived+NOT+is%3Afork+language%3ATypeScript&l=TypeScript⁄)).

Changelog:
[General][Breaking] - The `NativeDialogManagerAndroid` export is removed.

Differential Revision: D107250968
Summary:
Also update the already deprecated `NativeMethodsMixin` and `NativeMethodsMixinType` types to point to `HostInstance` as canonical.

Changelog:
[General][Deprecated] - The `NativeMethods` interface is deprecated. Use `HostInstance` instead.

Differential Revision: D107129358
Summary:
Actions the existing/pending deprecations in the preceding diff.

In our Flow source / Strict TypeScript API, the `NativeMethods` type was already deprecated (differing from D107119545).

Changelog:
[General][Breaking] - **Strict TypeScript API**: Remove legacy `NativeMethods` and `NativeMethodsMixin` types

Differential Revision: D107129357
huntie added a commit to huntie/react-native that referenced this pull request Jun 2, 2026
…book#56951)

Summary:
Pull Request resolved: facebook#56951

Update all ref parameters, ref-returning props, and `useRef` calls in built-in components to use the canonical `*Instance` types introduced in the previous diff.

As a side benefit, using these now-edge APIs means we can eliminate a number of deeper internal types from the public API surface (see API snapshot updates).

#### Changes

- Replace inline `React.ElementRef<typeof NativeComponent>` patterns with the canonical `*Instance` type in each component declaration and its inline destructuring type.
- Replace `useRef<React.ElementRef<...>>` with `useRef<*Instance>` (Pressable, Switch).
- Replace `hostRef` prop types with the component `*Instance` type (TouchableHighlight, TouchableOpacity).
- Update `ModalBaseProps.modalRef` and `ModalRefProps.ref` from deprecated `PublicModalInstance` to `ModalInstance`.

#### Removed aliases

- `ButtonRef` (Button.js) — inlined into `ButtonInstance`
- `SwitchRef` (Switch.js) — replaced by `SwitchInstance`
- `TextForwardRef` (Text.js) — replaced by `TextInstance`
- `type Instance` (Pressable.js) — replaced by `PressableInstance`
- `HostComponent<empty>` import (ActivityIndicator.js) — no longer needed
- `ProgressBarAndroidNativeComponentType` typeof import (ProgressBarAndroid.js) — no longer needed

Changelog: [Internal]

Differential Revision: D106144380
@meta-codesync meta-codesync Bot changed the title Align to canonical *Instance types in component ref annotations Align to canonical *Instance types in component ref annotations (#56951) Jun 2, 2026
@huntie huntie force-pushed the export-D106144380 branch from 2bd1868 to 077dc5a Compare June 2, 2026 17:01
Summary:
Add a publicly exported `*Instance` type for every built-in component in `index.js.flow`, giving consumers a consistent way to type refs for any React Native component.

Affects the Strict TypeScript API (opt-in generated TS types) only.

#### Motivation + RFC

Draft implementation for the recommended approach in react-native-community/discussions-and-proposals#1003.

Alternative to facebook#56673.

#### New types

| Component | Instance Type | Type Value |
|---|---|---|
| `ActivityIndicator` | `ActivityIndicatorInstance` | `HostInstance` |
| `Button` | `ButtonInstance` | `ButtonRef` (platform-dependent) |
| `DrawerLayoutAndroid` | `DrawerLayoutAndroidInstance` | `DrawerLayoutAndroidMethods` |
| `FlatList` | `FlatListInstance` | `FlatList<>` |
| `Image` | `ImageInstance` | `HostInstance` |
| `ImageBackground` | `ImageBackgroundInstance` | `ImageBackground` (class) |
| `KeyboardAvoidingView` | `KeyboardAvoidingViewInstance` | `KeyboardAvoidingView` (class) |
| `Modal` | `ModalInstance` | `HostInstance` |
| `Pressable` | `PressableInstance` | `HostInstance` |
| `ProgressBarAndroid` | `ProgressBarAndroidInstance` | `HostInstance` |
| `RefreshControl` | `RefreshControlInstance` | `RefreshControl` (class) |
| `SafeAreaView` | `SafeAreaViewInstance` | `HostInstance` |
| `ScrollView` | `ScrollViewInstance` | `extends HostInstance, ScrollViewImperativeMethods` |
| `SectionList` | `SectionListInstance` | `SectionList<>` |
| `StatusBar` | `StatusBarInstance` | `StatusBar` (class) |
| `Switch` | `SwitchInstance` | `HostInstance` |
| `Text` | `TextInstance` | `HostInstance` |
| `TextInput` | `TextInputInstance` | `extends ReactNativeElement` (existing) |
| `TouchableHighlight` | `TouchableHighlightInstance` | `HostInstance` |
| `TouchableNativeFeedback` | `TouchableNativeFeedbackInstance` | `TouchableNativeFeedback` (class) |
| `TouchableOpacity` | `TouchableOpacityInstance` | `HostInstance` |
| `View` | `ViewInstance` | `HostInstance` |
| `VirtualizedList` | `VirtualizedListInstance` | `React.ElementRef<VirtualizedListType>` |
| `VirtualizedSectionList` | `VirtualizedSectionListInstance` | `React.ElementRef<VirtualizedSectionListType>` |

#### Renames

- `PublicScrollViewInstance` → `ScrollViewInstance` (old name kept as deprecated alias; internal usages in `ScrollView.js` and `FlatList.js` updated)
- `PublicModalInstance` → `ModalInstance` (old name kept as deprecated alias)

#### Skipped (no ref support)

`InputAccessoryView`, `experimental_LayoutConformance`, `TouchableWithoutFeedback`, `Touchable` (namespace)

Changelog:
[General][Added] - **Strict TypeScript API**: Add `*Instance` ref types for all built-in components

Differential Revision: D106144383
huntie added a commit to huntie/react-native that referenced this pull request Jun 2, 2026
…book#56951)

Summary:
Pull Request resolved: facebook#56951

Update all ref parameters, ref-returning props, and `useRef` calls in built-in components to use the canonical `*Instance` types introduced in the previous diff.

As a side benefit, using these now-edge APIs means we can eliminate a number of deeper internal types from the public API surface (see API snapshot updates).

#### Changes

- Replace inline `React.ElementRef<typeof NativeComponent>` patterns with the canonical `*Instance` type in each component declaration and its inline destructuring type.
- Replace `useRef<React.ElementRef<...>>` with `useRef<*Instance>` (Pressable, Switch).
- Replace `hostRef` prop types with the component `*Instance` type (TouchableHighlight, TouchableOpacity).
- Update `ModalBaseProps.modalRef` and `ModalRefProps.ref` from deprecated `PublicModalInstance` to `ModalInstance`.

#### Removed aliases

- `ButtonRef` (Button.js) — inlined into `ButtonInstance`
- `SwitchRef` (Switch.js) — replaced by `SwitchInstance`
- `TextForwardRef` (Text.js) — replaced by `TextInstance`
- `type Instance` (Pressable.js) — replaced by `PressableInstance`
- `HostComponent<empty>` import (ActivityIndicator.js) — no longer needed
- `ProgressBarAndroidNativeComponentType` typeof import (ProgressBarAndroid.js) — no longer needed

Changelog: [Internal]

Reviewed By: rubennorte

Differential Revision: D106144380
@huntie huntie force-pushed the export-D106144380 branch from 077dc5a to 1bed930 Compare June 2, 2026 17:49
…book#56951)

Summary:
Pull Request resolved: facebook#56951

Update all ref parameters, ref-returning props, and `useRef` calls in built-in components to use the canonical `*Instance` types introduced in the previous diff.

As a side benefit, using these now-edge APIs means we can eliminate a number of deeper internal types from the public API surface (see API snapshot updates).

#### Changes

- Replace inline `React.ElementRef<typeof NativeComponent>` patterns with the canonical `*Instance` type in each component declaration and its inline destructuring type.
- Replace `useRef<React.ElementRef<...>>` with `useRef<*Instance>` (Pressable, Switch).
- Replace `hostRef` prop types with the component `*Instance` type (TouchableHighlight, TouchableOpacity).
- Update `ModalBaseProps.modalRef` and `ModalRefProps.ref` from deprecated `PublicModalInstance` to `ModalInstance`.

#### Removed aliases

- `ButtonRef` (Button.js) — inlined into `ButtonInstance`
- `SwitchRef` (Switch.js) — replaced by `SwitchInstance`
- `TextForwardRef` (Text.js) — replaced by `TextInstance`
- `type Instance` (Pressable.js) — replaced by `PressableInstance`
- `HostComponent<empty>` import (ActivityIndicator.js) — no longer needed
- `ProgressBarAndroidNativeComponentType` typeof import (ProgressBarAndroid.js) — no longer needed

Changelog: [Internal]

Reviewed By: rubennorte

Differential Revision: D106144380
@huntie huntie force-pushed the export-D106144380 branch from 1bed930 to 77a1b53 Compare June 2, 2026 17:55
@meta-codesync meta-codesync Bot closed this in 1a4a139 Jun 2, 2026
@facebook-github-tools facebook-github-tools Bot added the Merged This PR has been merged. label Jun 2, 2026
@meta-codesync
Copy link
Copy Markdown

meta-codesync Bot commented Jun 2, 2026

This pull request has been merged in 1a4a139.

@huntie huntie deleted the export-D106144380 branch June 2, 2026 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. fb-exported Merged This PR has been merged. meta-exported p: Facebook Partner: Facebook Partner

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant