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

Creating Plugins

Browse Source 
Summary: This diff includes minor changes to the pages within the Creating Plugins section of Flipper Docs.

Reviewed By: passy

Differential Revision: D41497503

fbshipit-source-id: 5c5718b63bfff18322b28b547724415ab40a1810
This commit is contained in:
Kevin Strider
2022-11-24 05:37:59 -08:00
committed by Facebook GitHub Bot
parent c23f62219b
commit bd92bb7faf
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/extending/client-plugin-lifecycle.mdx
View File

@@ -13,7 +13,7 @@ For both types of plugin, it's recommended you start work after the `onConnect`
For regular plugins, `onConnect` and `onDisconnect` are triggered when the user opens the plugin in the Flipper UI, and when they switch to another plugin, respectively.
The process is illustrated in the following diagram.
<img alt="Regular Plugin Lifecycle diagram" src={useBaseUrl("img/regular-plugin-lifecycle.png")} />
<img height="300" alt="Regular Plugin Lifecycle diagram" src={useBaseUrl("img/regular-plugin-lifecycle.png")} />
## Background Plugin Lifecycle
@@ -21,8 +21,8 @@ For background plugins, `onConnect` is called when Flipper first connects, and `
Even for background plugins, `onDisconnect` and `onConnect` may be called on a plugin (such as if the user restarts Flipper). Plugins should handle this accordingly by making sure to resend any important data to the reconnected instance. The process is illustrated in the following diagram.
<img height="300" alt="Background Plugin Lifecycle diagram" src={useBaseUrl("img/bg-plugin-lifecycle.png")} />
:::warning
Note that a plugin must be enabled by the user for its messages to be queued up.
:::
<img alt="Background Plugin Lifecycle diagram" src={useBaseUrl("img/bg-plugin-lifecycle.png")} />