Browse Source

Documentation fixes (#6108)

* Update installing doc

* Rename style articles

* add docs prefix to getting started articles

* Rename all the things. Consistent id format

* Split docs and api

* Fix links

Co-authored-by: Guy Carmeli <guyc@wix.com>
Yogev Ben David 4 years ago
parent
commit
fe675b3ea1
No account linked to committer's email address
62 changed files with 195 additions and 185 deletions
  1. 1
    1
      website/api/api-component.mdx
  2. 1
    1
      website/api/api-events.mdx
  3. 2
    2
      website/api/api-modal.mdx
  4. 0
    0
      website/api/api-options.mdx
  5. 2
    2
      website/api/api-overlay.mdx
  6. 3
    3
      website/api/api-root.mdx
  7. 0
    0
      website/api/api-sideMenu.mdx
  8. 2
    2
      website/api/api-stack.mdx
  9. 2
    2
      website/api/layout-BottomTabs.mdx
  10. 1
    1
      website/api/layout-component.mdx
  11. 2
    2
      website/api/layout-layout.mdx
  12. 4
    4
      website/api/layout-sideMenu.mdx
  13. 3
    3
      website/api/layout-splitView.mdx
  14. 2
    2
      website/api/layout-stack.mdx
  15. 5
    0
      website/api/options-animations.mdx
  16. 1
    1
      website/api/options-backButton.mdx
  17. 1
    1
      website/api/options-background.mdx
  18. 1
    1
      website/api/options-bottomTab.mdx
  19. 1
    1
      website/api/options-bottomTabs.mdx
  20. 1
    1
      website/api/options-button.mdx
  21. 5
    0
      website/api/options-fab.mdx
  22. 1
    1
      website/api/options-iconInsets.mdx
  23. 1
    1
      website/api/options-largeTitle.mdx
  24. 1
    1
      website/api/options-layout.mdx
  25. 0
    0
      website/api/options-migration.mdx
  26. 1
    1
      website/api/options-overlay.mdx
  27. 5
    0
      website/api/options-preview.mdx
  28. 5
    5
      website/api/options-root.mdx
  29. 1
    1
      website/api/options-sideMenu.mdx
  30. 1
    1
      website/api/options-sideMenuSide.mdx
  31. 1
    1
      website/api/options-splitView.mdx
  32. 3
    3
      website/api/options-stack.mdx
  33. 1
    1
      website/api/options-statusBar.mdx
  34. 1
    1
      website/api/options-subtitle.mdx
  35. 1
    1
      website/api/options-title.mdx
  36. 5
    29
      website/docs/docs-Installing.mdx
  37. 1
    1
      website/docs/docs-advanced-navigation.mdx
  38. 0
    0
      website/docs/docs-app-launch.mdx
  39. 1
    1
      website/docs/docs-basic-navigation.mdx
  40. 1
    1
      website/docs/docs-before-you-start.mdx
  41. 1
    1
      website/docs/docs-bottomTabs.mdx
  42. 1
    1
      website/docs/docs-externalComponent.mdx
  43. 1
    1
      website/docs/docs-modal.mdx
  44. 1
    1
      website/docs/docs-overlay.mdx
  45. 3
    3
      website/docs/docs-passing-data-to-components.mdx
  46. 1
    1
      website/docs/docs-playground-app.mdx
  47. 1
    1
      website/docs/docs-root.mdx
  48. 0
    0
      website/docs/docs-screen-lifecycle.mdx
  49. 0
    0
      website/docs/docs-showcases.mdx
  50. 1
    1
      website/docs/docs-sideMenu.mdx
  51. 1
    1
      website/docs/docs-stack.mdx
  52. 1
    1
      website/docs/style-animations.mdx
  53. 1
    1
      website/docs/style-constants.mdx
  54. 1
    1
      website/docs/style-fonts.mdx
  55. 1
    1
      website/docs/style-orientation.mdx
  56. 1
    1
      website/docs/style-statusbar.mdx
  57. 1
    1
      website/docs/style-theme.mdx
  58. 23
    6
      website/docusaurus.config.js
  59. 2
    2
      website/package.json
  60. 23
    79
      website/sidebars.js
  61. 58
    0
      website/sidebarsApi.js
  62. 1
    1
      website/src/pages/index.js

website/docs/api-component.mdx → website/api/api-component.mdx View File

1
 ---
1
 ---
2
-id: component-api
2
+id: component
3
 title: Component
3
 title: Component
4
 sidebar_label: Component
4
 sidebar_label: Component
5
 ---
5
 ---

website/docs/api-events.mdx → website/api/api-events.mdx View File

1
 ---
1
 ---
2
-id: events-api
2
+id: events
3
 title: Events
3
 title: Events
4
 sidebar_label: Events
4
 sidebar_label: Events
5
 ---
5
 ---

website/docs/api-modal.mdx → website/api/api-modal.mdx View File

1
 ---
1
 ---
2
-id: modal-api
2
+id: modal
3
 title: Modal
3
 title: Modal
4
 sidebar_label: Modal
4
 sidebar_label: Modal
5
 ---
5
 ---
9
 #### Parameters
9
 #### Parameters
10
 | Name   | Required | Type                | Description                                                                                                            |
10
 | Name   | Required | Type                | Description                                                                                                            |
11
 | ------ | -------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------- |
11
 | ------ | -------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------- |
12
-| layout | Yes      | [Layout](Layout.mdx) | Any type of layout. [BottomTabs](layout-BottomTabs.mdx), [Stack](stack-layout.mdx), [SideMenu](sideMenu-layout.mdx), [Component](layout-component.mdx) |
12
+| layout | Yes      | [Layout](layout-layout.mdx) | Any type of layout. [BottomTabs](layout-BottomTabs.mdx), [Stack](layout-stack.mdx), [SideMenu](layout-sideMenu.mdx), [Component](layout-component.mdx) |
13
 
13
 
14
 ```js
14
 ```js
15
 Navigation.showModal({
15
 Navigation.showModal({

website/docs/api-options.mdx → website/api/api-options.mdx View File


website/docs/api-overlay.mdx → website/api/api-overlay.mdx View File

1
 ---
1
 ---
2
-id: overlay-api
2
+id: overlay
3
 title: Overlay
3
 title: Overlay
4
 sidebar_label: Overlay
4
 sidebar_label: Overlay
5
 ---
5
 ---
9
 
9
 
10
 | Name   | Required | Type                | Description                                                                                                                                                                                                         |
10
 | Name   | Required | Type                | Description                                                                                                                                                                                                         |
11
 | ------ | -------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
 | ------ | -------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
12
-| layout | Yes      | [Layout](Layout.mdx) | Any type of layout. Typically, Component layout is used in Overlays but it's possible to load any other layout ([BottomTabs](layout-BottomTabs.mdx), [Stack](stack-layout.mdx), [SideMenu](sideMenu-layout.mdx), [Component](layout-component.mdx)) |
12
+| layout | Yes      | [Layout](layout-layout.mdx) | Any type of layout. Typically, Component layout is used in Overlays but it's possible to load any other layout ([BottomTabs](layout-BottomTabs.mdx), [Stack](layout-stack.mdx), [SideMenu](layout-sideMenu.mdx), [Component](layout-component.mdx)) |
13
 
13
 
14
 ```js
14
 ```js
15
 Navigation.showOverlay({
15
 Navigation.showOverlay({

website/docs/api-root.mdx → website/api/api-root.mdx View File

1
 ---
1
 ---
2
-id: root-api
2
+id: root
3
 title: Root
3
 title: Root
4
 sidebar_label: Root
4
 sidebar_label: Root
5
 ---
5
 ---
8
 import TabItem from '@theme/TabItem';
8
 import TabItem from '@theme/TabItem';
9
 
9
 
10
 ## `setRoot()`
10
 ## `setRoot()`
11
-Used to set the UI of the application. Read more about the root hierarchy level in the [docs section](docs-root.mdx).
11
+Used to set the UI of the application. Read more about the root hierarchy level in the [docs section](../docs/root).
12
 
12
 
13
 #### Parameters
13
 #### Parameters
14
 | Name   | Required | Type                | Description                                                                                                            |
14
 | Name   | Required | Type                | Description                                                                                                            |
15
 | ------ | -------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------- |
15
 | ------ | -------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------- |
16
-| layout | Yes      | [Layout](Layout.mdx) | Any type of layout. [BottomTabs](layout-BottomTabs.mdx), [Stack](stack-layout.mdx), [SideMenu](sideMenu-layout.mdx), [Component](layout-component.mdx) |
16
+| layout | Yes      | [Layout](layout-layout.mdx) | Any type of layout. [BottomTabs](layout-BottomTabs.mdx), [Stack](layout-stack.mdx), [SideMenu](layout-sideMenu.mdx), [Component](layout-component.mdx) |
17
 
17
 
18
 #### Example
18
 #### Example
19
 
19
 

website/docs/api-sideMenu.mdx → website/api/api-sideMenu.mdx View File


website/docs/stack-api.mdx → website/api/api-stack.mdx View File

1
 ---
1
 ---
2
-id: stack-api
2
+id: stack
3
 title: Stack
3
 title: Stack
4
 sidebar_label: Stack
4
 sidebar_label: Stack
5
 ---
5
 ---
128
 | Name        | Required | Type                                                     | Description                                                           |
128
 | Name        | Required | Type                                                     | Description                                                           |
129
 | ----------- | -------- | -------------------------------------------------------- | --------------------------------------------------------------------- |
129
 | ----------- | -------- | -------------------------------------------------------- | --------------------------------------------------------------------- |
130
 | componentId | Yes      | string                                                   | The componentId of a screen pushed into the stack, or the stack id. |
130
 | componentId | Yes      | string                                                   | The componentId of a screen pushed into the stack, or the stack id. |
131
-| layout      | Yes      | [layout](Layout.mdx) or [layout](Layout.mdx)[] | A single Component or array of components.                            |
131
+| layout      | Yes      | [layout](layout-layout.mdx) or [layout](layout-layout.mdx)[] | A single Component or array of components.                            |
132
 
132
 
133
 
133
 
134
 #### Example
134
 #### Example

website/docs/layout-BottomTabs.mdx → website/api/layout-BottomTabs.mdx View File

1
 ---
1
 ---
2
-id: bottomTabs-layout
2
+id: layout-bottomTabs
3
 title: Bottom Tabs
3
 title: Bottom Tabs
4
 sidebar_label: Bottom Tabs
4
 sidebar_label: Bottom Tabs
5
 ---
5
 ---
41
 
41
 
42
 | Type               | Required | Description                   |
42
 | Type               | Required | Description                   |
43
 | ------------------ | -------- | ----------------------------- |
43
 | ------------------ | -------- | ----------------------------- |
44
-| [Layout[]](Layout.mdx) | YES      | Child layouts of any kind. |
44
+| [Layout[]](layout-layout.mdx) | YES      | Child layouts of any kind. |
45
 
45
 
46
 ## `options`
46
 ## `options`
47
 
47
 

website/docs/layout-component.mdx → website/api/layout-component.mdx View File

1
 ---
1
 ---
2
-id: component-layout
2
+id: layout-component
3
 title: Component
3
 title: Component
4
 sidebar_label: Component
4
 sidebar_label: Component
5
 ---
5
 ---

website/docs/Layout.mdx → website/api/layout-layout.mdx View File

1
 ---
1
 ---
2
-id: layout
2
+id: layout-layout
3
 title: Layout
3
 title: Layout
4
 sidebar_label: Layout
4
 sidebar_label: Layout
5
 ---
5
 ---
20
 
20
 
21
 | Type               | Required | Description                   |
21
 | Type               | Required | Description                   |
22
 | ------------------ | -------- | ----------------------------- |
22
 | ------------------ | -------- | ----------------------------- |
23
-| [Layout[]](Layout.mdx) | YES      | Child layouts of any kind. |
23
+| [Layout[]](layout-layout.mdx) | YES      | Child layouts of any kind. |

website/docs/sideMenu-layout.mdx → website/api/layout-sideMenu.mdx View File

1
 ---
1
 ---
2
-id: sideMenu-layout
2
+id: layout-sideMenu
3
 title: Side Menu
3
 title: Side Menu
4
 sidebar_label: Side Menu
4
 sidebar_label: Side Menu
5
 ---
5
 ---
29
 
29
 
30
 | Type             | Required | Description                                      |
30
 | Type             | Required | Description                                      |
31
 | ---------------- | -------- | ------------------------------------------------ |
31
 | ---------------- | -------- | ------------------------------------------------ |
32
-| [Layout](Layout.mdx) | Yes      | Center component, contains the main application. |
32
+| [Layout](layout-layout.mdx) | Yes      | Center component, contains the main application. |
33
 
33
 
34
 ## `left`
34
 ## `left`
35
 
35
 
36
 | Type             | Required | Description                        |
36
 | Type             | Required | Description                        |
37
 | ---------------- | -------- | ---------------------------------- |
37
 | ---------------- | -------- | ---------------------------------- |
38
-| [Layout](Layout.mdx) | No       | Contains the left component layout. |
38
+| [Layout](layout-layout.mdx) | No       | Contains the left component layout. |
39
 
39
 
40
 ## `right`
40
 ## `right`
41
 
41
 
42
 | Type             | Required | Description                         |
42
 | Type             | Required | Description                         |
43
 | ---------------- | -------- | ----------------------------------- |
43
 | ---------------- | -------- | ----------------------------------- |
44
-| [Layout](Layout.mdx) | No       | Contains the right component layout. |
44
+| [Layout](layout-layout.mdx) | No       | Contains the right component layout. |

website/docs/SplitView.mdx → website/api/layout-splitView.mdx View File

1
 ---
1
 ---
2
-id: splitView
2
+id: layout-splitView
3
 title: SplitView
3
 title: SplitView
4
 sidebar_label: SplitView
4
 sidebar_label: SplitView
5
 ---
5
 ---
35
 
35
 
36
 | Type               | Required | Description                                     |
36
 | Type               | Required | Description                                     |
37
 | ------------------ | -------- | ----------------------------------------------- |
37
 | ------------------ | -------- | ----------------------------------------------- |
38
-| [Layout](Layout.mdx) | YES      | Set master layout (the smaller screen, sidebar) |
38
+| [Layout](layout-layout.mdx) | YES      | Set master layout (the smaller screen, sidebar) |
39
 
39
 
40
 ## `detail`
40
 ## `detail`
41
 
41
 
42
 | Type               | Required | Description                                   |
42
 | Type               | Required | Description                                   |
43
 | ------------------ | -------- | --------------------------------------------- |
43
 | ------------------ | -------- | --------------------------------------------- |
44
-| [Layout](Layout.mdx) | YES      | Set detail layout (the larger screen, flexes) |
44
+| [Layout](layout-layout.mdx) | YES      | Set detail layout (the larger screen, flexes) |
45
 
45
 
46
 ## `options`
46
 ## `options`
47
 
47
 

website/docs/stack-layout.mdx → website/api/layout-stack.mdx View File

1
 ---
1
 ---
2
-id: stack-layout
2
+id: layout-stack
3
 title: Stack
3
 title: Stack
4
 sidebar_label: Stack
4
 sidebar_label: Stack
5
 ---
5
 ---
30
 
30
 
31
 | Type               | Required | Description                   |
31
 | Type               | Required | Description                   |
32
 | ------------------ | -------- | ----------------------------- |
32
 | ------------------ | -------- | ----------------------------- |
33
-| [Layout[]](Layout.mdx) | YES      | Child layouts of any kind. |
33
+| [Layout[]](layout-layout.mdx) | YES      | Child layouts of any kind. |
34
 
34
 
35
 ## `options`
35
 ## `options`
36
 
36
 

+ 5
- 0
website/api/options-animations.mdx View File

1
+---
2
+id: options-animations
3
+title: Animations
4
+sidebar_label: Animations
5
+---

website/docs/options-backButton.mdx → website/api/options-backButton.mdx View File

1
 ---
1
 ---
2
-id: backButton-options
2
+id: options-backButton
3
 title: Back Button Options
3
 title: Back Button Options
4
 sidebar_label: Back Button
4
 sidebar_label: Back Button
5
 ---
5
 ---

website/docs/options-background.mdx → website/api/options-background.mdx View File

1
 ---
1
 ---
2
-id: background-options
2
+id: options-background
3
 title: Background Options
3
 title: Background Options
4
 sidebar_label: Background
4
 sidebar_label: Background
5
 ---
5
 ---

website/docs/options-bottomTab.mdx → website/api/options-bottomTab.mdx View File

1
 ---
1
 ---
2
-id: bottomTab-options
2
+id: options-bottomTab
3
 title: Bottom Tab Options
3
 title: Bottom Tab Options
4
 sidebar_label: Bottom Tab
4
 sidebar_label: Bottom Tab
5
 ---
5
 ---

website/docs/options-bottomTabs.mdx → website/api/options-bottomTabs.mdx View File

1
 ---
1
 ---
2
-id: bottomTabs-options
2
+id: options-bottomTabs
3
 title: Bottom Tabs Options
3
 title: Bottom Tabs Options
4
 sidebar_label: Bottom Tabs
4
 sidebar_label: Bottom Tabs
5
 ---
5
 ---

website/docs/options-button.mdx → website/api/options-button.mdx View File

1
 ---
1
 ---
2
-id: button-options
2
+id: options-button
3
 title: Button Options
3
 title: Button Options
4
 sidebar_label: Button
4
 sidebar_label: Button
5
 ---
5
 ---

+ 5
- 0
website/api/options-fab.mdx View File

1
+---
2
+id: options-fab
3
+title: Fab
4
+sidebar_label: Fab
5
+---

website/docs/options-iconInsets.mdx → website/api/options-iconInsets.mdx View File

1
 ---
1
 ---
2
-id: iconInsets-options
2
+id: options-iconInsets
3
 title: IconInsets Options
3
 title: IconInsets Options
4
 sidebar_label: IconInsets
4
 sidebar_label: IconInsets
5
 ---
5
 ---

website/docs/options-largeTitle.mdx → website/api/options-largeTitle.mdx View File

1
 ---
1
 ---
2
-id: largeTitle-options
2
+id: options-largeTitle
3
 title: Large Title Options
3
 title: Large Title Options
4
 sidebar_label: Large Title
4
 sidebar_label: Large Title
5
 ---
5
 ---

website/docs/layout-options.mdx → website/api/options-layout.mdx View File

1
 ---
1
 ---
2
-id: layout-options
2
+id: options-layout
3
 title: Layout Options
3
 title: Layout Options
4
 sidebar_label: Layout
4
 sidebar_label: Layout
5
 ---
5
 ---

website/docs/options-migration.mdx → website/api/options-migration.mdx View File


website/docs/options-overlay.mdx → website/api/options-overlay.mdx View File

1
 ---
1
 ---
2
-id: overlay-options
2
+id: options-overlay
3
 title: Overlay
3
 title: Overlay
4
 sidebar_label: Overlay
4
 sidebar_label: Overlay
5
 ---
5
 ---

+ 5
- 0
website/api/options-preview.mdx View File

1
+---
2
+id: options-preview
3
+title: Preview (iOS)
4
+sidebar_label: Preview (iOS)
5
+---

website/docs/options-root.mdx → website/api/options-root.mdx View File

39
 
39
 
40
 | Type                           | Required | Platform |
40
 | Type                           | Required | Platform |
41
 | ------------------------------ | -------- | -------- |
41
 | ------------------------------ | -------- | -------- |
42
-| [TopBarOptions](stack-options.mdx) |          | No       |
42
+| [TopBarOptions](options-stack.mdx) |          | No       |
43
 
43
 
44
 ## `statusBar`
44
 ## `statusBar`
45
 
45
 
47
 
47
 
48
 | Type                                  | Required | Platform |
48
 | Type                                  | Required | Platform |
49
 | ------------------------------------- | -------- | -------- |
49
 | ------------------------------------- | -------- | -------- |
50
-| [StatusBarOptions](statusBar-options.mdx) | No       | Both     |
50
+| [StatusBarOptions](options-statusBar.mdx) | No       | Both     |
51
 
51
 
52
 ## `layout`
52
 ## `layout`
53
 
53
 
54
 | Type                            | Required | Platform |
54
 | Type                            | Required | Platform |
55
 | ------------------------------- | -------- | -------- |
55
 | ------------------------------- | -------- | -------- |
56
-| [LayoutOptions](layout-options.mdx) | No       | Both     |
56
+| [LayoutOptions](options-layout.mdx) | No       | Both     |
57
 
57
 
58
 ## `sideMenu`
58
 ## `sideMenu`
59
 
59
 
83
 
83
 
84
 | Type                              | Required | Platform |
84
 | Type                              | Required | Platform |
85
 | --------------------------------- | -------- | -------- |
85
 | --------------------------------- | -------- | -------- |
86
-| [PreviewOptions](preview-options.mdx) | No       | iOS      |
86
+| [PreviewOptions](options-preview.mdx) | No       | iOS      |
87
 
87
 
88
 ## `splitView`
88
 ## `splitView`
89
 
89
 
95
 
95
 
96
 | Type               | Required | Platform |
96
 | Type               | Required | Platform |
97
 | ------------------ | -------- | -------- |
97
 | ------------------ | -------- | -------- |
98
-| [Fab](fab-options.mdx) | No       | Android  |
98
+| [Fab](options-fab.mdx) | No       | Android  |
99
 
99
 
100
 ## `modalPresentationStyle`
100
 ## `modalPresentationStyle`
101
 
101
 

website/docs/options-sideMenu.mdx → website/api/options-sideMenu.mdx View File

1
 ---
1
 ---
2
-id: sideMenu-options
2
+id: options-sideMenu
3
 title: Side Menu Options
3
 title: Side Menu Options
4
 sidebar_label: Side Menu
4
 sidebar_label: Side Menu
5
 ---
5
 ---

website/docs/options-sideMenuSide.mdx → website/api/options-sideMenuSide.mdx View File

1
 ---
1
 ---
2
-id: sideMenuSide-options
2
+id: options-sideMenuSide
3
 title: Side Menu Side Options
3
 title: Side Menu Side Options
4
 sidebar_label: Side Menu Side
4
 sidebar_label: Side Menu Side
5
 ---
5
 ---

website/docs/options-splitView.mdx → website/api/options-splitView.mdx View File

1
 ---
1
 ---
2
-id: splitView-options
2
+id: options-splitView
3
 title: SplitView Options
3
 title: SplitView Options
4
 sidebar_label: SplitView
4
 sidebar_label: SplitView
5
 ---
5
 ---

website/docs/stack-options.mdx → website/api/options-stack.mdx View File

1
 ---
1
 ---
2
-id: stack-options
2
+id: options-stack
3
 title: Top Bar Options
3
 title: Top Bar Options
4
 sidebar_label: Top Bar
4
 sidebar_label: Top Bar
5
 ---
5
 ---
32
 
32
 
33
 | Type                   | Required | Platform |
33
 | Type                   | Required | Platform |
34
 | ---------------------- | -------- | -------- |
34
 | ---------------------- | -------- | -------- |
35
-| [Title](title-options.mdx) | No       | Both     |
35
+| [Title](options-title.mdx) | No       | Both     |
36
 
36
 
37
 ### `subtitle`
37
 ### `subtitle`
38
 
38
 
40
 
40
 
41
 | Type                         | Required | Platform |
41
 | Type                         | Required | Platform |
42
 | ---------------------------- | -------- | -------- |
42
 | ---------------------------- | -------- | -------- |
43
-| [Subitle](subtitle-options.mdx) | No       | Both     |
43
+| [Subitle](options-subtitle.mdx) | No       | Both     |
44
 
44
 
45
 ### `backButton`
45
 ### `backButton`
46
 
46
 

website/docs/statusBar-options.mdx → website/api/options-statusBar.mdx View File

1
 ---
1
 ---
2
-id: statusBar-options
2
+id: options-statusBar
3
 title: Status Bar Options
3
 title: Status Bar Options
4
 sidebar_label: Status Bar
4
 sidebar_label: Status Bar
5
 ---
5
 ---

website/docs/subtitle-options.mdx → website/api/options-subtitle.mdx View File

1
 ---
1
 ---
2
-id: subtitle-options
2
+id: options-subtitle
3
 title: Subtitle Options
3
 title: Subtitle Options
4
 sidebar_label: Subtitle
4
 sidebar_label: Subtitle
5
 ---
5
 ---

website/docs/title-options.mdx → website/api/options-title.mdx View File

1
 ---
1
 ---
2
-id: title-options
2
+id: options-title
3
 title: Title Options
3
 title: Title Options
4
 sidebar_label: Title
4
 sidebar_label: Title
5
 ---
5
 ---

website/docs/Installing.mdx → website/docs/docs-Installing.mdx View File

42
 +   Navigation.setRoot({
42
 +   Navigation.setRoot({
43
 +     root: {
43
 +     root: {
44
 +       stack: {
44
 +       stack: {
45
-+         component: {
46
-+           name: 'com.myApp.WelcomeScreen'
47
-+         }
45
++         children: [
46
++           component: {
47
++             name: 'com.myApp.WelcomeScreen'
48
++           }
49
++         ]
48
 +       }
50
 +       }
49
 +     }
51
 +     }
50
 +  });
52
 +  });
51
 +});
53
 +});
52
 ```
54
 ```
53
-
54
-⚠️ we use the layout type `component` here, which renders a React component but does not allow you to navigate to others. See [Usage](docs/Usage.md) and [LayoutTypes](docs/layout-types.md) for more options.
55
 ___
55
 ___
56
 
56
 
57
 ## Manual Installation
57
 ## Manual Installation
313
 
313
 
314
 Now run `npm run android` to build your application
314
 Now run `npm run android` to build your application
315
 
315
 
316
-### Ignore other RNN flavors
317
-If you don't want to run `npm run android` and want to keep the default `react-native run-android` command, you need to instruct gradle to ignore the other flavors RNN provides.
318
-
319
-To do so edit `android/build.gradle` and add:
320
-
321
-```diff
322
-+subprojects { subproject ->
323
-+    afterEvaluate {
324
-+        if ((subproject.plugins.hasPlugin('android') || subproject.plugins.hasPlugin('android-library'))) {
325
-+            android {
326
-+                variantFilter { variant ->
327
-+                    def names = variant.flavors*.name
328
-+                    if (names.contains("reactNative51") || names.contains("reactNative55")) {
329
-+                        setIgnore(true)
330
-+                    }
331
-+                }
332
-+            }
333
-+        }
334
-+    }
335
-+}
336
-```
337
-
338
-**Note**: As more build variants become available in the future, you will need to adjust the list (`names.contains("reactNative51") || names.contains("reactNative55")`). This is why we recommend the first solution.
339
-
340
 ### Force the same support library version across all dependencies
316
 ### Force the same support library version across all dependencies
341
 Some of your dependencies might require a different version of one of Google's support library packages. This results in compilation errors similar to this:
317
 Some of your dependencies might require a different version of one of Google's support library packages. This results in compilation errors similar to this:
342
 
318
 

website/docs/advanced-navigation.mdx → website/docs/docs-advanced-navigation.mdx View File

10
 
10
 
11
 As mobile applications become bigger and more complex, they usually end up containing multiple primary high-level destinations, which are logically independent from one another. The `BottomTabs` layout is often used when an app contains three to five top-level destinations which should be accessible from anywhere in the app.
11
 As mobile applications become bigger and more complex, they usually end up containing multiple primary high-level destinations, which are logically independent from one another. The `BottomTabs` layout is often used when an app contains three to five top-level destinations which should be accessible from anywhere in the app.
12
 
12
 
13
-Lets return to the example code from the previous section ([Basic navigation](basic-navigation.mdx)) and see how we can convert it to a tab-based application. We'll use the BottomTabs layout to display tabs at the bottom of the screen. Similarly to `Stack` layout, The BottomTabs layout also contains a `children` property where each child will be displayed in a tab.
13
+Lets return to the example code from the previous section ([Basic navigation](basic-navigation)) and see how we can convert it to a tab-based application. We'll use the BottomTabs layout to display tabs at the bottom of the screen. Similarly to `Stack` layout, The BottomTabs layout also contains a `children` property where each child will be displayed in a tab.
14
 
14
 
15
 Lets change our code to the following and reload the app.
15
 Lets change our code to the following and reload the app.
16
 
16
 

website/docs/app-launch.mdx → website/docs/docs-app-launch.mdx View File


website/docs/basic-navigation.mdx → website/docs/docs-basic-navigation.mdx View File

92
 
92
 
93
 In order to push another screen to the stack, we will add a button to the home screen and call `Navigation.push`. The 'push' command accepts two parameters, the first is the id used to indicate into which stack to push the screen and the second is the screen we're pushing. After pushing a screen, a back button is added automatically to the TopBar so the users can navigate easily back to the previous screen.
93
 In order to push another screen to the stack, we will add a button to the home screen and call `Navigation.push`. The 'push' command accepts two parameters, the first is the id used to indicate into which stack to push the screen and the second is the screen we're pushing. After pushing a screen, a back button is added automatically to the TopBar so the users can navigate easily back to the previous screen.
94
 
94
 
95
-You can read more about the stack layout [here](stack-doc.mdx) or dive right into the API [here](stack-api.mdx).
95
+You can read more about the stack layout [here](stack.mdx) or dive right into the API [here](../api/layout-stack).
96
 
96
 
97
 :::info componentId
97
 :::info componentId
98
 Each React component registered with `Navigation.registerComponent` is assigned a unique `componentId` by Navigation. This unique id is used with Navigation commands (like the push command) to indicate into which stack we'd like to push. In this case, by using the componentId of the Home screen, we are telling Navigation to push into the stack containing the Home screen.
98
 Each React component registered with `Navigation.registerComponent` is assigned a unique `componentId` by Navigation. This unique id is used with Navigation commands (like the push command) to indicate into which stack we'd like to push. In this case, by using the componentId of the Home screen, we are telling Navigation to push into the stack containing the Home screen.

website/docs/before-you-start.mdx → website/docs/docs-before-you-start.mdx View File

8
 
8
 
9
 We also assume you are working on a Mac with XCode and Android Studio installed and setup. You can also make it work in a Linux distribution, of course, but in that case bare in mind that some sections of the docs that deal with iOS might not be relevant to you.
9
 We also assume you are working on a Mac with XCode and Android Studio installed and setup. You can also make it work in a Linux distribution, of course, but in that case bare in mind that some sections of the docs that deal with iOS might not be relevant to you.
10
 
10
 
11
-If you want to dig right into it, start with [installing](Installing.mdx) the library. If you're just looking around, we suggest checking out [basic navigation](basic-navigation.mdx) first.
11
+If you want to dig right into it, start with [installing](installing) the library. If you're just looking around, we suggest checking out [basic navigation](basic-navigation) first.
12
 
12
 

+ 1
- 1
website/docs/docs-bottomTabs.mdx View File

1
 ---
1
 ---
2
-id: docs-bottomTabs
2
+id: bottomTabs
3
 title: Bottom tabs
3
 title: Bottom tabs
4
 sidebar_label: Bottom tabs
4
 sidebar_label: Bottom tabs
5
 ---
5
 ---

+ 1
- 1
website/docs/docs-externalComponent.mdx View File

1
 ---
1
 ---
2
-id: docs-externalComponent
2
+id: externalComponent
3
 title: External Component
3
 title: External Component
4
 sidebar_label: External Component
4
 sidebar_label: External Component
5
 ---
5
 ---

+ 1
- 1
website/docs/docs-modal.mdx View File

1
 ---
1
 ---
2
-id: docs-modal
2
+id: modal
3
 title: Modal
3
 title: Modal
4
 sidebar_label: Modal
4
 sidebar_label: Modal
5
 ---
5
 ---

+ 1
- 1
website/docs/docs-overlay.mdx View File

1
 ---
1
 ---
2
-id: docs-overlay
2
+id: overlay
3
 title: Overlay
3
 title: Overlay
4
 sidebar_label: Overlay
4
 sidebar_label: Overlay
5
 ---
5
 ---

website/docs/passing-data-to-components.mdx → website/docs/docs-passing-data-to-components.mdx View File

6
 
6
 
7
 ## Initial props
7
 ## Initial props
8
 
8
 
9
-React components use [props](https://facebook.github.io/react-native/docs/props) to receive data when they are created. When displaying the [component](component.mdx) layout, you can pass initial props to components using the `passProps` property.
9
+React components use [props](https://facebook.github.io/react-native/docs/props) to receive data when they are created. When displaying the [component](../api/layout-component) layout, you can pass initial props to components using the `passProps` property.
10
 
10
 
11
 In this example, we push the `UserProfile` screen and pass two initial props to it:
11
 In this example, we push the `UserProfile` screen and pass two initial props to it:
12
 
12
 
33
 
33
 
34
 Static options can either be a simple object, or a function which accepts `passProps` as an argument. Sometimes when declaring components, not all style properties are known. For example, a user profile screen will usually have the user's name as the TopBar title text. Therefore the title must be configured dynamically when pushing the screen.
34
 Static options can either be a simple object, or a function which accepts `passProps` as an argument. Sometimes when declaring components, not all style properties are known. For example, a user profile screen will usually have the user's name as the TopBar title text. Therefore the title must be configured dynamically when pushing the screen.
35
 
35
 
36
-Following the code example [above](passing-data-to-components.mdx#initial-props), lets see how to use props passed in the push command to set the TopBar title.
36
+Following the code example [above](passing-data-to-components#initial-props), lets see how to use props passed in the push command to set the TopBar title.
37
 
37
 
38
 ```jsx
38
 ```jsx
39
 class UserProfileScreen extends React.Component {
39
 class UserProfileScreen extends React.Component {
51
 
51
 
52
 ## Updating props
52
 ## Updating props
53
 
53
 
54
-To update a component's props, use the [Navigation.updateProps()](component-api.mdx#updateprops) command. Updating props triggers the component lifecycle methods related to [updating](https://reactjs.org/docs/react-component.html#updating).
54
+To update a component's props, use the [Navigation.updateProps()](../api/component#updateprops) command. Updating props triggers the component lifecycle methods related to [updating](https://reactjs.org/docs/react-component.html#updating).
55
 
55
 
56
 Notice that we're using the component `id` in order to update props of this specific instance of the component.
56
 Notice that we're using the component `id` in order to update props of this specific instance of the component.
57
 
57
 

website/docs/playground-app.mdx → website/docs/docs-playground-app.mdx View File

13
     - `npm run start` to get the packager running in the terminal, leave it open
13
     - `npm run start` to get the packager running in the terminal, leave it open
14
     - **iOS**: open `./playground/ios` in Xcode and run it
14
     - **iOS**: open `./playground/ios` in Xcode and run it
15
     - **Android**: open `./playground/android` in Android Studio and run it
15
     - **Android**: open `./playground/android` in Android Studio and run it
16
-3. You can run tests if / when you need to (list of scripts [available here](contributing.mdx#scripts)). Before you start changing things, make sure everything works.
16
+3. You can run tests if / when you need to (list of scripts [available here](contributing#scripts)). Before you start changing things, make sure everything works.
17
 	- To easily run all tests in parallel `npm run test-all`
17
 	- To easily run all tests in parallel `npm run test-all`

+ 1
- 1
website/docs/docs-root.mdx View File

1
 ---
1
 ---
2
-id: docs-root
2
+id: root
3
 title: Root
3
 title: Root
4
 sidebar_label: Root
4
 sidebar_label: Root
5
 ---
5
 ---

website/docs/screen-lifecycle.mdx → website/docs/docs-screen-lifecycle.mdx View File


website/docs/showcases.mdx → website/docs/docs-showcases.mdx View File


website/docs/sideMenu-docs.mdx → website/docs/docs-sideMenu.mdx View File

1
 ---
1
 ---
2
-id: docs-sideMenu
2
+id: sideMenu
3
 title: Side Menu
3
 title: Side Menu
4
 sidebar_label: Side Menu
4
 sidebar_label: Side Menu
5
 ---
5
 ---

+ 1
- 1
website/docs/docs-stack.mdx View File

1
 ---
1
 ---
2
-id: docs-stack
2
+id: stack
3
 title: Stack
3
 title: Stack
4
 sidebar_label: Stack
4
 sidebar_label: Stack
5
 ---
5
 ---

website/docs/animations.mdx → website/docs/style-animations.mdx View File

1
 ---
1
 ---
2
-id: docs-animations
2
+id: style-animations
3
 title: Animations
3
 title: Animations
4
 sidebar_label: Animations
4
 sidebar_label: Animations
5
 ---
5
 ---

website/docs/docs-constants.mdx → website/docs/style-constants.mdx View File

1
 ---
1
 ---
2
-id: constants-docs
2
+id: style-constants
3
 title: Constants
3
 title: Constants
4
 sidebar_label: Constants
4
 sidebar_label: Constants
5
 ---
5
 ---

website/docs/styling-fonts.mdx → website/docs/style-fonts.mdx View File

1
 ---
1
 ---
2
-id: fonts
2
+id: style-fonts
3
 title: Changing fonts
3
 title: Changing fonts
4
 sidebar_label: Changing fonts
4
 sidebar_label: Changing fonts
5
 ---
5
 ---

website/docs/orientation.mdx → website/docs/style-orientation.mdx View File

1
 ---
1
 ---
2
-id: orientation
2
+id: style-orientation
3
 title: Orientation
3
 title: Orientation
4
 sidebar_label: Orientation
4
 sidebar_label: Orientation
5
 ---
5
 ---

website/docs/statusbar-docs.mdx → website/docs/style-statusbar.mdx View File

1
 ---
1
 ---
2
-id: statusBar-docs
2
+id: style-statusBar
3
 title: StatusBar
3
 title: StatusBar
4
 sidebar_label: StatusBar
4
 sidebar_label: StatusBar
5
 ---
5
 ---

website/docs/theme.mdx → website/docs/style-theme.mdx View File

1
 ---
1
 ---
2
-id: theme
2
+id: style-theme
3
 title: Themes
3
 title: Themes
4
 sidebar_label: Themes
4
 sidebar_label: Themes
5
 ---
5
 ---

+ 23
- 6
website/docusaurus.config.js View File

19
         src: 'img/logo.png',
19
         src: 'img/logo.png',
20
       },
20
       },
21
       links: [
21
       links: [
22
-        {to: 'docs/installing', label: 'Docs', position: 'left'},
23
-        {to: 'docs/component-api', label: 'API', position: 'left'},
22
+        {to: 'docs/before-you-start', label: 'Docs', position: 'left', activeBasePath: 'docs'},
23
+        {to: 'api/component', label: 'API', position: 'left', activeBasePath: 'api'},
24
         {
24
         {
25
           href: 'https://github.com/wix/react-native-navigation',
25
           href: 'https://github.com/wix/react-native-navigation',
26
           label: 'GitHub',
26
           label: 'GitHub',
77
               label: 'GitHub',
77
               label: 'GitHub',
78
               href: 'https://github.com/wix/react-native-navigation',
78
               href: 'https://github.com/wix/react-native-navigation',
79
             },
79
             },
80
-            // {
81
-            //   label: 'Twitter',
82
-            //   href: 'https://twitter.com/docusaurus',
83
-            // },
80
+            {
81
+              label: 'Twitter',
82
+              href: 'https://twitter.com/ReactNativeNav',
83
+            },
84
           ],
84
           ],
85
         },
85
         },
86
       ]
86
       ]
92
       {
92
       {
93
         docs: {
93
         docs: {
94
           sidebarPath: require.resolve('./sidebars.js'),
94
           sidebarPath: require.resolve('./sidebars.js'),
95
+          routeBasePath: 'docs',
96
+          path: 'docs',
95
           editUrl:
97
           editUrl:
96
             'https://github.com/wix/react-native-navigation/edit/master/website/docs'
98
             'https://github.com/wix/react-native-navigation/edit/master/website/docs'
97
         },
99
         },
100
         },
102
         },
101
       },
103
       },
102
     ],
104
     ],
105
+    [
106
+      '@docusaurus/preset-classic',
107
+      {
108
+        docs: {
109
+          routeBasePath: 'api',
110
+          path: 'api',
111
+          sidebarPath: require.resolve('./sidebarsApi.js'),
112
+          editUrl:
113
+            'https://github.com/wix/react-native-navigation/edit/master/website/docs'
114
+        },
115
+        theme: {
116
+          customCss: require.resolve('./src/css/custom.css'),
117
+        },
118
+      },
119
+    ]
103
   ],
120
   ],
104
 };
121
 };

+ 2
- 2
website/package.json View File

9
     "deploy": "docusaurus deploy"
9
     "deploy": "docusaurus deploy"
10
   },
10
   },
11
   "dependencies": {
11
   "dependencies": {
12
-    "@docusaurus/core": "^2.0.0-alpha.48",
13
-    "@docusaurus/preset-classic": "^2.0.0-alpha.48",
12
+    "@docusaurus/core": "^2.0.0-alpha.50",
13
+    "@docusaurus/preset-classic": "^2.0.0-alpha.50",
14
     "classnames": "^2.2.6",
14
     "classnames": "^2.2.6",
15
     "react": "^16.8.4",
15
     "react": "^16.8.4",
16
     "react-dom": "^16.8.4"
16
     "react-dom": "^16.8.4"

+ 23
- 79
website/sidebars.js View File

1
 module.exports = {
1
 module.exports = {
2
   docs: {
2
   docs: {
3
     'Getting Started': [
3
     'Getting Started': [
4
-      'before-you-start',
5
-      'installing',
6
-      'playground-app',
7
-      'showcases'
4
+       'before-you-start',
5
+       'installing',
6
+       'playground-app',
7
+       'showcases'
8
     ],
8
     ],
9
     'Using the app': [
9
     'Using the app': [
10
-      'app-launch',
11
-      'basic-navigation',
12
-      'advanced-navigation',
13
-      'screen-lifecycle',
14
-      'passing-data-to-components',
10
+       'app-launch',
11
+       'basic-navigation',
12
+       'advanced-navigation',
13
+       'screen-lifecycle',
14
+       'passing-data-to-components',
15
     ],
15
     ],
16
     Layouts: [
16
     Layouts: [
17
-      'docs-stack',
18
-      'docs-bottomTabs',
19
-      'docs-sideMenu',
20
-      'docs-externalComponent',
17
+       'stack',
18
+       'bottomTabs',
19
+       'sideMenu',
20
+       'externalComponent',
21
     ],
21
     ],
22
     Hierarchy: [
22
     Hierarchy: [
23
-      'docs-root',
24
-      'docs-modal',
25
-      'docs-overlay'
23
+       'root',
24
+       'modal',
25
+       'overlay'
26
     ],
26
     ],
27
     Styling: [
27
     Styling: [
28
-      'theme',
29
-      'statusBar-docs',
30
-      'orientation',
31
-      'docs-animations',
32
-      'fonts',
33
-      'constants-docs'
28
+      'style-theme',
29
+      'style-statusBar',
30
+      'style-orientation',
31
+      'style-animations',
32
+      'style-fonts',
33
+      'style-constants'
34
     ],
34
     ],
35
     Meta: [
35
     Meta: [
36
       'meta-contributing'
36
       'meta-contributing'
37
     ]
37
     ]
38
-  },
39
-  api: [
40
-    {
41
-      type: 'category',
42
-      label: 'Navigation',
43
-      items: [
44
-        'component-api',
45
-        'root-api',
46
-        'stack-api',
47
-        'modal-api',
48
-        'overlay-api'
49
-      ]
50
-    },
51
-    {
52
-      type: 'category',
53
-      label: 'Layouts',
54
-      items: [
55
-        'layout',
56
-        'component-layout',
57
-        'stack-layout',
58
-        'bottomTabs-layout',
59
-        'sideMenu-layout',
60
-        'splitView'
61
-      ]
62
-    },
63
-    {
64
-      type: 'category',
65
-      label: 'Options',
66
-      items: [
67
-        'options-api',
68
-        'options-root',
69
-        'bottomTabs-options',
70
-        'bottomTab-options',
71
-        {
72
-          'type': 'category',
73
-          'label': 'Stack',
74
-          'items': [
75
-            'stack-options',
76
-            'title-options',
77
-            'subtitle-options',
78
-            'background-options',
79
-            'backButton-options',
80
-            'button-options',
81
-            'iconInsets-options',
82
-            'largeTitle-options'
83
-          ]
84
-        },
85
-        'statusBar-options',
86
-        'layout-options',
87
-        'overlay-options',
88
-        'sideMenu-options',
89
-        'sideMenuSide-options',
90
-        'splitView-options'
91
-      ]
92
-    },
93
-    'events-api'
94
-  ]
38
+  }
95
 };
39
 };

+ 58
- 0
website/sidebarsApi.js View File

1
+module.exports = {
2
+  api: [
3
+    {
4
+      type: 'category',
5
+      label: 'Navigation',
6
+      items: [
7
+        'component',
8
+        'root',
9
+        'stack',
10
+        'modal',
11
+        'overlay'
12
+      ]
13
+    },
14
+    {
15
+      type: 'category',
16
+      label: 'Layouts',
17
+      items: [
18
+        'layout-layout',
19
+        'layout-component',
20
+        'layout-stack',
21
+        'layout-bottomTabs',
22
+        'layout-sideMenu',
23
+        'layout-splitView'
24
+      ]
25
+    },
26
+    {
27
+      type: 'category',
28
+      label: 'Options',
29
+      items: [
30
+        'options-api',
31
+        'options-root',
32
+        'options-bottomTabs',
33
+        'options-bottomTab',
34
+        {
35
+          'type': 'category',
36
+          'label': 'Stack',
37
+          'items': [
38
+            'options-stack',
39
+            'options-title',
40
+            'options-subtitle',
41
+            'options-background',
42
+            'options-backButton',
43
+            'options-button',
44
+            'options-iconInsets',
45
+            'options-largeTitle'
46
+          ]
47
+        },
48
+        'options-statusBar',
49
+        'options-layout',
50
+        'options-overlay',
51
+        'options-sideMenu',
52
+        'options-sideMenuSide',
53
+        'options-splitView'
54
+      ]
55
+    },
56
+    'events'
57
+  ]
58
+};

+ 1
- 1
website/src/pages/index.js View File

2
 import {Redirect} from '@docusaurus/router';
2
 import {Redirect} from '@docusaurus/router';
3
 
3
 
4
 function Home() {
4
 function Home() {
5
-  return <Redirect to="/react-native-navigation/docs/before-you-start" />;
5
+  return <Redirect to="/react-native-navigation/docs/before-you-start/" />;
6
 }
6
 }
7
 
7
 
8
 export default Home;
8
 export default Home;