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

V2 docs location (#1828) 

* Added v2 docs

* Move docs around

* Update _sidebar.md

* Update README.md

* Delete

* Remove usage docs (it was duplicated)
Johan 6 years ago
parent
1151017193
commit
b66ce891e0
9 changed files with 42 additions and 43 deletions
Split View Show Diff Stats
  1. 42
    43
      README.md
  2. 0
    0
      docs/docs/CONTRIBUTING.md
  3. 0
    0
      docs/docs/INSTALLING.md
  4. 0
    0
      docs/docs/README.md
  5. 0
    0
      docs/docs/UPDATING.md
  6. 0
    0
      docs/docs/installation-android.md
  7. 0
    0
      docs/docs/installation-ios.md
  8. 0
    0
      docs/docs/usage.md
  9. 0
    0
      docs/docs/v1tov2diff.md

+ 42
- 43
README.md View File 

@@ -7,7 +7,7 @@ We are rebuilding react-native-navigation
7 7 
 - [Why?](#why-rebuild-react-native-navigation)
8 8 
 - [Where is it standing now?](#current-status)
9 9 
 - [Documentation](https://wix.github.io/react-native-navigation/v2/)
10 
-- [Contributing](CONTRIBUTING.md)
10 
+- [Contributing](/docs/docs/CONTRIBUTING.md)
11 11
12 12 
 ## Why Rebuild react-native-navigation?
13 13 
 
@@ -53,15 +53,15 @@ Here is the full comparison of features between v1 and v2 (will be updated regul
53 53 
 | resetTo             |   ✅     |    ✅        |	✅|
54 54 
 | dismissModal        |   ✅     |     ✅       |	✅|
55 55 
 | dismissAllModals    |   ✅     |      ✅      |	✅|
56 
-| showContextualMenu      |   ✅     |     / Android specific       |[Contribute](CONTRIBUTING.md) |
57 
-| dismissContextualMenu      |   ✅     |   / Androic specific        |[Contribute](CONTRIBUTING.md)  |
58 
-| showFab      |   ✅     |    / Android specific     |  [Contribute](CONTRIBUTING.md)  |
59 
-| dismissFab      |   ✅     |    / Android specific       | [Contribute](CONTRIBUTING.md) |
60 
-| showSnackBar     |   ✅     |     / Android specific    |   [Contribute](CONTRIBUTING.md) |
61 
-| dismissSnackBar     |   ✅     |    / Android specific      |  [Contribute](CONTRIBUTING.md) |
62 
-| showLightBox        |   ✅     |      [Contribute](CONTRIBUTING.md)      | [Contribute](CONTRIBUTING.md)  |
63 
-| dismissLightBox     |   ✅     |       [Contribute](CONTRIBUTING.md)       | [Contribute](CONTRIBUTING.md) |
64 
-| handleDeepLink      |   ✅     |       [Contribute](CONTRIBUTING.md)       | [Contribute](CONTRIBUTING.md) |
56 
+| showContextualMenu      |   ✅     |     / Android specific       |[Contribute](/docs/docs/CONTRIBUTING.md) |
57 
+| dismissContextualMenu      |   ✅     |   / Androic specific        |[Contribute](/docs/docs/CONTRIBUTING.md)  |
58 
+| showFab      |   ✅     |    / Android specific     |  [Contribute](/docs/docs/CONTRIBUTING.md)  |
59 
+| dismissFab      |   ✅     |    / Android specific       | [Contribute](/docs/docs/CONTRIBUTING.md) |
60 
+| showSnackBar     |   ✅     |     / Android specific    |   [Contribute](/docs/docs/CONTRIBUTING.md) |
61 
+| dismissSnackBar     |   ✅     |    / Android specific      |  [Contribute](/docs/docs/CONTRIBUTING.md) |
62 
+| showLightBox        |   ✅     |      [Contribute](/docs/docs/CONTRIBUTING.md)      | [Contribute](/docs/docs/CONTRIBUTING.md)  |
63 
+| dismissLightBox     |   ✅     |       [Contribute](/docs/docs/CONTRIBUTING.md)       | [Contribute](/docs/docs/CONTRIBUTING.md) |
64 
+| handleDeepLink      |   ✅     |       [Contribute](/docs/docs/CONTRIBUTING.md)       | [Contribute](/docs/docs/CONTRIBUTING.md) |
65 65 
 | Screen Visibility   |   ✅     |       ✅     |✅|
66 66
67 67 
 ### Styles
 
@@ -70,42 +70,41 @@ Note:  v1 properties with names beginning with 'navBar' are replaced in v2 with
70 70
71 71 
 |                       | v1  | v2 iOS | v2 Android | Contributors |
72 72 
 |-----------------------|-----|--------|------------|------------|
73 
-| topBarTextColor |   ✅    |    ✅     |     [Contribute](CONTRIBUTING.md)        | Wix|
74 
-| topBarTextFontSize    |   ✅    |    ✅      |     [Contribute](CONTRIBUTING.md)        | Wix|
75 
-| topBarTextFontFamily  |  ✅     |      ✅     |     [Contribute](CONTRIBUTING.md)        | Wix |
73 
+| topBarTextColor |   ✅    |    ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)        | Wix|
74 
+| topBarTextFontSize    |   ✅    |    ✅      |     [Contribute](/docs/docs/CONTRIBUTING.md)        | Wix|
75 
+| topBarTextFontFamily  |  ✅     |      ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)        | Wix |
76 76 
 | topBarBackgroundColor |  ✅     |  ✅       |     ✅         | Wix|
77 
-| topBarButtonColor     |  ✅     |    ✅      |     [Contribute](CONTRIBUTING.md)        | Wix|
78 
-| topBarHidden          |   ✅    |   ✅      |     [Contribute](CONTRIBUTING.md)        | Wix|
79 
-| topBarHideOnScroll    |  ✅     |  ✅    |     [Contribute](CONTRIBUTING.md)        | Wix|
80 
-| topBarTranslucent     |  ✅     |   ✅     |     [Contribute](CONTRIBUTING.md)        | Wix|
81 
-| topBarTransparent     | ✅      |   WIP @bogobogo     |     [Contribute](CONTRIBUTING.md)        |
82 
-| topBarNoBorder        |  ✅     |    ✅     |     [Contribute](CONTRIBUTING.md)        |  @gtchance|
83 
-| drawUnderTabBar       |  ✅     |    WIP @gran33     |      [Contribute](CONTRIBUTING.md)       | |
84 
-| drawUnderTopBar       |  ✅     |    WIP @gran33     |      [Contribute](CONTRIBUTING.md)       ||
85 
-| statusBarBlur         |  ✅     |    ✅     |      [Contribute](CONTRIBUTING.md)       | @gtchance|
86 
-| topBarBlur            | ✅      |    ✅     |      [Contribute](CONTRIBUTING.md)       | @gtchance|
87 
-| tabBarHidden  |   ✅  |   ✅     |    [Contribute](CONTRIBUTING.md)        | @gtchance|
77 
+| topBarButtonColor     |  ✅     |    ✅      |     [Contribute](/docs/docs/CONTRIBUTING.md)        | Wix|
78 
+| topBarHidden          |   ✅    |   ✅      |     [Contribute](/docs/docs/CONTRIBUTING.md)        | Wix|
79 
+| topBarHideOnScroll    |  ✅     |  ✅    |     [Contribute](/docs/docs/CONTRIBUTING.md)        | Wix|
80 
+| topBarTranslucent     |  ✅     |   ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)        | Wix|
81 
+| topBarTransparent     | ✅      |   WIP @bogobogo     |     [Contribute](/docs/docs/CONTRIBUTING.md)        |
82 
+| topBarNoBorder        |  ✅     |    ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)        |  @gtchance|
83 
+| drawUnderTabBar       |  ✅     |    WIP @gran33     |      [Contribute](/docs/docs/CONTRIBUTING.md)       | |
84 
+| drawUnderTopBar       |  ✅     |    WIP @gran33     |      [Contribute](/docs/docs/CONTRIBUTING.md)       ||
85 
+| statusBarBlur         |  ✅     |    ✅     |      [Contribute](/docs/docs/CONTRIBUTING.md)       | @gtchance|
86 
+| topBarBlur            | ✅      |    ✅     |      [Contribute](/docs/docs/CONTRIBUTING.md)       | @gtchance|
87 
+| tabBarHidden  |   ✅  |   ✅     |    [Contribute](/docs/docs/CONTRIBUTING.md)        | @gtchance|
88 88 
 | statusBarTextColorScheme |  ✅   |   in development      |      / iOS specific    |
89 89 
 | statusBarTextColorSchemeSingleScreen|  ✅   |     in development    |     / iOS specific      |
90 
-| navBarSubtitleColor          |  ✅   |   [Contribute](CONTRIBUTING.md)     |      [Contribute](CONTRIBUTING.md)      |
91 
-| navBarSubtitleFontFamily    |   ✅  |    [Contribute](CONTRIBUTING.md)    |     [Contribute](CONTRIBUTING.md)       |
92 
-| screenBackgroundColor     | ✅    |   ✅     |     [Contribute](CONTRIBUTING.md)       |  Wix|
93 
-| orientation     |  ✅   |    ✅     |   [Contribute](CONTRIBUTING.md)          | Wix|
94 
-| statusBarHideWithTopBar        |  ✅   |   ✅     |     [Contribute](CONTRIBUTING.md)       | @gtchance|
95 
-| statusBarHidden       |  ✅   |    ✅       |     [Contribute](CONTRIBUTING.md)      | WIX |
90 
+| navBarSubtitleColor          |  ✅   |   [Contribute](/docs/docs/CONTRIBUTING.md)     |      [Contribute](/docs/docs/CONTRIBUTING.md)      |
91 
+| navBarSubtitleFontFamily    |   ✅  |    [Contribute](/docs/docs/CONTRIBUTING.md)    |     [Contribute](/docs/docs/CONTRIBUTING.md)       |
92 
+| screenBackgroundColor     | ✅    |   ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)       |  Wix|
93 
+| orientation     |  ✅   |    ✅     |   [Contribute](/docs/docs/CONTRIBUTING.md)          | Wix|
94 
+| statusBarHideWithTopBar        |  ✅   |   ✅     |     [Contribute](/docs/docs/CONTRIBUTING.md)       | @gtchance|
95 
+| statusBarHidden       |  ✅   |    ✅       |     [Contribute](/docs/docs/CONTRIBUTING.md)      | WIX |
96 96 
 | disabledBackGesture       |   ✅  |  WIP @gran33     |    / iOS specific     |
97 
-| screenBackgroundImageName         |   ✅  |   [Contribute](CONTRIBUTING.md)      |    [Contribute](CONTRIBUTING.md)        |
98 
-| rootBackgroundImageName            |  ✅   |    [Contribute](CONTRIBUTING.md)     |    [Contribute](CONTRIBUTING.md)       |
99 
-| setButtons          |   ✅     |    ✅    | [Contribute](CONTRIBUTING.md) | @Johan-dutoit|
97 
+| screenBackgroundImageName         |   ✅  |   [Contribute](/docs/docs/CONTRIBUTING.md)      |    [Contribute](/docs/docs/CONTRIBUTING.md)        |
98 
+| rootBackgroundImageName            |  ✅   |    [Contribute](/docs/docs/CONTRIBUTING.md)     |    [Contribute](/docs/docs/CONTRIBUTING.md)       |
99 
+| setButtons          |   ✅     |    ✅    | [Contribute](/docs/docs/CONTRIBUTING.md) | @Johan-dutoit|
100 100 
 | title            |   ✅     |        	✅    | 	✅| Wix|
101 
-| toggleDrawer        |   ✅     |        [Contribute](CONTRIBUTING.md)   | [Contribute](CONTRIBUTING.md) |
101 
+| toggleDrawer        |   ✅     |        [Contribute](/docs/docs/CONTRIBUTING.md)   | [Contribute](/docs/docs/CONTRIBUTING.md) |
102 102 
 | toggleTabs          |   ✅     |       in development    | in development|
103 
-| setTabBadge         |    ✅    |       ✅    | [Contribute](CONTRIBUTING.md)| Wix|
104 
-| switchToTab         |    ✅    |      in development    |[Contribute](CONTRIBUTING.md) |
105 
-| toggleNavBar        |   ✅     |      WIP @gran33     | [Contribute](CONTRIBUTING.md)|
106 
-| navBarCustomView        |   ✅     |     WIP @gran33     | [Contribute](CONTRIBUTING.md)|
107 
-| customTransition(shared element)       |     :x:  |     WIP @bogobogo     | [Contribute](CONTRIBUTING.md)|
108 
-| splitViewScreen       |     :x:  |    [Contribute](CONTRIBUTING.md)      | [Contribute](CONTRIBUTING.md)|
109 
-
110 
-
111 
-Element tranisitions, adding buttons and styles are not yet implemented. [Contribute](CONTRIBUTING.md)
103 
+| setTabBadge         |    ✅    |       ✅    | [Contribute](/docs/docs/CONTRIBUTING.md)| Wix|
104 
+| switchToTab         |    ✅    |      in development    |[Contribute](/docs/docs/CONTRIBUTING.md) |
105 
+| toggleNavBar        |   ✅     |      WIP @gran33     | [Contribute](/docs/docs/CONTRIBUTING.md)|
106 
+| navBarCustomView        |   ✅     |     WIP @gran33     | [Contribute](/docs/docs/CONTRIBUTING.md)|
107 
+| customTransition(shared element)       |     :x:  |     WIP @bogobogo     | [Contribute](/docs/docs/CONTRIBUTING.md)|
108 
+| splitViewScreen       |     :x:  |    [Contribute](/docs/docs/CONTRIBUTING.md)      | [Contribute](/docs/docs/CONTRIBUTING.md)|
109 
+
110 
+Element tranisitions, adding buttons and styles are not yet implemented. [Contribute](/docs/docs/CONTRIBUTING.md)

CONTRIBUTING.md → docs/docs/CONTRIBUTING.md View File


INSTALLING.md → docs/docs/INSTALLING.md View File


docs/README.md → docs/docs/README.md View File


UPDATING.md → docs/docs/UPDATING.md View File


docs/installation-android.md → docs/docs/installation-android.md View File


docs/installation-ios.md → docs/docs/installation-ios.md View File


docs/usage.md → docs/docs/usage.md View File


v1tov2diff.md → docs/docs/v1tov2diff.md View File