Browse Source

update docs for iOS drawer animations in top-level-api section (#1619)

* update docs for ios drawer animations in top-level-api section

* update docs for ios drawer animations in top-level-api section
Aishwary Raj 7 years ago
parent
commit
952b066812
1 changed files with 6 additions and 0 deletions
  1. 6
    0
      docs/top-level-api.md

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

72
       leftDrawerWidth: 50 // optional, add this if you want a define left drawer width (50=percent)
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)
73
       rightDrawerWidth: 50 // optional, add this if you want a define right drawer width (50=percent)
74
     },
74
     },
75
+    type: 'MMDrawer', // optional, iOS only, types: 'TheSideBar', 'MMDrawer' default: 'MMDrawer'
76
+    animationType: 'door', //optional, iOS only, for MMDrawer: 'door', 'parallax', 'slide', 'slide-and-scale'
77
+                                        // for TheSideBar: 'airbnb', 'facebook', 'luvocracy','wunder-list'
75
     disableOpenGesture: false // optional, can the drawer be opened with a swipe instead of button
78
     disableOpenGesture: false // optional, can the drawer be opened with a swipe instead of button
76
   },
79
   },
77
   passProps: {}, // simple serializable object that will pass as props to all top screens (optional)
80
   passProps: {}, // simple serializable object that will pass as props to all top screens (optional)
106
       leftDrawerWidth: 50 // optional, add this if you want a define left drawer width (50=percent)
109
       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)
110
       rightDrawerWidth: 50 // optional, add this if you want a define right drawer width (50=percent)
108
     },
111
     },
112
+    type: 'MMDrawer', // optional, iOS only, types: 'TheSideBar', 'MMDrawer' default: 'MMDrawer'
113
+    animationType: 'door', //optional, iOS only, for MMDrawer: 'door', 'parallax', 'slide', 'slide-and-scale'
114
+                                        // for TheSideBar: 'airbnb', 'facebook', 'luvocracy','wunder-list'
109
     disableOpenGesture: false // optional, can the drawer be opened with a swipe instead of button
115
     disableOpenGesture: false // optional, can the drawer be opened with a swipe instead of button
110
   },
116
   },
111
   passProps: {}, // simple serializable object that will pass as props to all top screens (optional)
117
   passProps: {}, // simple serializable object that will pass as props to all top screens (optional)