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

Update README.md (#2082)

bogobogo 7 years ago
parent
b972df98ae
commit
ebc4ecf4b8
1 changed files with 103 additions and 7 deletions
Split View Show Diff Stats
  1. 103
    7
      README.md

+ 103
- 7
README.md View File 

@@ -5,7 +5,8 @@
5 5 
 We are rebuilding react-native-navigation
6 6
7 7 
 - [Why?](#why-rebuild-react-native-navigation)
8 
-- [Where is it standing now?](#current-status)
8 
+- [v2 Roadmap](#v2-roadmap)
9 
+- [v1 vs v2 feature comparison](#v1-vs-v2-feature-comparison)
9 10 
 - [Documentation](https://wix.github.io/react-native-navigation/v2/)
10 11 
 - [Contributing](/docs/docs/CONTRIBUTING.md)
11 12 
 
@@ -30,8 +31,105 @@ v2 is written with contributors in mind from day one.
30 31 
 #### Written In TDD
31 32 
 v2 is written in Test Driven Development. We have a test for every feature including features that are not implemented yet. This makes accepting pull requests extremely easy: If our tests pass, your pull request is accepted.
32 33
34 
+## v2 Roadmap
33 35
34 
-## Current Status
36 
+### Current Priorities
37 
+
38 
+1) buttons in Android
39 
+2) showOverlay in iOS
40 
+3) showOverlay in Android
41 
+4) async commands
42 
+5) currentTab
43 
+6) change navigationOptions to be nested
44 
+
45 
+### Top API
46 
+
47 
+|       Top API         | iOS  | Android |
48 
+|--------------------|-----|----|
49 
+| setRoot   |   ✅    |   ✅  |
50 
+| registerContainer |   ✅   |  ✅   |
51 
+| container     |   ✅   |  ✅   |
52 
+| sideMenu             |    ✅  |    ✅ |
53 
+| tabs            |    ✅  |    ✅ |
54 
+| customViewController           |   [Contribute](/docs/docs/CONTRIBUTING.md)  |   [Contribute](/docs/docs/CONTRIBUTING.md) |
55 
+| splitView           |   [Contribute](/docs/docs/CONTRIBUTING.md)   |   [Contribute](/docs/docs/CONTRIBUTING.md) |
56 
+
57 
+### Screen API
58 
+
59 
+|       Screen API         | iOS  | Android |
60 
+|--------------------|-----|----|
61 
+| push              |   ✅       |	✅		|
62 
+| pop               |  ✅        |	✅	|
63 
+| popToRoot              |   ✅         |✅	|
64 
+| resetTo             |   ✅        |	✅|
65 
+| showModal              |  ✅        |	✅|
66 
+| dismissModal           |     ✅       |	✅|
67 
+| showOverlay             |  [Contribute](/docs/docs/CONTRIBUTING.md)         |	[Contribute](/docs/docs/CONTRIBUTING.md) |
68 
+| dismissOverlay             |  [Contribute](/docs/docs/CONTRIBUTING.md)         |	[Contribute](/docs/docs/CONTRIBUTING.md) |
69 
+| customTransition            |   ✅        |	[Contribute](/docs/docs/CONTRIBUTING.md) |
70 
+| Screen Visibility        | ✅     |✅|
71 
+| async commands (await push)     |  [Contribute](/docs/docs/CONTRIBUTING.md)        |[Contribute](/docs/docs/CONTRIBUTING.md)   |
72 
+
73 
+### Navigation Options
74 
+
75 
+|       topBar         | iOS  | Android | contributors|
76 
+|--------------------|-----|----|-----|
77 
+| title         |        	✅    | 	✅| Wix|
78 
+| textColor    | ✅     |     ✅        | Wix|
79 
+| textFontSize       |    ✅      |     ✅        | Wix|
80 
+| textFontFamily     |      ✅     |     ✅        | Wix |
81 
+| backgroundColor    |  ✅       |     ✅         | Wix|
82 
+| buttonColor         |    ✅      |     [Contribute](/docs/docs/CONTRIBUTING.md)        | Wix|
83 
+| hidden             |   ✅      |     ✅        | Wix|
84 
+| hideOnScroll         |  ✅    |     [Contribute](/docs/docs/CONTRIBUTING.md)        | Wix|
85 
+| translucent         |   ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)        | Wix|
86 
+| transparent         |   WIP @bogobogo     |     [Contribute](/docs/docs/CONTRIBUTING.md)        |
87 
+| noBorder             |    ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)        |  @gtchance|
88 
+| drawUnder         |    WIP @gran33     |      [Contribute](/docs/docs/CONTRIBUTING.md)       ||
89 
+| blur               |    ✅     |      [Contribute](/docs/docs/CONTRIBUTING.md)       | @gtchance|
90 
+| custom          |     WIP @gran33     | [Contribute](/docs/docs/CONTRIBUTING.md)|
91 
+| subtitleColor            |   [Contribute](/docs/docs/CONTRIBUTING.md)     |      [Contribute](/docs/docs/CONTRIBUTING.md)      |
92 
+| subtitleFontFamily      |    [Contribute](/docs/docs/CONTRIBUTING.md)    |     [Contribute](/docs/docs/CONTRIBUTING.md)       |
93 
+| largeTitle (iOS 11)      |    ✅     |     /iOS Specific       |
94 
+
95 
+|       tabBar         | iOS  | Android | contributors|
96 
+|--------------------|-----|----|-----|
97 
+| drawUnder          |    WIP @gran33     |      [Contribute](/docs/docs/CONTRIBUTING.md)       | |
98 
+| hidden   |   ✅     |    [Contribute](/docs/docs/CONTRIBUTING.md)        | @gtchance|
99 
+| tabBadge          |       ✅    | [Contribute](/docs/docs/CONTRIBUTING.md)| Wix|
100 
+| currentTab by Index          |       [Contribute](/docs/docs/CONTRIBUTING.md)    | [Contribute](/docs/docs/CONTRIBUTING.md)| |
101 
+| currentTab by cointainerId         |       [Contribute](/docs/docs/CONTRIBUTING.md)    | [Contribute](/docs/docs/CONTRIBUTING.md)| |
102 
+
103 
+|       buttons        | iOS  | Android | contributors|
104 
+|--------------------|-----|----|-----|
105 
+| id    |   ✅      |      [Contribute](/docs/docs/CONTRIBUTING.md)    |@Johan-dutoit|
106 
+| testID   |     ✅   |    [Contribute](/docs/docs/CONTRIBUTING.md)      | @Johan-dutoit|
107 
+| color             |    ✅     |      [Contribute](/docs/docs/CONTRIBUTING.md)       | @Johan-dutoit|
108 
+| icon          |   ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)       | @Johan-dutoit|
109 
+| disableTint        |    ✅       |     [Contribute](/docs/docs/CONTRIBUTING.md)      | @Johan-dutoit|
110 
+| fontSize        |    ✅       |     [Contribute](/docs/docs/CONTRIBUTING.md)      | @Johan-dutoit |
111 
+| fontWeight        |    ✅       |     [Contribute](/docs/docs/CONTRIBUTING.md)      | @Johan-dutoit |
112 
+| fontWeight        |    ✅       |     [Contribute](/docs/docs/CONTRIBUTING.md)      | @Johan-dutoit |
113 
+
114 
+|       statusBar        | iOS  | Android | contributors|
115 
+|--------------------|-----|----|-----|
116 
+| textColorScheme    |   in development      |      / iOS specific    |
117 
+| textColorSchemeSingleScreen   |     in development    |     / iOS specific      |
118 
+| blur             |    ✅     |      [Contribute](/docs/docs/CONTRIBUTING.md)       | @gtchance|
119 
+| hideWithTopBar          |   ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)       | @gtchance|
120 
+| hidden         |    ✅       |     [Contribute](/docs/docs/CONTRIBUTING.md)      | WIX |
121 
+
122 
+|       other        | iOS  | Android | contributors|
123 
+|--------------------|-----|----|-----|
124 
+| screenBackgroundColor        |   ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)       |  Wix|
125 
+| orientation       |    ✅     |   [Contribute](/docs/docs/CONTRIBUTING.md)          | Wix|
126 
+| disabledBackGesture        |  WIP @gran33     |    / iOS specific     |
127 
+| screenBackgroundImageName        |   [Contribute](/docs/docs/CONTRIBUTING.md)      |    [Contribute](/docs/docs/CONTRIBUTING.md)        |
128 
+| rootBackgroundImageName              |    [Contribute](/docs/docs/CONTRIBUTING.md)     |    [Contribute](/docs/docs/CONTRIBUTING.md)       |
129 
+| sideMenuVisible          |        [Contribute](/docs/docs/CONTRIBUTING.md)   | [Contribute](/docs/docs/CONTRIBUTING.md) |
130 
+
131 
+
132 
+## v1 vs v2 Feature Comparison
35 133 
 v2 currently supports most of react-native-navigation’s basic functionality but it is still behind v1.
36 134 
 Here is the full comparison of features between v1 and v2 (will be updated regularly):
37 135 
 ### Top Level API
 
@@ -87,8 +185,8 @@ Note:  v1 properties with names beginning with 'navBar' are replaced in v2 with
87 185 
 | tabBarHidden  |   ✅  |   ✅     |    [Contribute](/docs/docs/CONTRIBUTING.md)        | @gtchance|
88 186 
 | statusBarTextColorScheme |  ✅   |   in development      |      / iOS specific    |
89 187 
 | statusBarTextColorSchemeSingleScreen|  ✅   |     in development    |     / iOS specific      |
90 
-| navBarSubtitleColor          |  ✅   |   [Contribute](/docs/docs/CONTRIBUTING.md)     |      [Contribute](/docs/docs/CONTRIBUTING.md)      |
91 
-| navBarSubtitleFontFamily    |   ✅  |    [Contribute](/docs/docs/CONTRIBUTING.md)    |     [Contribute](/docs/docs/CONTRIBUTING.md)       |
188 
+| topBarSubtitleColor          |  ✅   |   [Contribute](/docs/docs/CONTRIBUTING.md)     |      [Contribute](/docs/docs/CONTRIBUTING.md)      |
189 
+| topBarSubtitleFontFamily    |   ✅  |    [Contribute](/docs/docs/CONTRIBUTING.md)    |     [Contribute](/docs/docs/CONTRIBUTING.md)       |
92 190 
 | screenBackgroundColor     | ✅    |   ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)       |  Wix|
93 191 
 | orientation     |  ✅   |    ✅     |   [Contribute](/docs/docs/CONTRIBUTING.md)          | Wix|
94 192 
 | statusBarHideWithTopBar        |  ✅   |   ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)       | @gtchance|
 
@@ -99,11 +197,9 @@ Note:  v1 properties with names beginning with 'navBar' are replaced in v2 with
99 197 
 | setButtons          |   ✅     |    ✅    | [Contribute](/docs/docs/CONTRIBUTING.md) | @Johan-dutoit|
100 198 
 | title            |   ✅     |        	✅    | 	✅| Wix|
101 199 
 | toggleDrawer        |   ✅     |        [Contribute](/docs/docs/CONTRIBUTING.md)   | [Contribute](/docs/docs/CONTRIBUTING.md) |
102 
-| toggleTabs          |   ✅     |       in development    | in development|
103 200 
 | setTabBadge         |    ✅    |       ✅    | [Contribute](/docs/docs/CONTRIBUTING.md)| Wix|
104 201 
 | switchToTab         |    ✅    |       ✅   |[Contribute](/docs/docs/CONTRIBUTING.md) |
105 
-| toggleNavBar        |   ✅     |      WIP @gran33     | [Contribute](/docs/docs/CONTRIBUTING.md)|
106 
-| navBarCustomView        |   ✅     |     WIP @gran33     | [Contribute](/docs/docs/CONTRIBUTING.md)|
202 
+| topBarCustomView        |   ✅     |     WIP @gran33     | [Contribute](/docs/docs/CONTRIBUTING.md)|
107 203 
 | customTransition(shared element)       |     :x:  |     WIP @bogobogo     | [Contribute](/docs/docs/CONTRIBUTING.md)|
108 204 
 | splitViewScreen       |     :x:  |    [Contribute](/docs/docs/CONTRIBUTING.md)      | [Contribute](/docs/docs/CONTRIBUTING.md)|
109 205