Update docs for new plugins

Summary: ilovedocs

Reviewed By: danielbuechele

Differential Revision: D17501537

fbshipit-source-id: 1f5d872928b5a644ee98db025ad60b038b7126a8
This commit is contained in:
Pascal Hartig
2019-09-23 06:16:28 -07:00
committed by Facebook Github Bot
parent 96d5e3ceff
commit 741fb7d292
3 changed files with 37 additions and 12 deletions

View File

@@ -9,6 +9,17 @@ could easily be added. Send us a PR!
## Fresco and Android
The Fresco images plugin is shipped as a separate Maven artifact:
```groovy
dependencies {
debugImplementation 'com.facebook.flipper:flipper-images-plugin:0.24.0'
}
```
After including the plugin in your dependencies, you can add it to the
client:
```java
import com.facebook.flipper.plugins.fresco.FrescoFlipperPlugin;

View File

@@ -20,6 +20,21 @@ client.addPlugin(new InspectorFlipperPlugin(mApplicationContext, descriptorMappi
### With Litho Support
Litho support is provided via an optional plugin.
You also need to compile in the `litho-annotations` package, as Flipper reflects
on them at runtime. So ensure to not just include them as `compileOnly` in your
gradle configuration:
```groovy
dependencies {
debugImplementation 'com.facebook.flipper:flipper-litho-plugin:0.24.0'
debugImplementation 'com.facebook.litho:litho-annotations:0.19.0'
// ...
}
```
If you want to enable Litho support in the layout inspector, you need to augment
the descriptor with Litho-specific settings and add some addition dependencies.
@@ -41,18 +56,6 @@ LithoFlipperDescriptors.add(descriptorMapping);
client.addPlugin(new InspectorFlipperPlugin(mApplicationContext, descriptorMapping));
```
You also need to compile in the `litho-annotations` package, as Flipper reflects
on them at runtime. So ensure to not just include them as `compileOnly` in your
gradle configuration:
```groovy
dependencies {
debugImplementation 'com.facebook.litho:litho-annotations:0.19.0'
// ...
}
```
### Blocking fullscreen views (Android only)
The issue is that if you have some view that occupies big part of the screen but draws nothing and its Z-position is higher than your main content, then selecting view/component through Layout Inspector doesn't work as you intended, as it will always hit that transparent view and you need to manually navigate to the view you need which is time-consuming and should not be necessary.

View File

@@ -8,6 +8,17 @@ To use the network plugin, you need to add the plugin to your Flipper client ins
## Android
The network plugin is shipped as a separate Maven artifact:
```groovy
dependencies {
debugImplementation 'com.facebook.flipper:flipper-network-plugin:0.24.0'
}
```
Once added to your dependencies, you can instantiate the plugin and add it to
the client:
```java
import com.facebook.flipper.plugins.network.NetworkFlipperPlugin;