소스 검색

Added HandleDeepLink to TopLevelApi documentation (#1662)

As the screen api document mentions that it can be done statically, it's best to mention it here as well.
Johan 7 년 전
부모
커밋
904a1d8408
1개의 변경된 파일9개의 추가작업 그리고 0개의 파일을 삭제
  1. 9
    0
      docs/top-level-api.md

+ 9
- 0
docs/top-level-api.md 파일 보기

@@ -178,6 +178,15 @@ Dismiss the current lightbox.
178 178
 Navigation.dismissLightBox();
179 179
 ```
180 180
 
181
+## handleDeepLink(params = {})
182
+
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
+
185
+```js
186
+  import {Navigation} from 'react-native-navigation';
187
+  Navigation.handleDeepLink(...);
188
+```
189
+
181 190
 ## registerScreen(screenID, generator)
182 191
 
183 192
 This is an internal function you probably don't want to use directly. If your screen components extend `Screen` directly (`import { Screen } from 'react-native-navigation'`), you can register them directly with `registerScreen` instead of with `registerComponent`. The main benefit of using `registerComponent` is that it wraps your regular screen component with a `Screen` automatically.