diff --git a/docs/getting-started/android-native.mdx b/docs/getting-started/android-native.mdx index 70443d214..30604440e 100644 --- a/docs/getting-started/android-native.mdx +++ b/docs/getting-started/android-native.mdx @@ -6,19 +6,17 @@ sidebar_label: Android with Gradle import useBaseUrl from '@docusaurus/useBaseUrl'; import Link from '@docusaurus/Link'; -To set up Flipper for Android, you need to add the necessary dependencies to your -app, initialize the Flipper client and enable the plugins you want to use. Optionally, -you can hook up the diagnostics Activity to help you troubleshoot connection issues. +To set up Flipper for Android, you need to add the necessary dependencies to your app, initialize the Flipper client and enable the plugins you want to use. +Optionally, you can hook up the diagnostics Activity to help you troubleshoot connection issues. ## Dependencies -Flipper is distributed via Maven Central. Add the dependencies to your `build.gradle` file. -You should also explicitly depend on [`soloader`](https://github.com/facebook/soloader) -instead of relying on transitive dependency resolution which is getting deprecated +Flipper is distributed via Maven Central: add the dependencies to your `build.gradle` file. + +You should also explicitly depend on [SoLoader](https://github.com/facebook/soloader) instead of relying on transitive dependency resolution, which is getting deprecated with Gradle 5. -We provide a "no-op" implementation of some oft-used Flipper interfaces you can -use to make it easier to strip Flipper from your release builds. +There is a 'no-op' implementation of some oft-used Flipper interfaces, which you can use to make it easier to strip Flipper from your release builds: ```groovy repositories { @@ -33,27 +31,18 @@ dependencies { } ``` -
+:::warning +The `flipper-noop` package provides a limited subset of the APIs provided by the `flipper` package and does not provide any plugin stubs. +It's recommended that you keep all Flipper instantiation code in a separate build variant to ensure it doesn't accidentally make it into your production builds. -Please note that our `flipper-noop` package provides a limited subset of the -APIs provided by the `flipper` package and does not provide any plugin stubs. -It is recommended that you keep all Flipper instantiation code in a separate -build variant to ensure it doesn't accidentally make it into your production -builds. Check out [the sample -app](https://github.com/facebook/flipper/tree/main/android/sample/src) to -see how to organise your Flipper initialization into debug and release -variants. +To see how to organise your Flipper initialization into debug and release variants. see thos [sample app](https://github.com/facebook/flipper/tree/main/android/sample/src). -Alternatively, have a look at the third-party -[flipper-android-no-op](https://github.com/theGlenn/flipper-android-no-op) -repository, which provides empty implementations for several Flipper plugins. +Alternatively, have a look at the third-party [flipper-android-no-op](https://github.com/theGlenn/flipper-android-no-op) repository, which provides empty implementations for several Flipper plugins. +::: -
+## Application setup -## Application Setup - -Now you can initialize Flipper in your Application's `onCreate` method, which involves -initializing SoLoader (for loading the C++ part of Flipper) and starting a `FlipperClient`. +Now you can initialize Flipper in your Application's `onCreate` method, which involves initializing SoLoader (for loading the C++ part of Flipper) and starting a `FlipperClient`. import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -121,12 +110,13 @@ It's recommended that you add the following activity to the manifest, which can android:exported="true"/> ``` -## Android Snapshots +## Android snapshots -Feeling adventurous? We publish Android snapshot releases directly off of `main`. +:::note +Android snapshot releases are published directly off `main`. +::: -You can get the latest version by adding the Maven Snapshot repository to your sources -and pointing to the most recent `-SNAPSHOT` version. +You can get the latest version by adding the Maven Snapshot repository to your sources and pointing to the most recent `-SNAPSHOT` version. ```groovy repositories { @@ -143,8 +133,12 @@ dependencies { ## Enabling plugins -Finally, you need to add plugins to your Flipper client. Above, we have only added the Layout Inspector plugin to get you started. See Network Plugin and Layout Inspector Plugin for information on how to add them, and also enable Litho or ComponentKit support. You can check the sample apps in the [GitHub repo](https://github.com/facebook/flipper) for examples of integrating other plugins. +Finally, you need to add plugins to your Flipper client. -## Having trouble? +Above, the Layout Inspector plugin has been added to get you started. See the Network Plugin and [Layout Inspector Plugin](https://www.internalfb.com/intern/staticdocs/flipper/docs/features/plugins/inspector/) pages for information on how to add them, and also enable Litho or ComponentKit support. -See the troubleshooting page for help with known problems. +For examples of integrating other plugins, take a look at the sample apps in the [GitHub repo](https://github.com/facebook/flipper). + +## Questions or issues + +If you have any questions or issues, refer to the troubleshooting page, or post the details on the [Flipper Support](https://fb.workplace.com/groups/flippersupport) Workplace group.