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

Publish react-native-flipper as NPM package

Browse Source 
Summary:
This Diff makes the react-native-flipper package available on NPM.

For simplicity and traceability purposes, this package is released every time Flipper is released, under the same version number. Even though there will be often no changes.

Reviewed By: passy

Differential Revision: D19446815

fbshipit-source-id: 485930e57beac42a2f36dc34a8ac82eed2abe785
This commit is contained in:
Michel Weststrate
2020-01-17 08:19:08 -08:00
committed by Facebook Github Bot
parent 3b24e41258
commit 1b7a30ae6c
6 changed files with 156 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
react-native/react-native-flipper/README.md
View File

@@ -1,17 +1,30 @@
# react-native-flipper
## Getting started
This package exposes JavaScript bindings to talk from React Native JavaScript directly to flipper.
`$ npm install react-native-flipper --save`
This package might also be required by other Flipper plugins for React Native.
### Mostly automatic installation
## Installation
`$ react-native link react-native-flipper`
Run the following command in the root of your React Native project
`yarn add react-native-flipper`
Note that this package requires React Native 0.62 or higher.
## Usage
```javascript
import Flipper from 'react-native-flipper';
// TODO: What to do with the module?
Flipper;
```
How to build Flipper plugins is explained in the flipper documentation:
[Creating a Flipper plugin](https://fbflipper.com/docs/extending/index.html).
Building a Flipper plugin involves building a plugin for the Desktop app, and a plugin that runs on a Device (Native Android, Native IOS or React Native). This package is only needed for the plugin that runs on the mobile device, in React Native, and wants to use the JavaScript bridge.
This package exposes one method: `addPlugin`.
The `addPlugin` accepts a `plugin` parameter, that registers a client plugin and will fire the relevant callbacks if the corresponding desktop plugin is selected in the Flipper Desktop. The full plugin API is documented [here](https://fbflipper.com/docs/extending/create-plugin.html).
## Example
An example plugin can be found in [examples/FlipperTicTacToe.js](examples/FlipperTicTacToe.js).
The corresponding Desktop plugin ships by default in Flipper, so importing the above file and dropping the `<FlipperTicTacToe />` component somewhere in your application should work out of the box.
The sources of the corresponding Desktop plugin can be found [here](../../src/plugins/rn-tic-tac-toe).