Files
flipper/react-native/react-native-flipper
Pascal Hartig 6224daf247 Pin ws 7.4.6 for react-native-flipper (#2430)
Summary:
Got an open security alert.

Pull Request resolved: https://github.com/facebook/flipper/pull/2430

Test Plan: _eyes

Reviewed By: mweststrate

Differential Revision: D28939983

Pulled By: passy

fbshipit-source-id: 24e9d68151515c4e51812c1c6c02c8dfc266213b
2021-06-08 05:18:44 -07:00
..
2020-05-28 09:59:53 -07:00
2020-07-17 17:18:36 -07:00
2020-03-04 19:00:20 -08:00

react-native-flipper

This package exposes JavaScript bindings to talk from React Native JavaScript directly to flipper.

This package might also be required by other Flipper plugins for React Native.

Installation

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

How to build Flipper plugins is explained in the flipper documentation: Creating a Flipper plugin. 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.

Example

An example plugin can be found in 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.