npm
/
react-native-navigation
Watch 11
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

Document options for Peek & Pop (#4545) 

Document options for Peek and Pop previews
Karl Sander 6 years ago
parent
d18fb18907
commit
ba86b3bcd8
1 changed files with 12 additions and 1 deletions
Unified View Show Diff Stats
  1. 12
    1
      docs/docs/animations.md

+ 12
- 1
docs/docs/animations.md View File

49 
       options: {
 49 
       options: {
50 
         preview: {
 50 
         preview: {
51 
           reactTag,
 51 
           reactTag,
52 
+          height: 300,
53 
+          width: 300,
54 
+          commit: true,
55 
+          actions: [{
56 
+            title: "Displayed Name",
57 
+            id: "actionId",
58 
+            style: 'default', /* or 'selected', 'destructive'*/
59 
+            actions: [/*define a submenu of actions with the same options*/]
60 
+          }]
52 
         },
 61 
         },
53 
       },
 62 
       },
54 
     },
 63 
     },
64 
     <Text>My button</Text>
 73 
     <Text>My button</Text>
65 
   </Navigation.TouchablePreview>
 74 
   </Navigation.TouchablePreview>
66 
 );
 75 
 );
67 
-```
76 
+```
77 
+
78 
+All options except for reactTag are optional. Actions trigger the same event as [navigation button presses](https://wix.github.io/react-native-navigation/#/docs/topBar-buttons?id=handling-button-press-events). To react when a preview is committed, listen to the [previewCompleted](https://wix.github.io/react-native-navigation/#/docs/events?id=previewcompleted-ios-114-only) event.