Browse Source

Update top-level-api.md (Added forgotten styles) (#1600)

* Update top-level-api.md (Added forgotten styles)

Added forgotten drawer style props.

* Added iOS only words to style objects
Berkay Beyaz 7 years ago
parent
commit
87f64a6ed7
1 changed files with 12 additions and 0 deletions
  1. 12
    0
      docs/top-level-api.md

+ 12
- 0
docs/top-level-api.md View File

66
       screen: 'example.SecondSideMenu', // unique ID registered with Navigation.registerScreen
66
       screen: 'example.SecondSideMenu', // unique ID registered with Navigation.registerScreen
67
       passProps: {} // simple serializable object that will pass as props to all top screens (optional)
67
       passProps: {} // simple serializable object that will pass as props to all top screens (optional)
68
     },
68
     },
69
+    style: { // ( iOS only )
70
+      drawerShadow: true, // optional, add this if you want a side menu drawer shadow
71
+      contentOverlayColor: 'rgba(0,0,0,0.25)', // optional, add this if you want a overlay color when drawer is open
72
+      leftDrawerWidth: 50 // optional, add this if you want a define left drawer width (50=percent)
73
+      rightDrawerWidth: 50 // optional, add this if you want a define right drawer width (50=percent)
74
+    },
69
     disableOpenGesture: false // optional, can the drawer be opened with a swipe instead of button
75
     disableOpenGesture: false // optional, can the drawer be opened with a swipe instead of button
70
   },
76
   },
71
   passProps: {}, // simple serializable object that will pass as props to all top screens (optional)
77
   passProps: {}, // simple serializable object that will pass as props to all top screens (optional)
94
       screen: 'example.SecondSideMenu', // unique ID registered with Navigation.registerScreen
100
       screen: 'example.SecondSideMenu', // unique ID registered with Navigation.registerScreen
95
       passProps: {} // simple serializable object that will pass as props to all top screens (optional)
101
       passProps: {} // simple serializable object that will pass as props to all top screens (optional)
96
     },
102
     },
103
+    style: { // ( iOS only )
104
+      drawerShadow: true, // optional, add this if you want a side menu drawer shadow
105
+      contentOverlayColor: 'rgba(0,0,0,0.25)', // optional, add this if you want a overlay color when drawer is open
106
+      leftDrawerWidth: 50 // optional, add this if you want a define left drawer width (50=percent)
107
+      rightDrawerWidth: 50 // optional, add this if you want a define right drawer width (50=percent)
108
+    },
97
     disableOpenGesture: false // optional, can the drawer be opened with a swipe instead of button
109
     disableOpenGesture: false // optional, can the drawer be opened with a swipe instead of button
98
   },
110
   },
99
   passProps: {}, // simple serializable object that will pass as props to all top screens (optional)
111
   passProps: {}, // simple serializable object that will pass as props to all top screens (optional)