A framework for building native apps with React. http://facebook.github.io/react-native/
Go to file
Krzysztof Ciombor b7bb2e5745 Add support for Android TV devices
Summary:
<!--
Thank you for sending the PR! We appreciate you spending the time to work on these changes.

Help us understand your motivation by explaining why you decided to make this change.

You can learn more about contributing to React Native here: http://facebook.github.io/react-native/docs/contributing.html

Happy contributing!

-->

* To be on par with Apple TV support, this makes it possible to run React Native apps on Android TV devices (See also: https://react-native.canny.io/feature-requests/p/android-tv-support)
* These changes also make it possible to navigate through the app using D-PAD buttons that are present on some mobile devices
* Since these changes affect, among others, `ReactRootView.java` and `Touchable.js` code and are closely related to Apple TV implementation, it makes sense for them to be included in the core

 - React native apps can be launched on Android TV devices and properly render their content
 - Navigation is possible using left, right, top, bottom arrows from the remote (or D-PAD)
 - Touchable components can handle D-PAD center button press events and correctly fire their `onPress` handlers
 - Touchable components will receive `onPressIn` and `onPressOut` events and can react to focus/blur changes appropriately (just like on Apple TV)
 - `Platform` constants allow to check if the react-native app is running on TV (`Platform.isTV`)
 - `ScrollView`s behave correctly (same as native implementation) when switching to view outside bounds – that is, the container would scroll such that the newly focused element is fully visible
 - Native "clicking" sounds are played when moving between focusable elements
 - Play/Pause click event is send to `TVEventHandler`
 - Rewind and FastForward events are send to `TVEventHandler`
 - Back button behaves as a normal Android back button
 - Diagonal buttons work correctly on Android TV, e.g. if there is no button directly to the right from the focused one, but there is one to the right but a bit higher/lower it will grab focus
 - Dev menu can be accessed by long pressing fast forward button

A demo showing RNTester app running on Android TV device (Amazon Fire TV Stick) can be found here:
[![RNAndroidTVDemo](http://img.youtube.com/vi/EzIQErHhY20/0.jpg)](http://www.youtube.com/watch?v=EzIQErHhY20)

- `TextInput` will not work on Android TV devices. There's an issue with native `ReactEditText` implementation that prevents it from receiving focus. This makes it impossible to navigate to `TextInput`.
This will be fixed next, but will be included in a separate Pull Request
- ~Overlay permissions cannot be granted on Android TV devices running Android version >= 6.0
This is because the overlay permission can only be granted by firing an Intent to open settings page (`ACTION_MANAGE_OVERLAY_PERMISSION`). Since this page does not exist on TV devices the permission cannot be requested. This will make the app crash when trying to open dev menu (⌘+M) or displaying a redbox error.
Note: This does not affect devices running Android version < 6.0 (for example Amazon Fire TV Stick)~
This is now fixed by: https://github.com/facebook/react-native/pull/16596

* Launch the RNTester app on Android TV device.
  * Ensure it launches without a crash
  * Ensure basic navigation is possible
  * Ensure Touchable components can receive select events
* Ensure the changes do not break current Android and iOS mobile devices functionality.
* Ensure the changes do not break current Apple TV functionality.

[RNAndroidTVDemo video](http://img.youtube.com/vi/EzIQErHhY20/0.jpg)

* Added `ReactAndroidTVViewManager` that handles TV `KeyEvent`s and dispatches events to JS - This is the core that enables basic navigation functionality on Android TV devices
* Following the above change we copy `TVEventHandler.ios.js` into `TVEventHandler.android.js` to enable JS to pick up those native navigation events and dispatch them further to subscribed views. (Note: We do not have a native `TVNavigationEventEmitter` implementation on Android, thus this file is slightly modified, e.g. it does pass `null` to `NativeEventEmitter` constructor)
* Added `uiMode` to `AndroidInfoModule`. (**Note**: This required changing `extends BaseJavaModule` to `extends ReactContextBaseJavaModule` to be able to use `getSystemService` which requires `Context` instance!
* Added `isTV` constants to both `Platform.ios.js` (keeping the deprecated `isTVOS` as well) and `Platform.android.js`
* Changed condition check on `Touchable.js` to use the newly added `isTV` flag to properly handle TV navigation events on Android as well
* Added `LEANBACK_LAUNCHER` to `RNTester` `intent-filter` so that it is possible to launch it on Android TV devices.
* See also a PR to `react-native-website` repo with updated docs for Android TV: https://github.com/facebook/react-native-website/pull/59

 - [ ] Fix `TextInput` components handling by allowing them to be focused and making a proper navigation between them (and/or other components) possible. One thing to note here that the default behavior to immediately open software keyboard when focused on `TextInput` field will need to be adjusted on Android TV as well)
 - [x] Fix overlay permissions issue by changing the way redbox/dev menu are displayed (see: https://github.com/facebook/react-native/pull/16596)
 - [ ] Adjust placement of TV-related files (e.g. the `TVEventHandler.js` file is placed inside `AppleTV` directory which is not accurate, since it does handle Android TV events as well)

Previous discussion: https://github.com/SoftwareMansion/react-native/pull/1
<!--
Help reviewers and the release process by writing your own release notes

**INTERNAL and MINOR tagged notes will not be included in the next version's final release notes.**

  CATEGORY
[----------]        TYPE
[ CLI      ]   [-------------]      LOCATION
[ DOCS     ]   [ BREAKING    ]   [-------------]
[ GENERAl  ]   [ BUGFIX      ]   [-{Component}-]
[ INTERNAL ]   [ ENHANCEMENT ]   [ {File}      ]
[ IOS      ]   [ FEATURE     ]   [ {Directory} ]   |-----------|
[ ANDROID  ]   [ MINOR       ]   [ {Framework} ] - | {Message} |
[----------]   [-------------]   [-------------]   |-----------|

[CATEGORY] [TYPE] [LOCATION] - MESSAGE

 EXAMPLES:

 [IOS] [BREAKING] [FlatList] - Change a thing that breaks other things
 [ANDROID] [BUGFIX] [TextInput] - Did a thing to TextInput
 [CLI] [FEATURE] [local-cli/info/info.js] - CLI easier to do things with
 [DOCS] [BUGFIX] [GettingStarted.md] - Accidentally a thing/word
 [GENERAL] [ENHANCEMENT] [Yoga] - Added new yoga thing/position
 [INTERNAL] [FEATURE] [./scripts] - Added thing to script that nobody will see
-->

[ANDROID] [FEATURE] [TV] - Added support for Android TV devices
Closes https://github.com/facebook/react-native/pull/16500

Differential Revision: D6536847

Pulled By: hramos

fbshipit-source-id: 17bbb11e8583b97f195ced5fd9762f8902fb8a3d
2018-03-06 10:47:02 -08:00
.circleci Reënable iOS and tvOS tests 2018-03-04 18:15:57 -08:00
.github Simplify issue template 2018-02-28 16:26:01 -08:00
ContainerShip Update license headers for MIT license 2018-02-16 18:31:53 -08:00
IntegrationTests Update license headers for MIT license 2018-02-16 18:31:53 -08:00
Libraries Add support for Android TV devices 2018-03-06 10:47:02 -08:00
RNTester Add support for Android TV devices 2018-03-06 10:47:02 -08:00
React Add support for Android TV devices 2018-03-06 10:47:02 -08:00
ReactAndroid Add support for Android TV devices 2018-03-06 10:47:02 -08:00
ReactCommon Remove callFunctionSync experimental APIs 2018-03-05 14:32:00 -08:00
ReactNative Mark targets as explicitly Android 2018-03-02 17:22:35 -08:00
babel-preset Add possibility to add custom plugin prefix 2018-02-27 13:16:59 -08:00
bots Do not mention people, suggest labels 2018-02-28 16:47:18 -08:00
flow Update license headers for MIT license 2018-02-16 18:31:53 -08:00
flow-github Fix ESLint warnings using 'yarn lint --fix' 2018-02-22 07:23:17 -08:00
gradle/wrapper Android - Update Gradle to 2.2.3 2017-01-31 13:13:32 -08:00
jest Add missing mock for AppState (removeEventListener) 2018-02-25 22:18:30 -08:00
keystores Apply auto-formatter for BUCK files in fbandroid. 2017-02-27 14:04:56 -08:00
lib Update license headers for MIT license 2018-02-16 18:31:53 -08:00
local-cli Make the chrome debugger handle dynamic delta ids 2018-03-02 02:55:20 -08:00
react-native-cli Update to MIT license 2018-02-16 18:31:53 -08:00
react-native-git-upgrade Update to MIT license 2018-02-16 18:31:53 -08:00
scripts Reënable iOS and tvOS tests 2018-03-04 18:15:57 -08:00
third-party-podspecs Update to MIT license 2018-02-16 18:31:53 -08:00
.buckconfig update gitignore & fix links 2017-05-22 13:03:50 -07:00
.buckjavaargs limiting BUCK's memory for CI 2016-02-01 10:49:33 -08:00
.editorconfig Fix indent of .gradle files 2016-10-19 16:58:36 -07:00
.eslintignore Split out docs to their own repo 2017-12-05 13:02:54 -08:00
.eslintrc Fold .eslintrc's into the root eslintrc 2018-02-15 07:53:52 -08:00
.flowconfig @allow-large-files Upgrade xplat/js to Flow v0.66 2018-02-16 20:24:57 -08:00
.gitattributes Added a .gitattributes file, ensuring that Bash script source files (gradlew and 2015-10-13 23:10:39 -04:00
.gitignore Switch e2e to yarn 2018-02-06 13:04:50 -08:00
.npmignore Update .npmignore to include generated bundle file 2017-02-03 11:43:31 -08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-10-26 16:47:27 -07:00
CONTRIBUTING.md Update to MIT license 2018-02-16 18:31:53 -08:00
DockerTests.md Docker Testing Environment for Android & JS 2017-02-24 10:59:53 -08:00
Jenkinsfile Container Testing Updates 2017-04-12 16:31:35 -07:00
LICENSE Update to MIT license 2018-02-16 18:31:53 -08:00
LICENSE-docs More licenses 2015-03-24 19:59:10 -07:00
README.md Update to MIT license 2018-02-16 18:31:53 -08:00
React.podspec Update to MIT license 2018-02-16 18:31:53 -08:00
Releases.md Remove references to Travis 2018-01-24 22:18:34 -08:00
breaking-changes.md DOCS ONLY: Update breaking changes location in breaking-changes.md: move to Wiki 2017-02-03 06:28:37 -08:00
build.gradle Update gradle-download-task from 2.0.0 to 3.1.2 to fix boost zip down… 2016-12-07 16:43:28 -08:00
cli.js Update license headers for MIT license 2018-02-16 18:31:53 -08:00
gradlew Update gradle wrapper binary and scripts 2016-09-09 08:13:59 -07:00
gradlew.bat Update gradle wrapper binary and scripts 2016-09-09 08:13:59 -07:00
jest-preset.json mock mp4 files 2017-10-20 13:05:26 -07:00
package.json Update node-notifier (has mem leak fix) 2018-03-05 14:32:00 -08:00
react.gradle Revert "Better Android Gradle Plugin 3.x integration" 2018-03-05 10:55:50 -08:00
rn-cli.config.js Update license headers for MIT license 2018-02-16 18:31:53 -08:00
rn-get-polyfills.js Update license headers for MIT license 2018-02-16 18:31:53 -08:00
runXcodeTests.sh Re-license and rename UIExplorer integration test app as RNTester 2017-05-08 11:31:19 -07:00
settings.gradle Cleanup settings.gradle 2017-07-28 07:51:09 -07:00
setupBabel.js Update license headers for MIT license 2018-02-16 18:31:53 -08:00

README.md

React Native · Circle CI Status npm version PRs Welcome

Learn once, write anywhere: Build mobile apps with React.

  • Build native mobile apps using JavaScript and React: React Native lets you build mobile apps using only JavaScript. It uses the same design as React, letting you compose a rich mobile UI from declarative components.
  • A React Native app is a real mobile app: With React Native, you don't build a "mobile web app", an "HTML5 app", or a "hybrid app". You build a real mobile app that's indistinguishable from an app built using Objective-C, Java, or Swift. React Native uses the same fundamental UI building blocks as regular iOS and Android apps. You just put those building blocks together using JavaScript and React.
  • Don't waste time recompiling: React Native lets you build your app faster. Instead of recompiling, you can reload your app instantly. With hot reloading, you can even run new code while retaining your application state. Give it a try - it's a magical experience.
  • Use native code when you need to: React Native combines smoothly with components written in Objective-C, Java, or Swift. It's simple to drop down to native code if you need to optimize a few aspects of your application. It's also easy to build part of your app in React Native, and part of your app using native code directly - that's how the Facebook app works.

The focus of React Native is on developer efficiency across all the platforms you care about - learn once, write anywhere. Facebook uses React Native in multiple production apps and will continue investing in React Native.

See the official React Native website for an introduction to React Native.

Supported operating systems are >= Android 4.1 (API 16) and >= iOS 8.0.


Getting Started

Follow the Getting Started guide. The recommended way to install React Native depends on your project. Here you can find short guides for the most common scenarios:


Documentation

The websites documentation is divided into multiple sections.

Another great way to learn more about the components and APIs included with React Native is to read their source. Look under the Libraries/Components directory for components like ScrollView and TextInput, for example. The RNTester example is also here to demonstrate some of the ways to use these components. From the source you can get an accurate understanding of each components behavior and API.

The React Native documentation only discusses the components, APIs and topics specific to React Native (React on iOS and Android). For further documentation on the React API that is shared between React Native and React DOM, refer to the React documentation.


Upgrading

React Native is under active development. See the guide on upgrading React Native to keep your project up-to-date.


Contributing

Read below to learn how you can take part in improving React Native.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes to React Native.

Beginner Friendly Bugs

We have a list of beginner friendly issues to help you get your feet wet in the React Native codebase and familiar with our contribution process. This is a great place to get started.


License

React Native is MIT licensed.

React Native documentation is Creative Commons licensed.