Skip to content

Commit

Permalink
Merge pull request #457 from GeekyAnts/fix/docs-installation
Browse files Browse the repository at this point in the history
fix: docs installation page
  • Loading branch information
surajahmed authored Dec 16, 2024
2 parents 30281e3 + d9b4c2d commit 52be112
Show file tree
Hide file tree
Showing 10 changed files with 219 additions and 165 deletions.
34 changes: 34 additions & 0 deletions docs/3.4.x/installation-old.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: installation
title: Installation
---

import { InstallationTiles } from "../src/components";

**NativeBase** is supported in [Expo](https://docs.expo.dev/get-started/installation/) or React Native CLI initiated apps. Web support is made possible by [react-native-web](https://necolas.github.io/react-native-web/).
(Note: If you are starting a new project, please try [gluestack-ui](https://gluestack.io/ui/docs/home/getting-started/installation/?utm_source=nativebase&utm_medium=docs+install&utm_campaign=installation) for better performance, new design).

Refer the guides shown below to setup NativeBase in your React app.

<Box>
<Box mt="4" mb="8">
<InstallationTiles />
</Box>
</Box>

<br />

### NativeBase VS Code Extensions

[NativeBase VS Code Extensions](https://marketplace.visualstudio.com/items?itemName=NativeBase.nativebase-v3-vscode-extension) are specifically designed to quicken your development process using **NativeBase 3.0**.
NativeBase snippets are shorthand for commonly used NativeBase components.

All snippets start with the prefix `nb-` and are followed by the name of the desired component.

<AspectRatio ratio={1.7} w="100%" maxW="1056">
<Image
resizeMode="contain"
source={{ uri: "https://cdn.nativebase.io/NativeBaseSnippet.gif" }}
alt="aang transitioning to avatar state"
/>
</AspectRatio>
30 changes: 1 addition & 29 deletions docs/3.4.x/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,4 @@ id: installation
title: Installation
---

import { InstallationTiles } from "../src/components";

**NativeBase** is supported in [Expo](https://docs.expo.dev/get-started/installation/) or React Native CLI initiated apps. Web support is made possible by [react-native-web](https://necolas.github.io/react-native-web/).
(Note: If you are starting a new project, please try [gluestack-ui](https://gluestack.io/ui/docs/home/getting-started/installation/?utm_source=nativebase&utm_medium=docs+install&utm_campaign=installation) for better performance, new design).

Refer the guides shown below to setup NativeBase in your React app.

<Box>
<Box mt="4" mb="8">
<InstallationTiles />
</Box>
</Box>

<br />

### NativeBase VS Code Extensions

[NativeBase VS Code Extensions](https://marketplace.visualstudio.com/items?itemName=NativeBase.nativebase-v3-vscode-extension) are specifically designed to quicken your development process using **NativeBase 3.0**.
NativeBase snippets are shorthand for commonly used NativeBase components.

All snippets start with the prefix `nb-` and are followed by the name of the desired component.

<AspectRatio ratio={1.7} w="100%" maxW="1056">
<Image
resizeMode="contain"
source={{ uri: "https://cdn.nativebase.io/NativeBaseSnippet.gif" }}
alt="aang transitioning to avatar state"
/>
</AspectRatio>
Refer to the gluestack-ui [installation](https://gluestack.io/ui/docs/home/getting-started/installation) page as NativeBase docs are not maintained anymore.
File renamed without changes.
256 changes: 124 additions & 132 deletions docs/3.4.x/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,127 @@
}
]
},
{
"type": "heading",
"title": "Migration",
"pages": [
{
"id": "migration/v3",
"title": "Upgrading to v3"
},
{
"id": "migration/v3xtov32",
"title": "Upgrading to 3.2.0 from 3.x"
},
{
"id": "migration/v33xtov34x",
"title": "Upgrading to 3.4.0 from 3.3.x"
},
{
"type": "heading",
"title": "Components Migration",
"isCollapsed": true,
"pages": [
{
"id": "migration/action-sheet",
"title": "ActionSheet"
},
{
"id": "migration/badge",
"title": "Badge"
},
{
"id": "migration/button",
"title": "Button"
},
{
"id": "migration/card",
"title": "Card"
},
{
"id": "migration/checkbox",
"title": "Checkbox"
},
{
"id": "migration/date-picker",
"title": "DatePicker"
},
{
"id": "migration/deck-swiper",
"title": "DeckSwiper"
},
{
"id": "migration/drawer",
"title": "Drawer"
},
{
"id": "migration/fab",
"title": "FABs"
},
{
"id": "migration/footer-tab",
"title": "FooterTab"
},
{
"id": "migration/form",
"title": "Form"
},
{
"id": "migration/header",
"title": "Header"
},
{
"id": "migration/icon",
"title": "Icon"
},
{
"id": "migration/layout",
"title": "Layout"
},
{
"id": "migration/picker",
"title": "Picker"
},
{
"id": "migration/radio-button",
"title": "Radio Button"
},
{
"id": "migration/search-bar",
"title": "Searchbar"
},
{
"id": "migration/segment",
"title": "Segment"
},
{
"id": "migration/spinner",
"title": "Spinner"
},
{
"id": "migration/swipe-list",
"title": "SwipeList"
},
{
"id": "migration/tabs",
"title": "Tabs"
},
{
"id": "migration/thumbnail",
"title": "Thumbnail"
},
{
"id": "migration/toast",
"title": "Toast"
},
{
"id": "migration/typography",
"title": "Typography"
}
]
}
]
},
{
"type": "heading",
"title": "Resources",
Expand All @@ -65,8 +186,7 @@
},
{
"id": "solito",
"title": "Creating a Universal App with NativeBase and Solito",
"status": "new"
"title": "Creating a Universal App with NativeBase and Solito"
}
]
},
Expand Down Expand Up @@ -96,8 +216,7 @@
},
{
"id": "internal-pseudo-props",
"title": "Internal Pseudo Props",
"status": "new"
"title": "Internal Pseudo Props"
},
{
"id": "responsive",
Expand Down Expand Up @@ -307,8 +426,7 @@
},
{
"id": "toast",
"title": "Toast",
"status": "update"
"title": "Toast"
}
]
},
Expand Down Expand Up @@ -569,132 +687,6 @@
}
]
},
{
"type": "heading",
"title": "Migration",
"pages": [
{
"id": "migration/v3",
"title": "Upgrading to v3"
},
{
"id": "migration/v3xtov32",
"title": "Upgrading to 3.2.0 from 3.x"
},
{
"id": "migration/v33xtov34x",
"title": "Upgrading to 3.4.0 from 3.3.x"
},
{
"type": "heading",
"title": "Components Migration",
"isCollapsed": true,
"pages": [
{
"id": "migration/action-sheet",
"title": "ActionSheet"
},
{
"id": "migration/badge",
"title": "Badge"
},
{
"id": "migration/button",
"title": "Button"
},
{
"id": "migration/card",
"title": "Card"
},
{
"id": "migration/checkbox",
"title": "Checkbox"
},
{
"id": "migration/date-picker",
"title": "DatePicker"
},
{
"id": "migration/deck-swiper",
"title": "DeckSwiper"
},
{
"id": "migration/drawer",
"title": "Drawer"
},
{
"id": "migration/fab",
"title": "FABs"
},
{
"id": "migration/footer-tab",
"title": "FooterTab"
},
{
"id": "migration/form",
"title": "Form"
},
{
"id": "migration/header",
"title": "Header"
},
{
"id": "migration/icon",
"title": "Icon"
},
{
"id": "migration/layout",
"title": "Layout"
},
{
"id": "migration/picker",
"title": "Picker"
},
{
"id": "migration/radio-button",
"title": "Radio Button"
},
{
"id": "migration/search-bar",
"title": "Searchbar"
},
{
"id": "migration/segment",
"title": "Segment"
},
{
"id": "migration/spinner",
"title": "Spinner"
},
{
"id": "migration/swipe-list",
"title": "SwipeList"
},
{
"id": "migration/tabs",
"title": "Tabs"
},
{
"id": "migration/thumbnail",
"title": "Thumbnail"
},
{
"id": "migration/toast",
"title": "Toast"
},
{
"id": "migration/typography",
"title": "Typography"
}
]
},
{
"id": "migration-guide-gluestack-ui",
"title": "Migrating to gluestack-ui",
"status": "experimental"
}
]
},
{
"type": "heading",
"title": "More",
Expand Down
Loading

0 comments on commit 52be112

Please sign in to comment.