Combine internal and external navigation plugin setup pages

Summary:
Now in public, the setup page remains unchanged, well, the headings are one level smaller.

In internal, the page is divided into two sections: for buck based apps, and non-buck based ones.

Reviewed By: mweststrate

Differential Revision: D25565953

fbshipit-source-id: abf4316a28970cd93d0cc9b56dd707f00a674a48
This commit is contained in:
John Knox
2020-12-16 03:27:42 -08:00
committed by Facebook GitHub Bot
parent 324c54eb64
commit 063a1d191f
2 changed files with 18 additions and 6 deletions

View File

@@ -4,7 +4,20 @@ title: Navigation Plugin Setup
sidebar_label: Navigation sidebar_label: Navigation
--- ---
## Android import {FbInternalOnly} from 'internaldocs-fb-helpers';
import FbNavigationPluginSetup from '../fb/Navigation-Plugin.mdx';
<FbInternalOnly>
## Adding the plugin using Buck
<FbNavigationPluginSetup />
## Adding the plugin to non-buck-based apps
</FbInternalOnly>
### Android
First, add the plugin to your Flipper client instance: First, add the plugin to your Flipper client instance:
```java ```java
@@ -17,7 +30,7 @@ client.addPlugin(NavigationFlipperPlugin.getInstance());
Navigation events in the app can then be recorded by calling `sendNavigationEvent` method of the `NavigationFlipperPlugin` instance from anywhere in the app. This allows for the Navigation Plugin to be integrated into existing navigation frameworks. Navigation events in the app can then be recorded by calling `sendNavigationEvent` method of the `NavigationFlipperPlugin` instance from anywhere in the app. This allows for the Navigation Plugin to be integrated into existing navigation frameworks.
### Using Android Deep Links #### Using Android Deep Links
The Navigation Plugin can be used with built in [deep links for Android](https://developer.android.com/training/app-links/deep-linking). The Navigation Plugin can be used with built in [deep links for Android](https://developer.android.com/training/app-links/deep-linking).
@@ -45,10 +58,10 @@ public class DeepLinkActivity extends AppCompatActivity {
... ...
``` ```
### Third Party Solutions #### Third Party Solutions
The Navigation Plugin can easily be integrated into a third party navigation framework. The Navigation Plugin can easily be integrated into a third party navigation framework.
#### AirBnB Deep Link Dispatch ##### AirBnB Deep Link Dispatch
[Deep Link Dispatch](https://github.com/airbnb/DeepLinkDispatch) will work out of the box with Flipper for navigating to links, including support for url parameters. To add logging, simply add a BroadcastReceiver to your app that is called on any incoming deep links. [Deep Link Dispatch](https://github.com/airbnb/DeepLinkDispatch) will work out of the box with Flipper for navigating to links, including support for url parameters. To add logging, simply add a BroadcastReceiver to your app that is called on any incoming deep links.
```java ```java
@@ -72,5 +85,5 @@ public class DeepLinkApplication extends Application {
} }
``` ```
## iOS ### iOS
iOS support is coming soon. iOS support is coming soon.

View File

@@ -27,7 +27,6 @@ module.exports = {
'features/react-native', 'features/react-native',
...fbInternalOnly([ ...fbInternalOnly([
'fb/Memory-Tools', 'fb/Memory-Tools',
'fb/Navigation-Plugin',
'fb/supporting-feed-inspector', 'fb/supporting-feed-inspector',
'fb/sections', 'fb/sections',
'fb/Trace', 'fb/Trace',