Browse Source

Improved Deeplink documentation (#1663)

To match the rest of the styling
Johan 7 years ago
parent
commit
0dc8f4f847
1 changed files with 4 additions and 2 deletions
  1. 4
    2
      docs/top-level-api.md

+ 4
- 2
docs/top-level-api.md View File

183
 Trigger a deep link within the app. See [deep links](https://wix.github.io/react-native-navigation/#/deep-links) for more details about how screens can listen for deep link events.
183
 Trigger a deep link within the app. See [deep links](https://wix.github.io/react-native-navigation/#/deep-links) for more details about how screens can listen for deep link events.
184
 
184
 
185
 ```js
185
 ```js
186
-  import {Navigation} from 'react-native-navigation';
187
-  Navigation.handleDeepLink(...);
186
+  Navigation.handleDeepLink({
187
+    link: 'link/in/any/format',
188
+    payload: '' // (optional) Extra payload with deep link
189
+  });
188
 ```
190
 ```
189
 
191
 
190
 ## registerScreen(screenID, generator)
192
 ## registerScreen(screenID, generator)