Browse Source

Update roadmap

Guy Carmeli 6 years ago
parent
commit
dae2f2898a
1 changed files with 58 additions and 58 deletions
  1. 58
    58
      docs/README.md

+ 58
- 58
docs/README.md View File

53
 ### Top API
53
 ### Top API
54
 
54
 
55
 |       Top API         | iOS  | Android |
55
 |       Top API         | iOS  | Android |
56
-|--------------------|-----|----|
56
+|--------------------|:-----:|:----:|
57
 | setRoot   |   ✅    |   ✅  |
57
 | setRoot   |   ✅    |   ✅  |
58
-| registerContainer |   ✅   |  ✅   |
59
-| container     |   ✅   |  ✅   |
58
+| registerComponent |   ✅   |  ✅   |
59
+| component     |   ✅   |  ✅   |
60
 | sideMenu             |    ✅  |    ✅ |
60
 | sideMenu             |    ✅  |    ✅ |
61
 | tabs            |    ✅  |    ✅ |
61
 | tabs            |    ✅  |    ✅ |
62
-| customViewController           |   [Contribute](/docs/WorkingLocally.md)  |   [Contribute](/docs/WorkingLocally.md) |
62
+| External Component       |   ✅  |   ✅ |
63
 | splitView           |   [Contribute](/docs/WorkingLocally.md)   |   [Contribute](/docs/WorkingLocally.md) |
63
 | splitView           |   [Contribute](/docs/WorkingLocally.md)   |   [Contribute](/docs/WorkingLocally.md) |
64
 
64
 
65
 ### Screen API
65
 ### Screen API
66
 
66
 
67
 |       Screen API         | iOS  | Android |
67
 |       Screen API         | iOS  | Android |
68
-|--------------------|-----|----|
68
+|--------------------|:-----:|:----:|
69
 | push              |   ✅       |	✅		|
69
 | push              |   ✅       |	✅		|
70
 | pop               |  ✅        |	✅	|
70
 | pop               |  ✅        |	✅	|
71
 | popToRoot              |   ✅         |✅	|
71
 | popToRoot              |   ✅         |✅	|
80
 
80
 
81
 ### Navigation Options
81
 ### Navigation Options
82
 
82
 
83
-|       topBar         | iOS  | Android | contributors|
84
-|--------------------|-----|----|-----|
83
+|       topBar         | iOS  | Android |
84
+|--------------------|-----|:----:|:-----:
85
 | title         |        	✅    | 	✅| Wix|
85
 | title         |        	✅    | 	✅| Wix|
86
 | textColor    | ✅     |     ✅        | Wix|
86
 | textColor    | ✅     |     ✅        | Wix|
87
 | textFontSize       |    ✅      |     ✅        | Wix|
87
 | textFontSize       |    ✅      |     ✅        | Wix|
88
 | textFontFamily     |      ✅     |     ✅        | Wix |
88
 | textFontFamily     |      ✅     |     ✅        | Wix |
89
 | backgroundColor    |  ✅       |     ✅         | Wix|
89
 | backgroundColor    |  ✅       |     ✅         | Wix|
90
-| buttonColor         |    ✅      |     [Contribute](/docs/WorkingLocally.md)        | Wix|
90
+| buttonColor         |    ✅      || Wix|
91
 | hidden             |   ✅      |     ✅        | Wix|
91
 | hidden             |   ✅      |     ✅        | Wix|
92
-| hideOnScroll         |  ✅    |     [Contribute](/docs/WorkingLocally.md)        | Wix|
92
+| hideOnScroll         |  ✅    || Wix|
93
 | translucent         |   ✅     |     [Contribute](/docs/WorkingLocally.md)        | Wix|
93
 | translucent         |   ✅     |     [Contribute](/docs/WorkingLocally.md)        | Wix|
94
 | transparent         |  ✅        |     [Contribute](/docs/WorkingLocally.md)        |
94
 | transparent         |  ✅        |     [Contribute](/docs/WorkingLocally.md)        |
95
 | noBorder             |    ✅     |     [Contribute](/docs/WorkingLocally.md)        |  @gtchance|
95
 | noBorder             |    ✅     |     [Contribute](/docs/WorkingLocally.md)        |  @gtchance|
96
-| drawUnder         |    ✅     |      [Contribute](/docs/WorkingLocally.md)       ||
96
+| drawUnder         |    ✅     |||
97
 | blur               |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
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
 | subtitleFontFamily      |    [Contribute](/docs/WorkingLocally.md)    |     [Contribute](/docs/WorkingLocally.md)       |
101
 | subtitleFontFamily      |    [Contribute](/docs/WorkingLocally.md)    |     [Contribute](/docs/WorkingLocally.md)       |
101
 | largeTitle (iOS 11)      |    ✅     |     /iOS Specific       |
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
 | hidden   |   ✅     |    ✅        | @gtchance |
107
 | hidden   |   ✅     |    ✅        | @gtchance |
107
-| tabBadge          |       ✅    | [Contribute](/docs/WorkingLocally.md)| Wix|
108
+| tabBadge          |       ✅    || Wix|
108
 | currentTab by Index          |       ✅    | ✅ | Wix |
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
 | fontWeight        |    ✅       |    [Contribute](/docs/WorkingLocally.md)   |  [Contribute](/docs/WorkingLocally.md) |
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
 | blur             |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
126
 | blur             |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
126
 | hideWithTopBar          |   ✅     |     [Contribute](/docs/WorkingLocally.md)       | @gtchance|
127
 | hideWithTopBar          |   ✅     |     [Contribute](/docs/WorkingLocally.md)       | @gtchance|
127
 | hidden         |    ✅       |     [Contribute](/docs/WorkingLocally.md)      | WIX |
128
 | hidden         |    ✅       |     [Contribute](/docs/WorkingLocally.md)      | WIX |
128
 
129
 
129
-|       other        | iOS  | Android | contributors|
130
-|--------------------|-----|----|-----|
130
+|       other        | iOS  | Android |
131
+|--------------------|-----|----|-----
131
 | screenBackgroundColor        |   ✅     |     [Contribute](/docs/WorkingLocally.md)       |  Wix|
132
 | screenBackgroundColor        |   ✅     |     [Contribute](/docs/WorkingLocally.md)       |  Wix|
132
-| orientation       |    ✅     |   [Contribute](/docs/WorkingLocally.md)          | Wix|
133
+| orientation       |    ✅     || Wix|
133
 | disabledBackGesture        |    ✅     |    / iOS specific     |
134
 | disabledBackGesture        |    ✅     |    / iOS specific     |
134
 | screenBackgroundImageName        |   ✅      |    [Contribute](/docs/WorkingLocally.md)        |
135
 | screenBackgroundImageName        |   ✅      |    [Contribute](/docs/WorkingLocally.md)        |
135
 | rootBackgroundImageName              |    ✅     |    [Contribute](/docs/WorkingLocally.md)       |
136
 | rootBackgroundImageName              |    ✅     |    [Contribute](/docs/WorkingLocally.md)       |
136
-| sideMenuVisible          |      ✅   | [Contribute](/docs/WorkingLocally.md) |
137
+| sideMenuVisible          |      ✅   ||
137
 
138
 
138
 
139
 
139
 ## v1 vs v2 Feature Comparison
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
 Here is the full comparison of features between v1 and v2 (will be updated regularly):
141
 Here is the full comparison of features between v1 and v2 (will be updated regularly):
142
 ### Top Level API
142
 ### Top Level API
143
 
143
 
150
 ### Screen API
150
 ### Screen API
151
 
151
 
152
 |  API              | v1     | v2  iOS      |	v2 Android |
152
 |  API              | v1     | v2  iOS      |	v2 Android |
153
-|---------------------|--------|------------|--------------|
153
+|---------------------|:--------:|:------------:|:--------------:|
154
 | push                |  ✅     |   ✅       |	✅		|
154
 | push                |  ✅     |   ✅       |	✅		|
155
 | pop                 |  ✅     |  ✅        |	✅	|
155
 | pop                 |  ✅     |  ✅        |	✅	|
156
 | showModal           |  ✅     |  ✅        |	✅|
156
 | showModal           |  ✅     |  ✅        |	✅|
160
 | dismissAllModals    |   ✅     |      ✅      |	✅|
160
 | dismissAllModals    |   ✅     |      ✅      |	✅|
161
 | showContextualMenu      |   ✅     |     / Android specific       |[Contribute](/docs/WorkingLocally.md) |
161
 | showContextualMenu      |   ✅     |     / Android specific       |[Contribute](/docs/WorkingLocally.md) |
162
 | dismissContextualMenu      |   ✅     |   / Androic specific        |[Contribute](/docs/WorkingLocally.md)  |
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
 | showSnackBar     |   ✅     |     / Android specific    |   [Contribute](/docs/WorkingLocally.md) |
165
 | showSnackBar     |   ✅     |     / Android specific    |   [Contribute](/docs/WorkingLocally.md) |
166
 | dismissSnackBar     |   ✅     |    / Android specific      |  [Contribute](/docs/WorkingLocally.md) |
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
 | handleDeepLink      |   ✅     |       [Contribute](/docs/WorkingLocally.md)       | [Contribute](/docs/WorkingLocally.md) |
171
 | handleDeepLink      |   ✅     |       [Contribute](/docs/WorkingLocally.md)       | [Contribute](/docs/WorkingLocally.md) |
170
 | Screen Visibility   |   ✅     |       ✅     |✅|
172
 | Screen Visibility   |   ✅     |       ✅     |✅|
171
 
173
 
173
 
175
 
174
 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.
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
 | topBarTextColor |   ✅    |    ✅     |     ✅        | Wix|
180
 | topBarTextColor |   ✅    |    ✅     |     ✅        | Wix|
179
 | topBarTextFontSize    |   ✅    |    ✅      |     ✅        | Wix|
181
 | topBarTextFontSize    |   ✅    |    ✅      |     ✅        | Wix|
180
 | topBarTextFontFamily  |  ✅     |      ✅     |     ✅        | Wix |
182
 | topBarTextFontFamily  |  ✅     |      ✅     |     ✅        | Wix |
181
 | topBarBackgroundColor |  ✅     |  ✅       |     ✅         | Wix|
183
 | topBarBackgroundColor |  ✅     |  ✅       |     ✅         | Wix|
182
-| topBarButtonColor     |  ✅     |    ✅      |     [Contribute](/docs/WorkingLocally.md)        | Wix|
184
+| topBarButtonColor     |  ✅     |    ✅      || Wix|
183
 | topBarHidden          |   ✅    |   ✅      |     ✅        | Wix|
185
 | topBarHidden          |   ✅    |   ✅      |     ✅        | Wix|
184
-| topBarHideOnScroll    |  ✅     |  ✅    |     [Contribute](/docs/WorkingLocally.md)        | Wix|
186
+| topBarHideOnScroll    |  ✅     |  ✅    || Wix|
185
 | topBarTranslucent     |  ✅     |   ✅     |     [Contribute](/docs/WorkingLocally.md)        | Wix|
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
 | topBarNoBorder        |  ✅     |    ✅     |     [Contribute](/docs/WorkingLocally.md)        |  @gtchance|
189
 | topBarNoBorder        |  ✅     |    ✅     |     [Contribute](/docs/WorkingLocally.md)        |  @gtchance|
188
-| drawUnderTabBar       |  ✅     |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | |
189
-| drawUnderTopBar       |  ✅     |    ✅     |      [Contribute](/docs/WorkingLocally.md)       ||
190
+| drawUnderTabBar       |  ✅     |    ✅     || |
191
+| drawUnderTopBar       |  ✅     |    ✅     |||
190
 | statusBarBlur         |  ✅     |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
192
 | statusBarBlur         |  ✅     |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
191
 | topBarBlur            | ✅      |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
193
 | topBarBlur            | ✅      |    ✅     |      [Contribute](/docs/WorkingLocally.md)       | @gtchance|
192
-| tabBarHidden  |   ✅  |   ✅     |    [Contribute](/docs/WorkingLocally.md)        | @gtchance|
194
+| tabBarHidden  |   ✅  |   ✅     || @gtchance|
193
 | statusBarTextColorScheme |  ✅   |   in development      |      / iOS specific    |
195
 | statusBarTextColorScheme |  ✅   |   in development      |      / iOS specific    |
194
 | statusBarTextColorSchemeSingleScreen|  ✅   |     in development    |     / iOS specific      |
196
 | statusBarTextColorSchemeSingleScreen|  ✅   |     in development    |     / iOS specific      |
195
 | topBarSubtitleColor          |  ✅   |   [Contribute](/docs/WorkingLocally.md)     |      [Contribute](/docs/WorkingLocally.md)      |
197
 | topBarSubtitleColor          |  ✅   |   [Contribute](/docs/WorkingLocally.md)     |      [Contribute](/docs/WorkingLocally.md)      |
196
 | topBarSubtitleFontFamily    |   ✅  |    [Contribute](/docs/WorkingLocally.md)    |     [Contribute](/docs/WorkingLocally.md)       |
198
 | topBarSubtitleFontFamily    |   ✅  |    [Contribute](/docs/WorkingLocally.md)    |     [Contribute](/docs/WorkingLocally.md)       |
197
 | screenBackgroundColor     | ✅    |   ✅     |     [Contribute](/docs/WorkingLocally.md)       |  Wix|
199
 | screenBackgroundColor     | ✅    |   ✅     |     [Contribute](/docs/WorkingLocally.md)       |  Wix|
198
-| orientation     |  ✅   |    ✅     |   [Contribute](/docs/WorkingLocally.md)          | Wix|
200
+| orientation     |  ✅   |    ✅     || Wix|
199
 | statusBarHideWithTopBar        |  ✅   |   ✅     |     [Contribute](/docs/WorkingLocally.md)       | @gtchance|
201
 | statusBarHideWithTopBar        |  ✅   |   ✅     |     [Contribute](/docs/WorkingLocally.md)       | @gtchance|
200
 | statusBarHidden       |  ✅   |    ✅       |     [Contribute](/docs/WorkingLocally.md)      | WIX |
202
 | statusBarHidden       |  ✅   |    ✅       |     [Contribute](/docs/WorkingLocally.md)      | WIX |
201
 | disabledBackGesture       |   ✅  |   ✅  |    / iOS specific     |
203
 | disabledBackGesture       |   ✅  |   ✅  |    / iOS specific     |
202
 | screenBackgroundImageName         |   ✅  |   ✅      |    [Contribute](/docs/WorkingLocally.md)        |
204
 | screenBackgroundImageName         |   ✅  |   ✅      |    [Contribute](/docs/WorkingLocally.md)        |
203
 | rootBackgroundImageName            |  ✅   |    ✅     |    [Contribute](/docs/WorkingLocally.md)       |
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
 | splitViewScreen       |     :x:  |    [Contribute](/docs/WorkingLocally.md)      | [Contribute](/docs/WorkingLocally.md)|
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)