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

updated docs

Daniel Zlotin 6 years ago
parent
3d06fece5c
commit
a5f481fa06
12 changed files with 160 additions and 48 deletions
Split View Show Diff Stats
  1. 16
    8
      docs/api/ComponentEventsObserver.md
  2. 1
    1
      docs/api/ComponentRegistry.md
  3. 9
    1
      docs/api/ComponentWrapper.md
  4. 18
    10
      docs/api/EventsRegistry.md
  5. 16
    8
      docs/api/NativeEventsReceiver.md
  6. 33
    17
      docs/api/Navigation.md
  7. 1
    0
      docs/api/README.md
  8. 65
    0
      docs/api/TouchablePreview.md
  9. 1
    0
      docs/api/_sidebar.md
  10. 0
    1
      package.json
  11. 0
    1
      scripts/gen-docs/ReflectionsReader.ts
  12. 0
    1
      tsconfig.json

+ 16
- 8
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#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,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#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,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#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,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#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,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#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,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#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,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#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,7 +60,15 @@
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#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,7 +2,7 @@
2 2
3 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 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,10 +2,18 @@
2 2
3 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 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,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#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,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#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,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#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,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#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,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#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,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#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,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#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,7 +60,15 @@
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#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,7 +76,7 @@
68 76
69 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,7 +84,7 @@
76 84
77 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,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#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,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#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,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#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,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#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,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#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,7 +44,15 @@
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#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,7 +60,7 @@
52 60
53 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,7 +68,7 @@
60 68
61 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,6 +4,11 @@
4 4
5 5 
 `Element (React.ComponentType<object>)`
6 6
7 
+---
8 
+## TouchablePreview
9 
+
10 
+`TouchablePreview (React.ComponentType<TouchablePreviewProps>)`
11 
+
7 12 
 ---
8 13 
 ## store
9 14 
 
@@ -15,18 +20,29 @@
15 20
16 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 25 
 Every navigation component in your app must be registered with a unique name.
21 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 41 
 ## setRoot
26 42
27 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 47 
 Reset the app to a new layout
32 48 
 
@@ -36,7 +52,7 @@ Reset the app to a new layout
36 52
37 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 57 
 Set default options to all screens. Useful for declaring a consistent style across the app.
42 58 
 
@@ -46,7 +62,7 @@ Set default options to all screens. Useful for declaring a consistent style acro
46 62
47 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 67 
 Change a component's navigation options
52 68 
 
@@ -56,7 +72,7 @@ Change a component's navigation options
56 72
57 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 77 
 Show a screen as a modal.
62 78 
 
@@ -66,7 +82,7 @@ Show a screen as a modal.
66 82
67 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 87 
 Dismiss a modal by componentId. The dismissed modal can be anywhere in the stack.
72 88 
 
@@ -76,7 +92,7 @@ Dismiss a modal by componentId. The dismissed modal can be anywhere in the stack
76 92
77 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 97 
 Dismiss all Modals
82 98 
 
@@ -86,7 +102,7 @@ Dismiss all Modals
86 102
87 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 107 
 Push a new layout into this screen's navigation stack.
92 108 
 
@@ -96,7 +112,7 @@ Push a new layout into this screen's navigation stack.
96 112
97 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 117 
 Pop a component from the stack, regardless of it's position.
102 118 
 
@@ -106,7 +122,7 @@ Pop a component from the stack, regardless of it's position.
106 122
107 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 127 
 Pop the stack to a given component
112 128 
 
@@ -116,7 +132,7 @@ Pop the stack to a given component
116 132
117 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 137 
 Pop the component's stack to root.
122 138 
 
@@ -126,7 +142,7 @@ Pop the component's stack to root.
126 142
127 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 147 
 Sets new root component to stack.
132 148 
 
@@ -136,7 +152,7 @@ Sets new root component to stack.
136 152
137 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 157 
 Show overlay on top of the entire app
142 158 
 
@@ -146,7 +162,7 @@ Show overlay on top of the entire app
146 162
147 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 167 
 dismiss overlay by componentId
152 168 
 
@@ -156,7 +172,7 @@ dismiss overlay by componentId
156 172
157 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 177 
 Resolves arguments passed on launch
162 178 
 
@@ -166,7 +182,7 @@ Resolves arguments passed on launch
166 182
167 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 187 
 Obtain the events registry instance
172 188 
 
@@ -176,7 +192,7 @@ Obtain the events registry instance
176 192
177 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 197 
 Constants coming from native
182 198

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

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

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

@@ -0,0 +1,65 @@
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,6 +4,7 @@
4 4 
 - [Element](/api/Element)
5 5 
 - [NativeCommandsSender](/api/NativeCommandsSender)
6 6 
 - [NativeEventsReceiver](/api/NativeEventsReceiver)
7 
+- [TouchablePreview](/api/TouchablePreview)
7 8 
 - [UniqueIdProvider](/api/UniqueIdProvider)
8 9 
 - [Commands](/api/Commands)
9 10 
 - [LayoutTreeCrawler](/api/LayoutTreeCrawler)

+ 0
- 1
package.json View File 

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

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

@@ -25,7 +25,6 @@ export class ReflectionsReader {
25 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 28 
   public read(rootPath: string): Reflections {
30 29 
     const expandedFiles = this.typedocApp.expandInputFiles([rootPath]);
31 30 
     const projectReflection = this.typedocApp.convert(expandedFiles);

+ 0
- 1
tsconfig.json View File 

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