npm
/
react-native-navigation
Watch 11
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

update docs

Daniel Zlotin 6 years ago
parent
cf7e817f96
commit
c657ff9fd6
12 changed files with 68 additions and 84 deletions
Split View Show Diff Stats
  1. 8
    16
      docs/api/ComponentEventsObserver.md
  2. 1
    1
      docs/api/Element.md
  3. 10
    18
      docs/api/EventsRegistry.md
  4. 8
    16
      docs/api/NativeEventsReceiver.md
  5. 18
    23
      docs/api/Navigation.md
  6. 10
    0
      docs/api/OptionsModalPresentationStyle.md
  7. 1
    1
      docs/api/README.md
  8. 1
    1
      docs/api/_sidebar.md
  9. 1
    1
      docs/docs/options-migration.md
  10. 3
    0
      docs/docs/screen-api.md
  11. 4
    4
      docs/docs/styling.md
  12. 3
    3
      docs/docs/topBar-buttons.md

+ 8
- 16
docs/api/ComponentEventsObserver.md View File 

@@ -4,7 +4,7 @@
4 4
5 5 
 `registerOnceForAllComponentEvents(): void`
6 6
7 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L27)
7 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L25)
8 8
9 9 
 ---
10 10 
 
@@ -12,7 +12,7 @@
12 12
13 13 
 `bindComponent(component: Component<any>): EventSubscription`
14 14
15 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L38)
15 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L35)
16 16
17 17 
 ---
18 18 
 
@@ -20,7 +20,7 @@
20 20
21 21 
 `unmounted(componentId: string): void`
22 22
23 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L52)
23 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L49)
24 24
25 25 
 ---
26 26 
 
@@ -28,7 +28,7 @@
28 28
29 29 
 `notifyComponentDidAppear(event: ComponentDidAppearEvent): void`
30 30
31 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L56)
31 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L53)
32 32
33 33 
 ---
34 34 
 
@@ -36,7 +36,7 @@
36 36
37 37 
 `notifyComponentDidDisappear(event: ComponentDidDisappearEvent): void`
38 38
39 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L60)
39 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L57)
40 40
41 41 
 ---
42 42 
 
@@ -44,7 +44,7 @@
44 44
45 45 
 `notifyNavigationButtonPressed(event: NavigationButtonPressedEvent): void`
46 46
47 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L64)
47 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L61)
48 48
49 49 
 ---
50 50 
 
@@ -52,7 +52,7 @@
52 52
53 53 
 `notifySearchBarUpdated(event: SearchBarUpdatedEvent): void`
54 54
55 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L68)
55 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L65)
56 56
57 57 
 ---
58 58 
 
@@ -60,15 +60,7 @@
60 60
61 61 
 `notifySearchBarCancelPressed(event: SearchBarCancelPressedEvent): void`
62 62
63 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L72)
64 
-
65 
----
66 
-
67 
-## notifyPreviewCompleted
68 
-
69 
-`notifyPreviewCompleted(event: PreviewCompletedEvent): void`
70 
-
71 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L76)
63 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L69)
72 64
73 65 
 ---
74 66

+ 1
- 1
docs/api/Element.md View File 

@@ -25,7 +25,7 @@
25 25
26 26 
 `render(): Element`
27 27
28 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/Element.tsx#L17)
28 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/Element.tsx#L18)
29 29
30 30 
 ---
31 31

+ 10
- 18
docs/api/EventsRegistry.md View File 

@@ -4,7 +4,7 @@
4 4
5 5 
 `registerAppLaunchedListener(callback: function): EventSubscription`
6 6
7 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L18)
7 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L17)
8 8
9 9 
 ---
10 10 
 
@@ -12,7 +12,7 @@
12 12
13 13 
 `registerComponentDidAppearListener(callback: function): EventSubscription`
14 14
15 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L22)
15 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L21)
16 16
17 17 
 ---
18 18 
 
@@ -20,7 +20,7 @@
20 20
21 21 
 `registerComponentDidDisappearListener(callback: function): EventSubscription`
22 22
23 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L26)
23 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L25)
24 24
25 25 
 ---
26 26 
 
@@ -28,7 +28,7 @@
28 28
29 29 
 `registerCommandCompletedListener(callback: function): EventSubscription`
30 30
31 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L30)
31 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L29)
32 32
33 33 
 ---
34 34 
 
@@ -36,7 +36,7 @@
36 36
37 37 
 `registerBottomTabSelectedListener(callback: function): EventSubscription`
38 38
39 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L34)
39 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L33)
40 40
41 41 
 ---
42 42 
 
@@ -44,7 +44,7 @@
44 44
45 45 
 `registerNavigationButtonPressedListener(callback: function): EventSubscription`
46 46
47 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L38)
47 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L37)
48 48
49 49 
 ---
50 50 
 
@@ -52,7 +52,7 @@
52 52
53 53 
 `registerSearchBarUpdatedListener(callback: function): EventSubscription`
54 54
55 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L42)
55 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L41)
56 56
57 57 
 ---
58 58 
 
@@ -60,15 +60,7 @@
60 60
61 61 
 `registerSearchBarCancelPressedListener(callback: function): EventSubscription`
62 62
63 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L46)
64 
-
65 
----
66 
-
67 
-## registerPreviewCompletedListener
68 
-
69 
-`registerPreviewCompletedListener(callback: function): EventSubscription`
70 
-
71 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L50)
63 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L45)
72 64
73 65 
 ---
74 66 
 
@@ -76,7 +68,7 @@
76 68
77 69 
 `registerCommandListener(callback: function): EventSubscription`
78 70
79 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L54)
71 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L49)
80 72
81 73 
 ---
82 74 
 
@@ -84,7 +76,7 @@
84 76
85 77 
 `bindComponent(component: Component<any>): EventSubscription`
86 78
87 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L58)
79 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/EventsRegistry.ts#L53)
88 80
89 81 
 ---
90 82

+ 8
- 16
docs/api/NativeEventsReceiver.md View File 

@@ -4,7 +4,7 @@
4 4
5 5 
 `registerAppLaunchedListener(callback: function): EventSubscription`
6 6
7 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L29)
7 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L28)
8 8
9 9 
 ---
10 10 
 
@@ -12,7 +12,7 @@
12 12
13 13 
 `registerComponentDidAppearListener(callback: function): EventSubscription`
14 14
15 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L33)
15 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L32)
16 16
17 17 
 ---
18 18 
 
@@ -20,7 +20,7 @@
20 20
21 21 
 `registerComponentDidDisappearListener(callback: function): EventSubscription`
22 22
23 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L37)
23 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L36)
24 24
25 25 
 ---
26 26 
 
@@ -28,7 +28,7 @@
28 28
29 29 
 `registerNavigationButtonPressedListener(callback: function): EventSubscription`
30 30
31 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L41)
31 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L40)
32 32
33 33 
 ---
34 34 
 
@@ -36,7 +36,7 @@
36 36
37 37 
 `registerSearchBarUpdatedListener(callback: function): EventSubscription`
38 38
39 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L45)
39 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L44)
40 40
41 41 
 ---
42 42 
 
@@ -44,15 +44,7 @@
44 44
45 45 
 `registerSearchBarCancelPressedListener(callback: function): EventSubscription`
46 46
47 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L49)
48 
-
49 
----
50 
-
51 
-## registerPreviewCompletedListener
52 
-
53 
-`registerPreviewCompletedListener(callback: function): EventSubscription`
54 
-
55 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L53)
47 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L48)
56 48
57 49 
 ---
58 50 
 
@@ -60,7 +52,7 @@
60 52
61 53 
 `registerCommandCompletedListener(callback: function): EventSubscription`
62 54
63 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L57)
55 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L52)
64 56
65 57 
 ---
66 58 
 
@@ -68,7 +60,7 @@
68 60
69 61 
 `registerBottomTabSelectedListener(callback: function): EventSubscription`
70 62
71 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L61)
63 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/NativeEventsReceiver.ts#L56)
72 64
73 65 
 ---
74 66

+ 18
- 23
docs/api/Navigation.md View File 

@@ -4,11 +4,6 @@
4 4
5 5 
 `Element (React.ComponentType<object>)`
6 6
7 
----
8 
-## TouchablePreview
9 
-
10 
-`TouchablePreview (React.ComponentType<TouchablePreviewProps>)`
11 
-
12 7 
 ---
13 8 
 ## store
14 9 
 
@@ -20,7 +15,7 @@
20 15
21 16 
 `registerComponent(componentName: string, getComponentClassFunc: ComponentProvider): ComponentType<any>`
22 17
23 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L55)
18 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L52)
24 19
25 20 
 Every navigation component in your app must be registered with a unique name.
26 21 
 The component itself is a traditional React component extending React.Component.
 
@@ -31,7 +26,7 @@ The component itself is a traditional React component extending React.Component.
31 26
32 27 
 `registerComponentWithRedux(componentName: string, getComponentClassFunc: ComponentProvider, ReduxProvider: any, reduxStore: any): ComponentType<any>`
33 28
34 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L63)
29 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L60)
35 30
36 31 
 Utility helper function like registerComponent,
37 32 
 wraps the provided component with a react-redux Provider with the passed redux store
 
@@ -42,7 +37,7 @@ wraps the provided component with a react-redux Provider with the passed redux s
42 37
43 38 
 `setRoot(layout: any): Promise<any>`
44 39
45 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L70)
40 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L67)
46 41
47 42 
 Reset the app to a new layout
48 43 
 
@@ -52,7 +47,7 @@ Reset the app to a new layout
52 47
53 48 
 `setDefaultOptions(options: any): void`
54 49
55 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L77)
50 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L74)
56 51
57 52 
 Set default options to all screens. Useful for declaring a consistent style across the app.
58 53 
 
@@ -62,7 +57,7 @@ Set default options to all screens. Useful for declaring a consistent style acro
62 57
63 58 
 `mergeOptions(componentId: string, options: any): void`
64 59
65 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L84)
60 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L81)
66 61
67 62 
 Change a component's navigation options
68 63 
 
@@ -72,7 +67,7 @@ Change a component's navigation options
72 67
73 68 
 `showModal(layout: any): Promise<any>`
74 69
75 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L91)
70 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L88)
76 71
77 72 
 Show a screen as a modal.
78 73 
 
@@ -82,7 +77,7 @@ Show a screen as a modal.
82 77
83 78 
 `dismissModal(componentId: string): Promise<any>`
84 79
85 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L98)
80 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L95)
86 81
87 82 
 Dismiss a modal by componentId. The dismissed modal can be anywhere in the stack.
88 83 
 
@@ -92,7 +87,7 @@ Dismiss a modal by componentId. The dismissed modal can be anywhere in the stack
92 87
93 88 
 `dismissAllModals(): Promise<any>`
94 89
95 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L105)
90 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L102)
96 91
97 92 
 Dismiss all Modals
98 93 
 
@@ -102,7 +97,7 @@ Dismiss all Modals
102 97
103 98 
 `push(componentId: string, layout: any): Promise<any>`
104 99
105 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L112)
100 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L109)
106 101
107 102 
 Push a new layout into this screen's navigation stack.
108 103 
 
@@ -112,7 +107,7 @@ Push a new layout into this screen's navigation stack.
112 107
113 108 
 `pop(componentId: string, params: any): Promise<any>`
114 109
115 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L119)
110 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L116)
116 111
117 112 
 Pop a component from the stack, regardless of it's position.
118 113 
 
@@ -122,7 +117,7 @@ Pop a component from the stack, regardless of it's position.
122 117
123 118 
 `popTo(componentId: string): Promise<any>`
124 119
125 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L126)
120 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L123)
126 121
127 122 
 Pop the stack to a given component
128 123 
 
@@ -132,7 +127,7 @@ Pop the stack to a given component
132 127
133 128 
 `popToRoot(componentId: string): Promise<any>`
134 129
135 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L133)
130 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L130)
136 131
137 132 
 Pop the component's stack to root.
138 133 
 
@@ -142,7 +137,7 @@ Pop the component's stack to root.
142 137
143 138 
 `setStackRoot(componentId: string, layout: any): Promise<any>`
144 139
145 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L140)
140 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L137)
146 141
147 142 
 Sets new root component to stack.
148 143 
 
@@ -152,7 +147,7 @@ Sets new root component to stack.
152 147
153 148 
 `showOverlay(layout: any): Promise<any>`
154 149
155 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L147)
150 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L144)
156 151
157 152 
 Show overlay on top of the entire app
158 153 
 
@@ -162,7 +157,7 @@ Show overlay on top of the entire app
162 157
163 158 
 `dismissOverlay(componentId: string): Promise<any>`
164 159
165 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L154)
160 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L151)
166 161
167 162 
 dismiss overlay by componentId
168 163 
 
@@ -172,7 +167,7 @@ dismiss overlay by componentId
172 167
173 168 
 `getLaunchArgs(): Promise<any>`
174 169
175 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L161)
170 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L158)
176 171
177 172 
 Resolves arguments passed on launch
178 173 
 
@@ -182,7 +177,7 @@ Resolves arguments passed on launch
182 177
183 178 
 `events(): EventsRegistry`
184 179
185 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L168)
180 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L165)
186 181
187 182 
 Obtain the events registry instance
188 183 
 
@@ -192,7 +187,7 @@ Obtain the events registry instance
192 187
193 188 
 `constants(): Promise<any>`
194 189
195 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L175)
190 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/Navigation.ts#L172)
196 191
197 192 
 Constants coming from native
198 193

+ 10
- 0
docs/api/OptionsModalPresentationStyle.md View File 

@@ -0,0 +1,10 @@
1 
+# OptionsModalPresentationStyle
2 
+
3 
+- currentContext
4 
+- formSheet
5 
+- fullScreen
6 
+- none
7 
+- overCurrentContext
8 
+- overFullScreen
9 
+- pageSheet
10 
+- popOver

+ 1
- 1
docs/api/README.md View File 

@@ -4,7 +4,6 @@
4 4 
 - [Element](/api/Element)
5 5 
 - [NativeCommandsSender](/api/NativeCommandsSender)
6 6 
 - [NativeEventsReceiver](/api/NativeEventsReceiver)
7 
-- [TouchablePreview](/api/TouchablePreview)
8 7 
 - [UniqueIdProvider](/api/UniqueIdProvider)
9 8 
 - [Commands](/api/Commands)
10 9 
 - [LayoutTreeCrawler](/api/LayoutTreeCrawler)
 
@@ -18,3 +17,4 @@
18 17 
 - [EventsRegistry](/api/EventsRegistry)
19 18 
 - [EventSubscription](/api/EventSubscription)
20 19 
 - [LayoutType](/api/LayoutType)
20 
+- [OptionsModalPresentationStyle](/api/OptionsModalPresentationStyle)

+ 1
- 1
docs/api/_sidebar.md View File 

@@ -4,7 +4,6 @@
4 4 
 - [Element](/api/Element)
5 5 
 - [NativeCommandsSender](/api/NativeCommandsSender)
6 6 
 - [NativeEventsReceiver](/api/NativeEventsReceiver)
7 
-- [TouchablePreview](/api/TouchablePreview)
8 7 
 - [UniqueIdProvider](/api/UniqueIdProvider)
9 8 
 - [Commands](/api/Commands)
10 9 
 - [LayoutTreeCrawler](/api/LayoutTreeCrawler)
 
@@ -18,3 +17,4 @@
18 17 
 - [EventsRegistry](/api/EventsRegistry)
19 18 
 - [EventSubscription](/api/EventSubscription)
20 19 
 - [LayoutType](/api/LayoutType)
20 
+- [OptionsModalPresentationStyle](/api/OptionsModalPresentationStyle)

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

@@ -169,7 +169,7 @@ Navigation.mergeOptions(this.props.componentId, {
169 169 
   }
170 170 
 });
171 171 
 ```
172 
-On **iOS**, BottomTab visibility can be changed only when pushing screens. This means that if you'd like to hide BottomTabs when pushing a screen, You'll need to set the property to `false` in the options passed to the `push` command or via the `static get options() {}` api.
172 
+On **iOS**, BottomTab visibility can be changed only when pushing screens. This means that if you'd like to hide BottomTabs when pushing a screen, You'll need to set the property to `false` in the options passed to the `push` command or via the `static options(passProps) {}` api.
173 173
174 174 
 ## statusBarHidden
175 175 
 StatusBar visibility

+ 3
- 0
docs/docs/screen-api.md View File 

@@ -128,6 +128,9 @@ this.props.navigator.handleDeepLink({
128 128
129 129 
 Set options dynamically for component.
130 130
131 
+WARNING! this is called after the component has been rendered at least once.
132 
+If you want the options to apply as soon as the screen is created, use `static options(passProps){...}` or pass the options as part of the push/modal etc command.
133 
+
131 134 
 ```js
132 135 
 Navigation.mergeOptions(this.props.componentId, {
133 136 
   topBar: {

+ 4
- 4
docs/docs/styling.md View File 

@@ -1,12 +1,12 @@
1 1 
 # Styling Options
2 2
3 
-You can style the navigator appearance and behavior by passing an `options` object. This object can be passed when the screen is originally created; can be defined per-screen by setting `static get options()` on the screen component; and can be overridden when a screen is pushed.
3 
+You can style the navigator appearance and behavior by passing an `options` object. This object can be passed when the screen is originally created; can be defined per-screen by setting `static options(passProps)` on the screen component; and can be overridden when a screen is pushed, dynamically (after the screen was already rendered at least once) using `mergeOptions()`.
4 4
5 
-The easiest way to style your screen is by adding `static get options()` to your screen React component definition.
5 
+The easiest way to style your screen is by adding `static options(passProps)` to your screen React component definition. `passProps` is the same passProps you can specify as part of the push/modal or other command operation.
6 6
7 7 
 ```js
8 8 
 export default class StyledScreen extends Component {
9 
-  static get options() {
9 
+  static options(passProps) {
10 10 
     return {
11 11 
       topBar: {
12 12 
         title: {
 
@@ -43,7 +43,7 @@ Navigation.setDefaultOptions({
43 43 
 ```
44 44
45 45 
 ## Setting styles dynamically
46 
-Use the `mergeOptions` method to change a screen's style dynamically.
46 
+Use the `mergeOptions` method to change a screen's style dynamically. WARNING! these options will be applied on an already rendered screen, after it has been rendered at least once.
47 47
48 48 
 ```js
49 49 
 Navigation.mergeOptions(this.props.componentId, {

+ 3
- 3
docs/docs/topBar-buttons.md View File 

@@ -20,11 +20,11 @@ The following options can be used to customise buttons.
20 20
21 21 
 # Declaring Buttons statically
22 22
23 
-Buttons can be defined in a screen's static options:
23 
+Buttons can be defined in a screen's options:
24 24
25 25 
 ```js
26 26 
 class MyScreen extends Component {
27 
-  static get options() {
27 
+  static options(passProps) {
28 28 
     return {
29 29 
       topBar: {
30 30 
         leftButtons: [
 
@@ -70,7 +70,7 @@ Example:
70 70
71 71 
 ```js
72 72 
 class MyScreen extends Component {
73 
-  static get options() {
73 
+  static options(passProps) {
74 74 
     return {
75 75 
       topBar: {
76 76 
         rightButtons: {