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

Update roadmap

Guy Carmeli 6 years ago
parent
44b5a1e700
commit
dae2f2898a
1 changed files with 58 additions and 58 deletions
Split View Show Diff Stats
  1. 58
    58
      docs/README.md

+ 58
- 58
docs/README.md View File 

@@ -53,19 +53,19 @@ v2 is written in Test Driven Development. We have a test for every feature inclu
53 53 
 ### Top API
54 54
55 55 
 |       Top API         | iOS  | Android |
56 
-|--------------------|-----|----|
56 
+|--------------------|:-----:|:----:|
57 57 
 | setRoot   |   ✅    |   ✅  |
58 
-| registerContainer |   ✅   |  ✅   |
59 
-| container     |   ✅   |  ✅   |
58 
+| registerComponent |   ✅   |  ✅   |
59 
+| component     |   ✅   |  ✅   |
60 60 
 | sideMenu             |    ✅  |    ✅ |
61 61 
 | tabs            |    ✅  |    ✅ |
62 
-| customViewController           |   [Contribute](/docs/WorkingLocally.md)  |   [Contribute](/docs/WorkingLocally.md) |
62 
+| External Component       |   ✅  |   ✅ |
63 63 
 | splitView           |   [Contribute](/docs/WorkingLocally.md)   |   [Contribute](/docs/WorkingLocally.md) |
64 64
65 65 
 ### Screen API
66 66
67 67 
 |       Screen API         | iOS  | Android |
68 
-|--------------------|-----|----|
68 
+|--------------------|:-----:|:----:|
69 69 
 | push              |   ✅       |	✅		|
70 70 
 | pop               |  ✅        |	✅	|
71 71 
 | popToRoot              |   ✅         |✅	|
 
@@ -80,64 +80,64 @@ v2 is written in Test Driven Development. We have a test for every feature inclu
80 80
81 81 
 ### Navigation Options
82 82
83 
-|       topBar         | iOS  | Android | contributors|
84 
-|--------------------|-----|----|-----|
83 
+|       topBar         | iOS  | Android |
84 
+|--------------------|-----|:----:|:-----:
85 85 
 | title         |        	✅    | 	✅| Wix|
86 86 
 | textColor    | ✅     |     ✅        | Wix|
87 87 
 | textFontSize       |    ✅      |     ✅        | Wix|
88 88 
 | textFontFamily     |      ✅     |     ✅        | Wix |
89 89 
 | backgroundColor    |  ✅       |     ✅         | Wix|
90 
-| buttonColor         |    ✅      |     [Contribute](/docs/WorkingLocally.md)        | Wix|
90 
+| buttonColor         |    ✅      |✅| Wix|
91 91 
 | hidden             |   ✅      |     ✅        | Wix|
92 
-| hideOnScroll         |  ✅    |     [Contribute](/docs/WorkingLocally.md)        | Wix|
92 
+| hideOnScroll         |  ✅    |✅| Wix|
93 93 
 | translucent         |   ✅     |     [Contribute](/docs/WorkingLocally.md)        | Wix|
94 94 
 | transparent         |  ✅        |     [Contribute](/docs/WorkingLocally.md)        |
95 95 
 | noBorder             |    ✅     |     [Contribute](/docs/WorkingLocally.md)        |  @gtchance|
96 
-| drawUnder         |    ✅     |      [Contribute](/docs/WorkingLocally.md)       ||
96 
+| drawUnder         |    ✅     |✅||
97 97 
 | blur               |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
98 
-| custom          |     WIP @gran33     | [Contribute](/docs/WorkingLocally.md)|
99 
-| subtitleColor            |   [Contribute](/docs/WorkingLocally.md)     |      [Contribute](/docs/WorkingLocally.md)      |
98 
+| custom component          |✅     |✅|
99 
+| background component          |✅     |[Contribute](/docs/WorkingLocally.md)|
100 
+| subtitleColor            |   ✅      |[Contribute](/docs/WorkingLocally.md)
100 101 
 | subtitleFontFamily      |    [Contribute](/docs/WorkingLocally.md)    |     [Contribute](/docs/WorkingLocally.md)       |
101 102 
 | largeTitle (iOS 11)      |    ✅     |     /iOS Specific       |
102 103
103 
-|       tabBar         | iOS  | Android | contributors|
104 
-|--------------------|-----|----|-----|
105 
-| drawUnder          |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | |
104 
+|       tabBar         | iOS  | Android
105 
+|--------------------|-----|----|-----
106 
+| drawUnder          |    ✅     |✅| |
106 107 
 | hidden   |   ✅     |    ✅        | @gtchance |
107 
-| tabBadge          |       ✅    | [Contribute](/docs/WorkingLocally.md)| Wix|
108 
+| tabBadge          |       ✅    |✅| Wix|
108 109 
 | currentTab by Index          |       ✅    | ✅ | Wix |
109 
-| currentTab by cointainerId         |       [Contribute](/docs/WorkingLocally.md)    | ✅ | Wix |
110 
-
111 
-|       buttons        | iOS  | Android | contributors|
112 
-|--------------------|-----|----|-----|
113 
-| id    |   ✅      |     @Johan-dutoit  |@Johan-dutoit|
114 
-| testID   |     ✅   |   [Contribute](/docs/WorkingLocally.md)  | @Johan-dutoit|
115 
-| color             |    ✅     |     @Johan-dutoit     | @Johan-dutoit|
116 
-| icon          |   ✅     |    @Johan-dutoit     | @Johan-dutoit|
117 
-| disableTint        |    ✅       |    @Johan-dutoit    | @Johan-dutoit|
118 
-| fontSize        |    ✅       |    @Johan-dutoit    | @Johan-dutoit |
110 
+| currentTab by componentId         |✅| ✅ | Wix |
111 
+
112 
+|       buttons        | iOS  | Android |
113 
+|--------------------|-----|----|-----
114 
+| id    |   ✅      |✅|@Johan-dutoit|
115 
+| testID   |     ✅   |✅| @Johan-dutoit|
116 
+| color             |    ✅     |✅| @Johan-dutoit|
117 
+| icon          |   ✅     |✅| @Johan-dutoit|
118 
+| disableTint        |    ✅       |✅| @Johan-dutoit|
119 
+| fontSize        |    ✅       |✅| @Johan-dutoit |
119 120 
 | fontWeight        |    ✅       |    [Contribute](/docs/WorkingLocally.md)   |  [Contribute](/docs/WorkingLocally.md) |
120 121
121 
-|       statusBar        | iOS  | Android | contributors|
122 
-|--------------------|-----|----|-----|
123 
-| textColorScheme    |   in development      |      / iOS specific    |
124 
-| textColorSchemeSingleScreen   |     in development    |     / iOS specific      |
122 
+|       statusBar        | iOS  | Android |
123 
+|--------------------|-----|----|-----
124 
+| textColorScheme    |✅|[Contribute](/docs/WorkingLocally.md)
125 
+| textColorSchemeSingleScreen   |✅|     / iOS specific      |
125 126 
 | blur             |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
126 127 
 | hideWithTopBar          |   ✅     |     [Contribute](/docs/WorkingLocally.md)       | @gtchance|
127 128 
 | hidden         |    ✅       |     [Contribute](/docs/WorkingLocally.md)      | WIX |
128 129
129 
-|       other        | iOS  | Android | contributors|
130 
-|--------------------|-----|----|-----|
130 
+|       other        | iOS  | Android |
131 
+|--------------------|-----|----|-----
131 132 
 | screenBackgroundColor        |   ✅     |     [Contribute](/docs/WorkingLocally.md)       |  Wix|
132 
-| orientation       |    ✅     |   [Contribute](/docs/WorkingLocally.md)          | Wix|
133 
+| orientation       |    ✅     |✅| Wix|
133 134 
 | disabledBackGesture        |    ✅     |    / iOS specific     |
134 135 
 | screenBackgroundImageName        |   ✅      |    [Contribute](/docs/WorkingLocally.md)        |
135 136 
 | rootBackgroundImageName              |    ✅     |    [Contribute](/docs/WorkingLocally.md)       |
136 
-| sideMenuVisible          |      ✅   | [Contribute](/docs/WorkingLocally.md) |
137 
+| sideMenuVisible          |      ✅   |✅|
137 138
138 139
139 140 
 ## v1 vs v2 Feature Comparison
140 
-v2 currently supports most of react-native-navigation’s basic functionality but it is still behind v1.
141 141 
 Here is the full comparison of features between v1 and v2 (will be updated regularly):
142 142 
 ### Top Level API
143 143 
 
@@ -150,7 +150,7 @@ Here is the full comparison of features between v1 and v2 (will be updated regul
150 150 
 ### Screen API
151 151
152 152 
 |  API              | v1     | v2  iOS      |	v2 Android |
153 
-|---------------------|--------|------------|--------------|
153 
+|---------------------|:--------:|:------------:|:--------------:|
154 154 
 | push                |  ✅     |   ✅       |	✅		|
155 155 
 | pop                 |  ✅     |  ✅        |	✅	|
156 156 
 | showModal           |  ✅     |  ✅        |	✅|
 
@@ -160,12 +160,14 @@ Here is the full comparison of features between v1 and v2 (will be updated regul
160 160 
 | dismissAllModals    |   ✅     |      ✅      |	✅|
161 161 
 | showContextualMenu      |   ✅     |     / Android specific       |[Contribute](/docs/WorkingLocally.md) |
162 162 
 | dismissContextualMenu      |   ✅     |   / Androic specific        |[Contribute](/docs/WorkingLocally.md)  |
163 
-| showFab      |   ✅     |    / Android specific     |  [Contribute](/docs/WorkingLocally.md)  |
164 
-| dismissFab      |   ✅     |    / Android specific       | [Contribute](/docs/WorkingLocally.md) |
163 
+| showFab      |   ✅     |    / Android specific     |✅|
164 
+| dismissFab      |   ✅     |    / Android specific       |✅|
165 165 
 | showSnackBar     |   ✅     |     / Android specific    |   [Contribute](/docs/WorkingLocally.md) |
166 166 
 | dismissSnackBar     |   ✅     |    / Android specific      |  [Contribute](/docs/WorkingLocally.md) |
167 
-| showLightBox        |   ✅     |      [Contribute](/docs/WorkingLocally.md)      | [Contribute](/docs/WorkingLocally.md)  |
168 
-| dismissLightBox     |   ✅     |       [Contribute](/docs/WorkingLocally.md)       | [Contribute](/docs/WorkingLocally.md) |
167 
+| showLightBox        |   ✅     |:x:      |:x:  |
168 
+| dismissLightBox     |   ✅     |:x:|:x: |
169 
+| showOverlay|:x:|✅|✅|
170 
+| dismissOverlay|:x:|✅|✅|
169 171 
 | handleDeepLink      |   ✅     |       [Contribute](/docs/WorkingLocally.md)       | [Contribute](/docs/WorkingLocally.md) |
170 172 
 | Screen Visibility   |   ✅     |       ✅     |✅|
171 173 
 
@@ -173,41 +175,39 @@ Here is the full comparison of features between v1 and v2 (will be updated regul
173 175
174 176 
 Note:  v1 properties with names beginning with 'navBar' are replaced in v2 with properties beginning with 'topBar' to avoid confusion with the Android native bottom nav bar.
175 177
176 
-|                       | v1  | v2 iOS | v2 Android | Contributors |
177 
-|-----------------------|-----|--------|------------|------------|
178 
+|                       | v1  | v2 iOS | v2 Android |
179 
+|-----------------------|:--------:|:------------:|:----------|
178 180 
 | topBarTextColor |   ✅    |    ✅     |     ✅        | Wix|
179 181 
 | topBarTextFontSize    |   ✅    |    ✅      |     ✅        | Wix|
180 182 
 | topBarTextFontFamily  |  ✅     |      ✅     |     ✅        | Wix |
181 183 
 | topBarBackgroundColor |  ✅     |  ✅       |     ✅         | Wix|
182 
-| topBarButtonColor     |  ✅     |    ✅      |     [Contribute](/docs/WorkingLocally.md)        | Wix|
184 
+| topBarButtonColor     |  ✅     |    ✅      |✅| Wix|
183 185 
 | topBarHidden          |   ✅    |   ✅      |     ✅        | Wix|
184 
-| topBarHideOnScroll    |  ✅     |  ✅    |     [Contribute](/docs/WorkingLocally.md)        | Wix|
186 
+| topBarHideOnScroll    |  ✅     |  ✅    |✅| Wix|
185 187 
 | topBarTranslucent     |  ✅     |   ✅     |     [Contribute](/docs/WorkingLocally.md)        | Wix|
186 
-| topBarTransparent     | ✅      |   WIP @bogobogo     |     [Contribute](/docs/WorkingLocally.md)        |
188 
+| topBarTransparent     | ✅      |[Contribute](/docs/WorkingLocally.md)|     [Contribute](/docs/WorkingLocally.md)        |
187 189 
 | topBarNoBorder        |  ✅     |    ✅     |     [Contribute](/docs/WorkingLocally.md)        |  @gtchance|
188 
-| drawUnderTabBar       |  ✅     |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | |
189 
-| drawUnderTopBar       |  ✅     |    ✅     |      [Contribute](/docs/WorkingLocally.md)       ||
190 
+| drawUnderTabBar       |  ✅     |    ✅     |✅| |
191 
+| drawUnderTopBar       |  ✅     |    ✅     |✅||
190 192 
 | statusBarBlur         |  ✅     |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
191 193 
 | topBarBlur            | ✅      |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
192 
-| tabBarHidden  |   ✅  |   ✅     |    [Contribute](/docs/WorkingLocally.md)        | @gtchance|
194 
+| tabBarHidden  |   ✅  |   ✅     |✅| @gtchance|
193 195 
 | statusBarTextColorScheme |  ✅   |   in development      |      / iOS specific    |
194 196 
 | statusBarTextColorSchemeSingleScreen|  ✅   |     in development    |     / iOS specific      |
195 197 
 | topBarSubtitleColor          |  ✅   |   [Contribute](/docs/WorkingLocally.md)     |      [Contribute](/docs/WorkingLocally.md)      |
196 198 
 | topBarSubtitleFontFamily    |   ✅  |    [Contribute](/docs/WorkingLocally.md)    |     [Contribute](/docs/WorkingLocally.md)       |
197 199 
 | screenBackgroundColor     | ✅    |   ✅     |     [Contribute](/docs/WorkingLocally.md)       |  Wix|
198 
-| orientation     |  ✅   |    ✅     |   [Contribute](/docs/WorkingLocally.md)          | Wix|
200 
+| orientation     |  ✅   |    ✅     |✅| Wix|
199 201 
 | statusBarHideWithTopBar        |  ✅   |   ✅     |     [Contribute](/docs/WorkingLocally.md)       | @gtchance|
200 202 
 | statusBarHidden       |  ✅   |    ✅       |     [Contribute](/docs/WorkingLocally.md)      | WIX |
201 203 
 | disabledBackGesture       |   ✅  |   ✅  |    / iOS specific     |
202 204 
 | screenBackgroundImageName         |   ✅  |   ✅      |    [Contribute](/docs/WorkingLocally.md)        |
203 205 
 | rootBackgroundImageName            |  ✅   |    ✅     |    [Contribute](/docs/WorkingLocally.md)       |
204 
-| setButtons          |   ✅     |    ✅    | [Contribute](/docs/WorkingLocally.md) | @Johan-dutoit|
205 
-| title            |   ✅     |        	✅    | 	✅| Wix|
206 
-| toggleDrawer        |   ✅     |       ✅    | [Contribute](/docs/WorkingLocally.md) |
207 
-| setTabBadge         |    ✅    |       ✅    | [Contribute](/docs/WorkingLocally.md)| Wix|
208 
-| switchToTab         |    ✅    |       ✅   |[Contribute](/docs/WorkingLocally.md) |
209 
-| topBarCustomView        |   ✅     |     WIP @gran33     | [Contribute](/docs/WorkingLocally.md)|
210 
-| customTransition(shared element)       |     :x:  |     WIP @bogobogo     | [Contribute](/docs/WorkingLocally.md)|
206 
+| setButtons          |   ✅     |    ✅    |✅| @Johan-dutoit|
207 
+| title            |   ✅     |✅|    ✅| Wix|
208 
+| toggleDrawer        |   ✅     |       ✅    |✅|
209 
+| setTabBadge         |    ✅    |       ✅    |✅| Wix|
210 
+| switchToTab         |    ✅    |       ✅   |✅|
211 
+| topBar react component        |   ✅     |✅|✅|
212 
+|Shared Element Transition|     :x:  |✅| [Contribute](/docs/WorkingLocally.md)|
211 213 
 | splitViewScreen       |     :x:  |    [Contribute](/docs/WorkingLocally.md)      | [Contribute](/docs/WorkingLocally.md)|
212 
-
213 
-Element transitions, adding buttons and styles are not yet implemented. [Contribute](/docs/WorkingLocally.md)