From b8292ee62c912b182c9ccf1f284f7bbfc4f499c4 Mon Sep 17 00:00:00 2001 From: Kevin Strider Date: Wed, 25 May 2022 03:14:14 -0700 Subject: [PATCH] create-plugin.mdx (Creating Plugins - Client Plugin API) Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant). Reviewed By: aigoncharov Differential Revision: D36626315 fbshipit-source-id: 735160f8d1f1365a8aab7fb1cd3e99b724025e3a --- docs/extending/create-plugin.mdx | 61 +++++++++++++++----------------- 1 file changed, 28 insertions(+), 33 deletions(-) diff --git a/docs/extending/create-plugin.mdx b/docs/extending/create-plugin.mdx index de72c4c6a..4d924b2dd 100644 --- a/docs/extending/create-plugin.mdx +++ b/docs/extending/create-plugin.mdx @@ -9,12 +9,12 @@ import {FbInternalOnly, OssOnly} from 'internaldocs-fb-helpers'; ## FlipperPlugin -The plugin implementation that runs on the (mobile) application side of things is called the _client plugin_ in Flipper terminology. +The plugin implementation that runs on (mobile) applications is called the *client plugin* in Flipper terminology. + To build a client plugin, implement the `FlipperPlugin` interface. The ID that is returned from your implementation needs to match the `name` defined in your JavaScript counterpart's `package.json`. - @@ -77,11 +77,9 @@ public: -
- -Please note that using Flipper from JavaScript in React Native requires the package [`react-native-flipper`](https://www.npmjs.com/package/react-native-flipper) to be installed in the hosting application. - -
+:::warning +Using Flipper from JavaScript in React Native requires the package [react-native-flipper](https://www.npmjs.com/package/react-native-flipper) to be installed in the hosting application. +::: ```javascript import {addPlugin} from 'react-native-flipper'; @@ -101,14 +99,13 @@ addPlugin({ }, }); ``` + -
- -Please note that using Flipper from JavaScript in your browser requires the package [`js-flipper`](https://www.npmjs.com/package/js-flipper) to be installed in the hosting application. - -
+:::warning +Using Flipper from JavaScript in your browser requires the package [js-flipper](https://www.npmjs.com/package/js-flipper) to be installed in the hosting application. +::: ```javascript import {flipperClient} from 'js-flipper'; @@ -140,10 +137,10 @@ flipperClientPromise?.then((flipperClient) => { }); }); ``` + - ## Using FlipperConnection `onConnect` will be called when your plugin becomes active. This will provide a `FlipperConnection` allowing you to register receivers for desktop method calls and respond with data. @@ -272,7 +269,7 @@ flipperClient.addPlugin({ ## Push data to the desktop -You don't have to wait for the desktop to request data though, you can also push data directly to the desktop. If the JS plugin subscribes to the same method, it will receive the data. +You don't have to wait for the desktop to request data. You can also push data directly to the desktop. If the JS plugin subscribes to the same method, it will receive the data. @@ -338,27 +335,30 @@ flipperClient.addPlugin({ ### Using a plugin instance to send data -It is often useful to get an instance of a Flipper plugin to send data to it. Flipper makes this simple with built-in support. +It is often useful to get an instance of a Flipper plugin to send data to it: Flipper makes this simple with built-in support. #### Dependency Injection (Android only) The preferred method to obtain a plugin instance is to use dependency injection when available. -For apps like fb4a that use dependency injection, a Module should have already been created by the create-plugin script. +For apps like fb4a that use dependency injection, a Module should have already been created by the 'create-plugin' script. This module will define a Singleton instance of your plugin that gets added to the FlipperClient. You should use this instance of the plugin, by having it injected into your product code by the DI framework. Alternatively, you can modify the plugin's injection module so that it injects a component into the FlipperPlugin. - #### using FlipperClient to obtain a plugin instance Plugins should be treated as singleton instances as there can only be one `FlipperClient` and each `FlipperClient` can only have one instance of a certain plugin. The Flipper API makes this simple by offering a way to get the current client and query it for plugins. -Plugins are identified by the string that their identifier method returns, in this example, "MyFlipperPlugin". Note that null checks may be required as plugins may not be initialized, for example in production builds. +Plugins are identified by the string that their identifier method returns, in this example, 'MyFlipperPlugin'. + +:::note +Null checks may be required as plugins may not be initialized, such as in production builds. +::: @@ -390,35 +390,30 @@ if (myPlugin) { myPlugin->sendData(myData); } ``` + - -Here, `sendData` is an example of a method that might be implemented by the Flipper plugin. +In the above snippet, `sendData` is an example of a method that might be implemented by the Flipper plugin. ### Bi-directional communication demo -An minimal communication demo for Android and iOS can be found in our Sample project: +A minimal communication demo for Android and iOS can be found in the 'Sample' project: * [Desktop implementation](https://github.com/facebook/flipper/blob/main/desktop/plugins/public/example/index.tsx) * [Android](https://github.com/facebook/flipper/blob/main/android/sample/src/debug/java/com/facebook/flipper/plugins/example/ExampleFlipperPlugin.java) / [iOS](https://github.com/facebook/flipper/tree/7bd4f80c2570bebb52af3cf49e45fc6130d6a473/iOS/Plugins/FlipperKitExamplePlugin/FlipperKitExamplePlugin) -For React Native and JavaScript we have a simple game of Tic Tac Toe: +For React Native and JavaScript, there is a simple game of Tic Tac Toe: * [Desktop implementation](https://github.com/facebook/flipper/blob/main/desktop/plugins/public/rn-tic-tac-toe/index.tsx) * [React Native implementation](https://github.com/facebook/flipper/tree/main/react-native/ReactNativeFlipperExample) / [JavaScript (React) implementation](https://github.com/facebook/flipper/tree/main/js/react-flipper-example) +## Background plugins -## Background Plugins +In some cases, you may want to provide data to Flipper even when your plugin is not currently active. Returning true in `runInBackground()` results in `onConnect` being called as soon as Flipper connects, which enables you to use the connection at any time. For more detals, see the [Client Plugin Lifecycle](client-plugin-lifecycle.mdx). The advantage of this method is that the desktop plugin can process this data in the background and fire notifications. It also reduces the number of renders and time taken to display the data when the plugin becomes active. -In some cases you may want to provide data to Flipper even when your plugin is not currently active. Returning true in `runInBackground()` will result in `onConnect` being called as soon as Flipper connects, and allow you to use the connection at any time. See the [Client Plugin Lifecycle](client-plugin-lifecycle.mdx) for more details. +:::warning +Please note that a background plugin could keep some data in memory until a Flipper connection is available, such as to keep statistics about the app startup process. However, a plugin shouldn't assume it will eventually get a connection, since this depends on whether the user has enabled the plugin on the Desktop side. -The benefit is that the desktop plugin can process this data in the background and fire notifications. It also reduces the number of renders and time taken to display the data when the plugin becomes active. - -
- -Please note that a background plugin could keep some data in memory until a Flipper connection is available, for example to keep statistics about the app startup process. -However, a plugin shouldn't assume it will eventually get a connection, since this depends on whether the user has enabled the plugin on the Desktop side. -So make sure to not store unbounded amounts of data! - -
+It's important to make sure that unbounded amounts of data are not stored! +:::