diff --git a/react-native/react-native-flipper/.npmignore b/react-native/react-native-flipper/.npmignore index e69de29bb..d838da986 100644 --- a/react-native/react-native-flipper/.npmignore +++ b/react-native/react-native-flipper/.npmignore @@ -0,0 +1 @@ +examples/ diff --git a/react-native/react-native-flipper/LICENSE b/react-native/react-native-flipper/LICENSE new file mode 100644 index 000000000..b96dcb048 --- /dev/null +++ b/react-native/react-native-flipper/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) Facebook, Inc. and its affiliates. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/react-native/react-native-flipper/README.md b/react-native/react-native-flipper/README.md index 048f31bb3..6a7b93931 100644 --- a/react-native/react-native-flipper/README.md +++ b/react-native/react-native-flipper/README.md @@ -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 `` 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). diff --git a/react-native/react-native-flipper/examples/FlipperTicTacToe.js b/react-native/react-native-flipper/examples/FlipperTicTacToe.js new file mode 100644 index 000000000..400896cd6 --- /dev/null +++ b/react-native/react-native-flipper/examples/FlipperTicTacToe.js @@ -0,0 +1,102 @@ +/** + * Copyright (c) Facebook, Inc. and its affiliates. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + * + * @format + */ + +import React, {useState, useEffect} from 'react'; +// $FlowFixMe 'react-native' won't resolve here, as this file is just an example.. +import {StyleSheet, View, Text, Button} from 'react-native'; + +import {addPlugin} from 'react-native-flipper'; + +export default function FlipperTicTacToe() { + const [status, setStatus] = useState('Waiting for Flipper Desktop Player...'); + const [gameState, setGameState] = useState({ + cells: [], + turn: ' ', + winner: ' ', + }); + const [connection, setConnection] = useState(null); + + useEffect(() => { + addPlugin({ + getId() { + return 'ReactNativeTicTacToe'; + }, + onConnect(connection) { + setStatus('Desktop player present'); + setConnection(connection); + + // listen to updates + connection.receive('SetState', (gameState, responder) => { + if (gameState.winner !== ' ') { + setStatus( + `Winner is ${gameState.winner}! Waiting for a new game...`, + ); + } else { + setStatus( + gameState.turn === 'X' + ? 'Your turn...' + : 'Awaiting desktop players turn...', + ); + } + setGameState(gameState); + responder.success(); + }); + + // request initial state + connection.send('GetState'); + }, + onDisconnect() { + setConnection(null); + setStatus('Desktop player gone...'); + }, + }); + }, []); + + return ( + + Flipper Tic-Tac-Toe + {status} + + {gameState.cells.map((state, idx) => ( + +