Browse Source

updated docs

Daniel Zlotin 6 years ago
parent
commit
a5f481fa06

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

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

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

2
 
2
 
3
 ## registerComponent
3
 ## registerComponent
4
 
4
 
5
-`registerComponent(componentName: string, getComponentClassFunc: ComponentProvider): ComponentType<any>`
5
+`registerComponent(componentName: string, getComponentClassFunc: ComponentProvider, ReduxProvider: any, userStore: any): ComponentType<any>`
6
 
6
 
7
 [source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/ComponentRegistry.ts#L10)
7
 [source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/ComponentRegistry.ts#L10)
8
 
8
 

+ 9
- 1
docs/api/ComponentWrapper.md View File

2
 
2
 
3
 ## wrap
3
 ## wrap
4
 
4
 
5
-`wrap(componentName: string, OriginalComponentClass: React.ComponentType<any>, store: any, componentEventsObserver: any): React.ComponentType<any>`
5
+`wrap(componentName: string, OriginalComponentClass: React.ComponentType<any>, store: any, componentEventsObserver: any, ReduxProvider: any, reduxStore: any): React.ComponentType<any>`
6
 
6
 
7
 [source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/ComponentWrapper.tsx#L7)
7
 [source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/ComponentWrapper.tsx#L7)
8
 
8
 
9
 ---
9
 ---
10
 
10
 
11
+## wrapWithRedux
12
+
13
+`wrapWithRedux(WrappedComponent: any, ReduxProvider: any, reduxStore: any): React.ComponentType<any>`
14
+
15
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/components/ComponentWrapper.tsx#L64)
16
+
17
+---
18
+
11
 
19
 

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

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

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

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

+ 33
- 17
docs/api/Navigation.md View File

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

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

4
 - [Element](/api/Element)
4
 - [Element](/api/Element)
5
 - [NativeCommandsSender](/api/NativeCommandsSender)
5
 - [NativeCommandsSender](/api/NativeCommandsSender)
6
 - [NativeEventsReceiver](/api/NativeEventsReceiver)
6
 - [NativeEventsReceiver](/api/NativeEventsReceiver)
7
+- [TouchablePreview](/api/TouchablePreview)
7
 - [UniqueIdProvider](/api/UniqueIdProvider)
8
 - [UniqueIdProvider](/api/UniqueIdProvider)
8
 - [Commands](/api/Commands)
9
 - [Commands](/api/Commands)
9
 - [LayoutTreeCrawler](/api/LayoutTreeCrawler)
10
 - [LayoutTreeCrawler](/api/LayoutTreeCrawler)

+ 65
- 0
docs/api/TouchablePreview.md View File

1
+# TouchablePreview
2
+
3
+## peeking
4
+
5
+`peeking (boolean)`
6
+
7
+---
8
+
9
+## onRef
10
+
11
+`onRef(ref: Component<any>): void`
12
+
13
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/TouchablePreview.tsx#L54)
14
+
15
+---
16
+
17
+## onPress
18
+
19
+`onPress(): void`
20
+
21
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/TouchablePreview.tsx#L58)
22
+
23
+---
24
+
25
+## onPressIn
26
+
27
+`onPressIn(): void`
28
+
29
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/TouchablePreview.tsx#L68)
30
+
31
+---
32
+
33
+## onTouchStart
34
+
35
+`onTouchStart(event: GestureResponderEvent): void`
36
+
37
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/TouchablePreview.tsx#L85)
38
+
39
+---
40
+
41
+## onTouchMove
42
+
43
+`onTouchMove(event: GestureResponderEventWithForce): void`
44
+
45
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/TouchablePreview.tsx#L90)
46
+
47
+---
48
+
49
+## onTouchEnd
50
+
51
+`onTouchEnd(): void`
52
+
53
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/TouchablePreview.tsx#L106)
54
+
55
+---
56
+
57
+## render
58
+
59
+`render(): Element`
60
+
61
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/adapters/TouchablePreview.tsx#L115)
62
+
63
+---
64
+
65
+

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

4
 - [Element](/api/Element)
4
 - [Element](/api/Element)
5
 - [NativeCommandsSender](/api/NativeCommandsSender)
5
 - [NativeCommandsSender](/api/NativeCommandsSender)
6
 - [NativeEventsReceiver](/api/NativeEventsReceiver)
6
 - [NativeEventsReceiver](/api/NativeEventsReceiver)
7
+- [TouchablePreview](/api/TouchablePreview)
7
 - [UniqueIdProvider](/api/UniqueIdProvider)
8
 - [UniqueIdProvider](/api/UniqueIdProvider)
8
 - [Commands](/api/Commands)
9
 - [Commands](/api/Commands)
9
 - [LayoutTreeCrawler](/api/LayoutTreeCrawler)
10
 - [LayoutTreeCrawler](/api/LayoutTreeCrawler)

+ 0
- 1
package.json View File

60
     "@types/react": "16.x.x",
60
     "@types/react": "16.x.x",
61
     "@types/react-native": "0.51.x",
61
     "@types/react-native": "0.51.x",
62
     "@types/lodash": "4.x.x",
62
     "@types/lodash": "4.x.x",
63
-    "@types/prop-types": "15.x.x",
64
     "@types/react-test-renderer": "16.x.x",
63
     "@types/react-test-renderer": "16.x.x",
65
     "@types/jest": "22.x.x"
64
     "@types/jest": "22.x.x"
66
   },
65
   },

+ 0
- 1
scripts/gen-docs/ReflectionsReader.ts View File

25
     this.typedocApp = new Application({ ...OPTIONS, ...tsconfig.compilerOptions });
25
     this.typedocApp = new Application({ ...OPTIONS, ...tsconfig.compilerOptions });
26
   }
26
   }
27
 
27
 
28
-  // just class modules, TODO: extract interfaces and types to their own modules, generate docs for interfaces and types
29
   public read(rootPath: string): Reflections {
28
   public read(rootPath: string): Reflections {
30
     const expandedFiles = this.typedocApp.expandInputFiles([rootPath]);
29
     const expandedFiles = this.typedocApp.expandInputFiles([rootPath]);
31
     const projectReflection = this.typedocApp.convert(expandedFiles);
30
     const projectReflection = this.typedocApp.convert(expandedFiles);

+ 0
- 1
tsconfig.json View File

11
     "types": [
11
     "types": [
12
       "jest",
12
       "jest",
13
       "lodash",
13
       "lodash",
14
-      "prop-types",
15
       "react",
14
       "react",
16
       "react-native",
15
       "react-native",
17
       "react-test-renderer"
16
       "react-test-renderer"