Browse Source

Update layout types docs

Guy Carmeli 6 years ago
parent
commit
19b657b218
1 changed files with 18 additions and 20 deletions
  1. 18
    20
      docs/docs/layout-types.md

+ 18
- 20
docs/docs/layout-types.md View File

@@ -1,9 +1,24 @@
1 1
 # Layout Types
2 2
 
3
+## component
4
+
5
+Component layout holds a single react component.
6
+
7
+```js
8
+const component = {
9
+  id: 'comopnent1', // Optional, Auto generated if empty
10
+  name: 'Your registered component name',
11
+  options: {},
12
+  passProps: {
13
+    text: 'This text will be available in your component.props'
14
+  }
15
+}
16
+```
17
+
3 18
 ## stack
4 19
 
5
-Expect children layouts of any kind.\
6
-When initializing with more than one screen last screen will be presented at the top of the stack.
20
+Support children layouts of any kind.
21
+When initialized with more than one screen, the last screen will be presented at the top of the stack.
7 22
 
8 23
 ```js
9 24
 const stack = {
@@ -21,25 +36,8 @@ const stack = {
21 36
 }
22 37
 ```
23 38
 
24
-## component
25
-
26
-Component layout holds your react component.
27
-
28
-```js
29
-const component = {
30
-  id: 'comopnent1', // Optional, Auto generated if empty
31
-  name: 'Your registered component name',
32
-  options: {},
33
-  passProps: {
34
-    text: 'This text will be available in your component.props'
35
-  }
36
-}
37
-```
38
-
39 39
 ## bottomTabs
40 40
 
41
-Expect children layouts
42
-
43 41
 ```js
44 42
 const bottomTabs = {
45 43
   children: [
@@ -81,7 +79,7 @@ const sideMenu = {
81 79
 }
82 80
 ```
83 81
 
84
-## splitView
82
+## splitView (iOS only)
85 83
 
86 84
 Master and Detail based layout.
87 85