Browse Source

Add docs about `overrideBackPress` to `showModal` (#4152)

Alexander Zubko 6 years ago
parent
commit
146e7638e1
1 changed files with 2 additions and 1 deletions
  1. 2
    1
      docs/top-level-api.md

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

151
   passProps: {}, // simple serializable object that will pass as props to the modal (optional)
151
   passProps: {}, // simple serializable object that will pass as props to the modal (optional)
152
   navigatorStyle: {}, // override the navigator style for the screen, see "Styling the navigator" below (optional)
152
   navigatorStyle: {}, // override the navigator style for the screen, see "Styling the navigator" below (optional)
153
   navigatorButtons: {}, // override the nav buttons for the screen, see "Adding buttons to the navigator" below (optional)
153
   navigatorButtons: {}, // override the nav buttons for the screen, see "Adding buttons to the navigator" below (optional)
154
-  animationType: 'slide-up' // 'none' / 'slide-up' , appear animation for the modal (optional, default 'slide-up')
154
+  animationType: 'slide-up', // 'none' / 'slide-up' , appear animation for the modal (optional, default 'slide-up')
155
+  overrideBackPress: false // true / false, (Android only), prevents back button and hardware back button from hiding the dialog on Android, instead the [navigator event](https://wix.github.io/react-native-navigation/#/screen-api?id=setonnavigatoreventcallback) 'backPress' will be sent (optional)
155
 });
156
 });
156
 ```
157
 ```
157
 
158