Browse Source

Add in-app notification (#1577)

* Remove extra line-break to fix rendering list in doc site.

* Add In-App Notification
June Domingo 7 years ago
parent
commit
a43ac005c2
1 changed files with 11 additions and 0 deletions
  1. 11
    0
      docs/screen-api.md

+ 11
- 0
docs/screen-api.md View File

116
 this.props.navigator.dismissLightBox();
116
 this.props.navigator.dismissLightBox();
117
 ```
117
 ```
118
 
118
 
119
+## showInAppNotification(params = {})
120
+
121
+Show in-app notification. This generally looks like a pop-up window that can appear at the top of the screen.
122
+
123
+```js
124
+this.props.navigator.showInAppNotification({
125
+ screen: "example.InAppNotification", // unique ID registered with Navigation.registerScreen
126
+ passProps: {}, // simple serializable object that will pass as props to the in-app notification (optional)
127
+});
128
+```
129
+
119
 ## handleDeepLink(params = {})
130
 ## handleDeepLink(params = {})
120
 
131
 
121
 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.
132
 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.