jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add feature page for react native integration

Browse Source 
Summary: https://pxl.cl/144pb

Reviewed By: jknoxville

Differential Revision: D20648205

fbshipit-source-id: 1349723755ed2be5b577f42ec1e45df07c25c94f
This commit is contained in:
Michel Weststrate
2020-03-25 15:33:25 -07:00
committed by Facebook GitHub Bot
parent 6298fd6288
commit 8060bcb664
6 changed files with 52 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/features/react-native.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: react-native
title: React Native Support
---
![React Native + React DevTools](/docs/assets/react-native-react.png)
The React Native and Developer tooling teams at Facebook work in close collaboration to make sure Flipper offers top-notch value out of the box for React Native development.
Integration between React Native and Flipper is enabled out of the box in React Native version 0.62 and higher.
→ [See setup instructions for React Native](../getting-started#setup-your-react-native-app)
## Device type: React Native
In Flipper there is a dedicated device type, “React Native”, that connects to a locally running Metro instance to interact with your React Native app. This device will be detected as soon as you fire up a Metro instance by running `yarn run ios` or `yarn run android` in your project.
If Metro is connected, two new buttons will appear in Flipper’s main toolbar: “Reload” and “Open Dev Menu”. Both do exactly what their name suggests, without needing the agility of a pianist to get to the right keyboard combo inside your emulator. The “React Native” device will feature two plugins out of the box: “Logs” and “React DevTools”.
![React Native Action Buttons and Logs](/docs/assets/react-native-logs.png)
The React DevTools allows you to inspect the component tree and tune the props and state of your React components.
The Logs plugins will allow you to search, filter and even put watch expressions on your logging output. This offers a much richer way to interact with your logs compared to the terminal output of Metro.
## Native plugins for React Native
Beyond the React Native specific Flipper plugins described above, with Flipper you will also inherit the plugin eco-system that exists for native Android and iOS apps. This means that you will be able to use plugins that are aimed at native apps for your React Native app as will. Example plugins include:
* Device logs
* Device crash reporter
* Inspecting app local databases
* Inspecting device preferences
* Inspecting cached images
* Inspecting native layout elements
## Writing JavaScript plugins for React Native + Flipper
One of the greatest values of Flipper is its extensibility. Many teams across Facebook already have written their own one-off plugins that help with analysing very specific use cases.
Writing plugins for Flipper doesn't require any native code, as the Flipper SDK is exposed directly to JavaScript through the [react-native-flipper](https://www.npmjs.com/package/react-native-flipper) package.
![Tic Tac Toe example plugin](/docs/assets/react-native-tictactoe.png)
_Example Flipper plugin: playing a game of Tic Tac Toe using Flipper and some emulators_
If you would love to build a specific (or generic) extension for Flipper check out the following pointers! Plugins for Flipper can be distributed through NPM so sharing them is trivial.
→ Creating a React Native Flipper Plugin https://fbflipper.com/docs/tutorial/react-native.html
→ Create a Flipper Desktop Plugin https://fbflipper.com/docs/tutorial/js-setup.html