Apple TV and Android TV support for React Native are maintained here and in the corresponding react-native-tvos NPM package, and not in the core repo. This is a full fork of the main repository, with only the changes needed to support Apple TV and Android TV.
Releases of react-native-tvos will be based on a public release of react-native; e.g. the 0.74.0-0 release of this package will be derived from the 0.74.0 release of react-native. All releases of this repo will follow the 0.xx.x-y format, where x digits are from a specific RN core release, and y represents the additional versioning from this repo.
Releases will be published on npmjs.org and you may find the latest release version here: https://www.npmjs.com/package/react-native-tvos?activeTab=versions or use the tag @latest
You will find the relevant tvOS support and maintenance within the branches marked tvos-v0.xx.x;
To build your project for Apple TV, you should change your package.json imports to import react-native as follows, so that this package is used instead of the core react-native package.
"react-native": "npm:react-native-tvos@latest",You cannot use this package and the core react-native package simultaneously in a project.
This README covers only TV-specific features. For more general documentation and for changes between versions, you should also see these resources:
- React Native documentation: https://reactnative.dev
- The React Native changelog: https://github.com/facebook/react-native/blob/main/CHANGELOG.md
As of the 0.71 release, Hermes is fully working on both Apple TV and Android TV, and is enabled by default.
- Apple TV: Modify your app's Podfile to set the
:fabric_enabledvalue totruein both iOS and tvOS targets. After that, runpod installto pick up the additional pods needed for the new architecture. Some components (TVTextScrollView, TabBarIOS) have not been reimplemented in the new architecture so they will show up as an "unimplemented component". - Android TV: To enable Fabric, modify
android/gradle.propertiesin your app and setnewArchEnabled=true, then rebuild your app.
As of the 0.74 release, bridgeless is the default when Fabric is enabled.
Known issue: The TVFocusGuide autofocus API has problems on Apple TV when bridgeless is enabled. If you need to use Fabric without bridgeless on Apple TV, you can override the default by adding the method below in AppDelegate.mm:
- (BOOL)bridgelessEnabled
{
return false;
}Typescript types for TV-specific components and APIs have been added to types/public.
TV device support has been implemented with the intention of making existing React Native applications "just work" on TV, with few or no changes needed in the JavaScript code for the applications.
The RNTester app supports Apple TV and Android TV. In this repo, RNTester/Podfile and RNTester/RNTesterPods.xcodeproj have been modified to work for tvOS.
Minimum operating system versions:
- Apple TV: tvOS 13.4
- Android TV:
- API level 21 (for the 0.73 releases)
- API level 23 (for the 0.74 release)
- Native layer for Apple TV: React Native Xcode projects all now have Apple TV build targets, with names ending in the string '-tvOS'. Changes in the React Native podspecs in 0.73 now require that your application
Podfileonly have one target. This repo supports either an iOS target or a tvOS target, but both targets should not be active at the same time. The new app template now has the iOS target commented out. - Maven artifacts for Android TV: In 0.71 and later releases, the React Native Android prebuilt archives are published to Maven instead of being included in the NPM. We are following the same model, except that the Maven artifacts will be in group
io.github.react-native-tvosinstead ofcom.facebook.react. The@react-native/gradle-pluginmodule has been upgraded so that the Android dependencies will be detected correctly during build.
Pitfall: Make sure you do not globally install
react-nativeorreact-native-tvos. If you have done this the wrong way, you may get error messages likeld: library not found for -lPods-TestApp-tvOS.
We strongly recommend Yarn as the package manager.
You should install yarn globally, as it should be used instead of npm for working in React Native projects.
To create a new project, use yarn create react-native-app as shown below. (This will install the Expo tool create-react-native-app for you if it is not already present.)
New projects created this way will automatically have properly configured iPhone and Apple TV targets created in their XCode projects, and will have the Android manifest correctly configured for both Android phone and Android TV. New projects are set up to use the Expo CLI; the Expo dependency and react-native.config.js are included in the new app template.
# Init an app called 'TestApp', note that you must not be in a node module (directory with node_modules sub-directory) for this to work
yarn create react-native-app TestApp --template https://github.com/react-native-tvos/react-native-template-typescript-tv/tree/tv-release-0.73.0 --template-path template
cd TestApp
# Now build and start the app in the tvOS Simulator - this will only work on a macOS machine.
# This command can also be run via "yarn tvos".
npx expo run:ios --scheme MyApp-tvOS --device "Apple TV"
# You can also build and start the app on an iOS phone simulator.
# This command can also be run via "yarn ios".
npx expo run:ios
# or specify a simulator:
npx expo run:ios --scheme MyApp --device "iPhone 15"
# This command builds and starts the app in an Android TV emulator or a phone emulator (needs to be created in advance).
# This command can also be run via "yarn android".
npx expo run:android --device tv_api_31See this document for more details on Expo CLI functionality. (Note that many of these features require that Expo SDK modules be built into your app. Expo SDK support requires a different project configuration as described below.)
See the Building Expo apps for TV guide from Expo for details, including supported Expo modules and limitations.
Expo SDK 50 or greater, and react-native-tvos 0.73.x or later, are required.
The template contains an example Metro configuration that allows Metro to resolve application source files with TV-specific code, indicated by specific file extensions (e.g. *.ios.tv.tsx, *.android.tv.tsx, *.tv.tsx). The config will work the same way with the other standard source file extensions (.js, etc.), as documented in Metro docs
When this is enabled, Metro will resolve files in the following order of preference (and similarly for the other supported file extensions):
file.ios.tv.tsxorfile.android.tv.tsxfile.tv.tsxfile.ios.tsxorfile.android.tsxfile.tsx
This config is not enabled by default, since it will impact bundling performance, but is available for developers who need this capability.
- JavaScript layer: Support for TV has been added to the
PlatformReact Native API.
var Platform = require('Platform');
var running_on_tv = Platform.isTV;
// If you want to be more specific and only detect devices running tvOS
// (but no Android TV devices) you can use:
var running_on_apple_tv = Platform.isTVOS;-
Common codebase for iOS and tvOS: Since tvOS and iOS share most Objective-C and JavaScript code in common, most documentation for iOS applies equally to tvOS. Apple TV specific changes in native code are all wrapped by the TARGET_OS_TV define. These include changes to suppress APIs that are not supported on tvOS (e.g. web views, sliders, switches, status bar, etc.), and changes to support user input from the TV remote or keyboard.
-
Common codebase for Android phone and Android TV: Apps built for Android using this repo will run on both Android phone and Android TV. Most of the changes for TV are specific to handling focus-based navigation on a TV using the D-Pad on the remote control.
-
Access to touchable controls: The
Touchablemixin has code added to detect focus changes and use existing methods to style the components properly and initiate the proper actions when the view is selected using the TV remote, soTouchableWithoutFeedback,TouchableHighlightandTouchableOpacitywill "just work" on both Apple TV and Android TV. In particular:onFocuswill be executed when the touchable view goes into focusonBlurwill be executed when the touchable view goes out of focusonPresswill be executed when the touchable view is actually selected by pressing the "select" button on the TV remote (center button on Apple TV remote, or center button on Android TV DPad).onLongPresswill be executed twice if the "select" button is held down for a length of time. The two events passed intoonLongPress()will have different values for theireventKeyActionproperty, 0 for key down (start) and 1 for key up (end).
-
Pressable controls: The
PressableAPI works with TV. AdditionalonFocusandonBlurprops are provided to allow you to customize behavior when a Pressable enters or leaves focus. Similar to thepressedstate that is true while a user is pressing the component on a touchscreen, thefocusedstate will be true when it is focused on TV.PressableExamplein RNTester has been modified appropriately. TheonPress()andonLongPress()methods work the same way as withTouchablecomponents. -
TV remote/keyboard input: Application code that needs to implement custom handling of TV remote events can create an instance of
TVEventHandlerand listen for these events. For a more convenient API, we provideuseTVEventHandler.
import { TVEventHandler, useTVEventHandler } from 'react-native';
// Functional component
const TVEventHandlerView: () => React.Node = () => {
const [lastEventType, setLastEventType] = React.useState('');
const myTVEventHandler = evt => {
setLastEventType(evt.eventType);
};
useTVEventHandler(myTVEventHandler);
return (
<View>
<TouchableOpacity onPress={() => {}}>
<Text>
This example enables an instance of TVEventHandler to show the last
event detected from the Apple TV Siri remote or from a keyboard.
</Text>
</TouchableOpacity>
<Text style={{color: 'blue'}}>{lastEventType}</Text>
</View>
);
};
// Class based component
class Game2048 extends React.Component {
_tvEventHandler: any;
_enableTVEventHandler() {
this._tvEventHandler = new TVEventHandler();
this._tvEventHandler.enable(this, function(cmp, evt) {
if (evt && evt.eventType === 'right') {
cmp.setState({board: cmp.state.board.move(2)});
} else if(evt && evt.eventType === 'up') {
cmp.setState({board: cmp.state.board.move(1)});
} else if(evt && evt.eventType === 'left') {
cmp.setState({board: cmp.state.board.move(0)});
} else if(evt && evt.eventType === 'down') {
cmp.setState({board: cmp.state.board.move(3)});
} else if(evt && evt.eventType === 'playPause') {
cmp.restartGame();
}
});
}
_disableTVEventHandler() {
if (this._tvEventHandler) {
this._tvEventHandler.disable();
delete this._tvEventHandler;
}
}
componentDidMount() {
this._enableTVEventHandler();
}
componentWillUnmount() {
this._disableTVEventHandler();
}-
Flipper: We do not support Flipper.
-
LogBox: The LogBox error/warning display (which replaced YellowBox in 0.63) is working as expected on TV platforms, after a few adjustments to make the controls accessible to the focus engine.
-
Dev Menu support: On the Apple TV simulator, cmd-D will bring up the developer menu, just like on iOS. To bring it up on a real Apple TV device, make a long press on the play/pause button on the remote. (Please do not shake the Apple TV device, that will not work :) ). Android TV dev menu behavior is the same as on Android phone.
-
TV remote animations on Apple TV:
RCTTVViewnative code implements Apple-recommended parallax animations to help guide the eye as the user navigates through views. The animations can be disabled or adjusted with new optional view properties. -
Back navigation with the TV remote menu button: The
BackHandlercomponent, originally written to support the Android back button, now also supports back navigation on the Apple TV using the menu button or '<' button on the Apple TV remote, and the back button as usual on Android TV remote. -
TVEventControl for AppleTV: (Formerly "TVMenuControl") This module provides methods to enable and disable features on the Apple TV Siri remote:
enableTVMenuKey/disableTVMenuKey: Method to enable and disable the menu key gesture recognizer, in order to fix an issue with Apple's guidelines for menu key navigation (see facebook/react-native#18930). TheRNTesterapp uses these methods to implement correct menu key behavior for back navigation.enableTVPanGesture/disableTVPanGesture: Methods to enable and disable detection of finger touches that pan across the touch surface of the Siri remote. SeeTVEventHandlerExamplein theRNTesterapp for a demo.enableGestureHandlersCancelTouches/disableGestureHandlersCancelTouches: Methods to turn on and turn off cancellation of touches by the gesture handlers inRCTTVRemoteHandler(see #366). Cancellation of touches is turned on (enabled) by default in 0.69 and earlier releases.
-
TVFocusGuideView: This component provides support for Apple's
UIFocusGuideAPI and is implemented in the same way for Android TV, to help ensure that focusable controls can be navigated to, even if they are not directly in line with other controls. An example is provided inRNTesterthat shows two different ways of using this component.Prop Value Description destinations any[]? Array of Components to register as destinations of the FocusGuideViewautoFocus boolean? If true, TVFocusGuidewill automatically manage focus for you. It will redirect the focus to the first focusable child on the first visit. It also remembers the last focused child and redirects the focus to it on the subsequent visits.destinationsprop takes precedence over this prop when used together.focusable boolean? When set to false, this view and all its subviews will be NOT focusable. trapFocus* (Up, Down, Left, Right) Prevents focus escaping from the container for the given directions. More information on the focus handling improvements above can be found in this article.
-
Next Focus Direction: the props
nextFocus*onViewshould work as expected on iOS too (previously android only). One caveat is that if there is no focusable in thenextFocusable*direction next to the starting view, iOS doesn't check if we want to override the destination. -
TVTextScrollView: On Apple TV, a ScrollView will not scroll unless there are focusable items inside it or above/below it. This component wraps ScrollView and uses tvOS-specific native code to allow scrolling using swipe gestures from the remote control.
-
-
VirtualizedList: We extend
VirtualizedListto make virtualization work well with focus management in mind. All of the improvements that we made are automatically available to all the VirtualizedList based components such asFlatList.- Defaults
- VirtualizeList contents are automatically wrapped with a
TVFocusGuideViewwithtrapFocus*properties enabled depending on the orientation of the list. This default makes sure that focus doesn't leave the list accidentally due to a virtualization issue etc. until reaching the beginning or the end of the list.
- VirtualizeList contents are automatically wrapped with a
New Props:
Prop Value Description additionalRenderRegions {first: number; last: number;}[]? Array of RenderRegionsthat allows you to define regions in the list that are not subject to virtualization, ensuring they are always rendered. This is particularly useful for preventing blank areas in critical parts of the list. These regions are rendered lazily after the initial render and are specified as an array of objects, each withfirstandlastindices marking the beginning and end of the non-virtualized region based on index. See the feature proposal for more context. - Defaults
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent