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
52c500c41e
commit
c123e9225d
3 changed files with 15 additions and 7 deletions
Split View Show Diff Stats
  1. 13
    5
      docs/api/ComponentEventsObserver.md
  2. 1
    1
      docs/api/ComponentRegistry.md
  3. 1
    1
      docs/api/ComponentWrapper.md

+ 13
- 5
docs/api/ComponentEventsObserver.md View File 

@@ -16,11 +16,19 @@
16 16
17 17 
 ---
18 18
19 
+## unmounted
20 
+
21 
+`unmounted(componentId: string): void`
22 
+
23 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L49)
24 
+
25 
+---
26 
+
19 27 
 ## notifyComponentDidAppear
20 28
21 29 
 `notifyComponentDidAppear(event: ComponentDidAppearEvent): void`
22 30
23 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L46)
31 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L53)
24 32
25 33 
 ---
26 34 
 
@@ -28,7 +36,7 @@
28 36
29 37 
 `notifyComponentDidDisappear(event: ComponentDidDisappearEvent): void`
30 38
31 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L50)
39 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L57)
32 40
33 41 
 ---
34 42 
 
@@ -36,7 +44,7 @@
36 44
37 45 
 `notifyNavigationButtonPressed(event: NavigationButtonPressedEvent): void`
38 46
39 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L54)
47 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L61)
40 48
41 49 
 ---
42 50 
 
@@ -44,7 +52,7 @@
44 52
45 53 
 `notifySearchBarUpdated(event: SearchBarUpdatedEvent): void`
46 54
47 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L58)
55 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L65)
48 56
49 57 
 ---
50 58 
 
@@ -52,7 +60,7 @@
52 60
53 61 
 `notifySearchBarCancelPressed(event: SearchBarCancelPressedEvent): void`
54 62
55 
-[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L62)
63 
+[source](https://github.com/wix/react-native-navigation/blob/v2/lib/src/events/ComponentEventsObserver.ts#L69)
56 64
57 65 
 ---
58 66

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

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

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

@@ -2,7 +2,7 @@
2 2
3 3 
 ## wrap
4 4
5 
-`wrap(componentName: string, OriginalComponentClass: React.ComponentType<any>, store: any): React.ComponentType<any>`
5 
+`wrap(componentName: string, OriginalComponentClass: React.ComponentType<any>, store: any, componentEventsObserver: 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