Browse Source

Update docs (#2774)

* Update TopBar docs (animateHide -> animate)

* Update BottomTabs docs (animateHide -> animate)

* Update Navigation.push docs

* docs/installation-android: remove "@Nullable" annotation

* Docs/SideMenu: Add 'center' prop
jamsch 6 years ago
parent
commit
24116943c7

+ 1
- 0
docs/docs/SideMenu.md View File

@@ -5,5 +5,6 @@
5 5
 | Name | Type |
6 6
 | --- | --- |
7 7
 | left | <a href="https://wix.github.io/react-native-navigation/v2/#/docs/Component">Component</a> | 
8
+| center | <a href="https://wix.github.io/react-native-navigation/v2/#/docs/Component">Component</a> | 
8 9
 | right | <a href="https://wix.github.io/react-native-navigation/v2/#/docs/Component">Component</a> | 
9 10
 

+ 0
- 1
docs/docs/installation-android.md View File

@@ -117,7 +117,6 @@
117 117
 		return BuildConfig.DEBUG;
118 118
 	}
119 119
 
120
-	@Nullable
121 120
 	@Override
122 121
 	public List<ReactPackage> createAdditionalReactPackages() {
123 122
 		return Arrays.<ReactPackage>asList(

+ 1
- 1
docs/docs/options/BottomTabs.md View File

@@ -7,7 +7,7 @@
7 7
 | currentTabId | <code>string</code> | 
8 8
 | currentTabIndex | <code>number</code> | 
9 9
 | hidden | <code>boolean</code> | 
10
-| animateHide | <code>boolean</code> | 
10
+| animate | <code>boolean</code> | 
11 11
 | testID | <code>string</code> | 
12 12
 | drawUnder | <code>boolean</code> | 
13 13
 

+ 1
- 1
docs/docs/options/TopBar.md View File

@@ -12,7 +12,7 @@
12 12
 | textFontFamily | <code>string</code> | 
13 13
 | testID | <code>string</code> | 
14 14
 | hidden | <code>boolean</code> | 
15
-| animateHide | <code>boolean</code> | 
15
+| animate | <code>boolean</code> | 
16 16
 | hideOnScroll | <code>boolean</code> | 
17 17
 | transparent | <code>boolean</code> | 
18 18
 | translucent | <code>boolean</code> | 

+ 4
- 2
docs/docs/usage.md View File

@@ -123,8 +123,10 @@ Push a new screen into this screen's navigation stack.
123 123
 
124 124
 ```js
125 125
 Navigation.push(this.props.componentId, {
126
-  name: 'navigation.playground.PushedScreen',
127
-  passProps: {}
126
+  component: {
127
+    name: 'navigation.playground.PushedScreen',
128
+    passProps: {}
129
+  }
128 130
 });
129 131
 ```
130 132
 ### pop(componentId)