|
@@ -17,6 +17,8 @@
|
17
|
17
|
* [.events()](#Navigation+events)
|
18
|
18
|
|
19
|
19
|
|
|
20
|
+* * *
|
|
21
|
+
|
20
|
22
|
<a name="Navigation+registerContainer"></a>
|
21
|
23
|
|
22
|
24
|
### navigation.registerContainer(containerName, getContainerFunc)
|
|
@@ -29,6 +31,8 @@ Every screen component in your app must be registered with a unique name. The co
|
29
|
31
|
| getContainerFunc | <code>function</code> | generator function, typically `() => require('./myContainer')` |
|
30
|
32
|
|
31
|
33
|
|
|
34
|
+* * *
|
|
35
|
+
|
32
|
36
|
<a name="Navigation+setRoot"></a>
|
33
|
37
|
|
34
|
38
|
### navigation.setRoot(root)
|
|
@@ -40,6 +44,8 @@ Reset the navigation stack to a new screen (the stack root is changed).
|
40
|
44
|
| root | <code>Root</code> |
|
41
|
45
|
|
42
|
46
|
|
|
47
|
+* * *
|
|
48
|
+
|
43
|
49
|
<a name="Navigation+setDefaultOptions"></a>
|
44
|
50
|
|
45
|
51
|
### navigation.setDefaultOptions(options)
|
|
@@ -51,6 +57,8 @@ Set default options to all screens. Useful for declaring a consistent style acro
|
51
|
57
|
| options | <code>NavigationOptions</code> |
|
52
|
58
|
|
53
|
59
|
|
|
60
|
+* * *
|
|
61
|
+
|
54
|
62
|
<a name="Navigation+setOptions"></a>
|
55
|
63
|
|
56
|
64
|
### navigation.setOptions(containerId, options)
|
|
@@ -63,6 +71,8 @@ Change a containers navigation options
|
63
|
71
|
| options | <code>NavigationOptions</code> | |
|
64
|
72
|
|
65
|
73
|
|
|
74
|
+* * *
|
|
75
|
+
|
66
|
76
|
<a name="Navigation+showModal"></a>
|
67
|
77
|
|
68
|
78
|
### navigation.showModal(params)
|
|
@@ -74,6 +84,8 @@ Show a screen as a modal.
|
74
|
84
|
| params | <code>Object</code> |
|
75
|
85
|
|
76
|
86
|
|
|
87
|
+* * *
|
|
88
|
+
|
77
|
89
|
<a name="Navigation+dismissModal"></a>
|
78
|
90
|
|
79
|
91
|
### navigation.dismissModal(containerId)
|
|
@@ -85,12 +97,16 @@ Dismiss a modal by containerId. The dismissed modal can be anywhere in the stack
|
85
|
97
|
| containerId | <code>String</code> | The container's id. |
|
86
|
98
|
|
87
|
99
|
|
|
100
|
+* * *
|
|
101
|
+
|
88
|
102
|
<a name="Navigation+dismissAllModals"></a>
|
89
|
103
|
|
90
|
104
|
### navigation.dismissAllModals()
|
91
|
105
|
Dismiss all Modals
|
92
|
106
|
|
93
|
107
|
|
|
108
|
+* * *
|
|
109
|
+
|
94
|
110
|
<a name="Navigation+push"></a>
|
95
|
111
|
|
96
|
112
|
### navigation.push(containerId, params)
|
|
@@ -103,6 +119,8 @@ Push a new screen into this screen's navigation stack.
|
103
|
119
|
| params | <code>\*</code> | |
|
104
|
120
|
|
105
|
121
|
|
|
122
|
+* * *
|
|
123
|
+
|
106
|
124
|
<a name="Navigation+pop"></a>
|
107
|
125
|
|
108
|
126
|
### navigation.pop(containerId, params)
|
|
@@ -115,6 +133,8 @@ Pop a container from the stack, regardless of it's position.
|
115
|
133
|
| params | <code>\*</code> | |
|
116
|
134
|
|
117
|
135
|
|
|
136
|
+* * *
|
|
137
|
+
|
118
|
138
|
<a name="Navigation+popTo"></a>
|
119
|
139
|
|
120
|
140
|
### navigation.popTo(containerId)
|
|
@@ -126,6 +146,8 @@ Pop the stack to a given container
|
126
|
146
|
| containerId | <code>String</code> | The container's id. |
|
127
|
147
|
|
128
|
148
|
|
|
149
|
+* * *
|
|
150
|
+
|
129
|
151
|
<a name="Navigation+popToRoot"></a>
|
130
|
152
|
|
131
|
153
|
### navigation.popToRoot(containerId)
|
|
@@ -137,9 +159,10 @@ Pop the container's stack to root.
|
137
|
159
|
| containerId | <code>\*</code> |
|
138
|
160
|
|
139
|
161
|
|
|
162
|
+* * *
|
|
163
|
+
|
140
|
164
|
<a name="Navigation+events"></a>
|
141
|
165
|
|
142
|
166
|
### navigation.events()
|
143
|
167
|
Obtain the events registery instance
|
144
|
168
|
|
145
|
|
-
|