Skip to content

Commit d8b5057

Browse files
eriveltoneliassatya164
authored andcommitted
feat: migrate to docusaurus v2 (react-navigation#669)
1 parent e45b92e commit d8b5057

File tree

514 files changed

+7875
-29570
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

514 files changed

+7875
-29570
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
node_modules
22
.DS_Store
3+
.docusaurus
34
website/translated_docs
45
website/build/
56
website/node_modules
7+
website/.docusaurus
68

79
website/i18n/*
810
!website/i18n/en.json

docs/.gitkeep

Whitespace-only changes.

website/ .nojekyll

Whitespace-only changes.

website/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Website
2+
3+
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
```
30+
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
31+
```
32+
33+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

website/blog/2018-02-06-react-navigation-1.0.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
---
22
title: React Navigation 1.0 (goodbye, beta!)
3-
author: Core Team
4-
authorURL: https://twitter.com/reactnavigation
3+
author: Brent Vatne
4+
author_url: https://twitter.com/notbrent
5+
author_title: Core Team
6+
author_image_url: https://avatars0.githubusercontent.com/u/90494?s=200&v=4
7+
tags: [release, announcement]
58
---
69

710
As of today, React Navigation version 1.0 has been released! To see a list of recent improvements leading up to the release, refer to the “[Renewed Path to React Navigation V1.0](https://github.com/react-navigation/react-navigation/issues/2585)” issue. Thank you to everybody who has filed high-quality bug reports, submitted pull requests, and helped out fellow developers while we were in beta!
811

12+
<!--truncate-->
13+
914
This release isn’t meant to be interpreted as a signal that React Navigation is “finished" &mdash; work is already underway on a number of significant changes to the API that aim to make React Navigation easier to use and more powerful. These changes will be run through our [new RFC process](https://github.com/react-navigation/rfcs). For example, the [Navigator View API RFC](https://github.com/react-navigation/rfcs/blob/master/text/0002-navigator-view-api.md) outlines a plan to decouple views from the router in order to make it easier for other navigation APIs, such as [react-native-router-flux](https://github.com/aksonov/react-native-router-flux) and [react-router-native](https://github.com/ReactTraining/react-router/tree/master/packages/react-router-native), to build on top of the same navigation views. We’re also very excited about a plan (no RFC is open yet, but keep an eye out for it) to use [react-native-gesture-handler](https://github.com/software-mansion/react-native-gesture-handler) to run navigation gestures (sliding a drawer open, or swiping back on a stack, for example) on the UI thread using the Animated native driver.
1015

1116
Last week we released an updated version of our [documentation website](https://reactnavigation.org/docs/getting-started.html), built using [Docusaurus](https://docusaurus.io/). We hope that the new documentation will help newcomers get onboarded with the fundamentals of React Navigation, and serve as an ongoing resource to handle specific use cases as you come across them (under the “How do I do..?” section). [Contributions to the documentation are very welcome](https://github.com/react-navigation/react-navigation.github.io).

website/blog/2018-04-06-react-navigation-2.0-rc.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
---
22
title: 2.0 release candidate
3-
author: Core Team
4-
authorURL: https://twitter.com/reactnavigation
3+
author: Brent Vatne
4+
author_url: https://twitter.com/notbrent
5+
author_title: Core Team
6+
author_image_url: https://avatars0.githubusercontent.com/u/90494?s=200&v=4
7+
tags: [release, announcement]
58
---
69

710
Exactly two months after the release of React Navigation 1.0, we are close to another major version release. We’d like to invite developers that use the library to give the release candidate a try in your app and let us know if you encounter any issues.
811

12+
<!--truncate-->
13+
914
```
1015
yarn add react-navigation@^2.0.0-rc.1
1116
```

website/blog/2018-05-07-react-navigation-2.0.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
---
22
title: React Navigation 2.0
3-
author: Core Team
4-
authorURL: https://twitter.com/reactnavigation
3+
author: Brent Vatne
4+
author_url: https://twitter.com/notbrent
5+
author_title: Core Team
6+
author_image_url: https://avatars0.githubusercontent.com/u/90494?s=200&v=4
7+
tags: [release, announcement]
58
---
69

710
The documentation is now live at https://reactnavigation.org, and v1 lives [here](/docs/en/1.x/getting-started.html).
811

12+
<!--truncate-->
13+
914
## Significant breaking changes
1015

1116
The following changes are considered “significant” because they can’t be fixed by search and replace or something that is similarly mechanical.

website/blog/2018-11-01-react-navigation-3.0-rc.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
---
22
title: 3.0 release candidate
3-
author: Core Team
4-
authorURL: https://twitter.com/reactnavigation
3+
author: Brent Vatne
4+
author_url: https://twitter.com/notbrent
5+
author_title: Core Team
6+
author_image_url: https://avatars0.githubusercontent.com/u/90494?s=200&v=4
7+
tags: [release, announcement]
58
---
69

710
We are excited to announce the release candidate of version 3.0 today!
811

912
This is the first release where React Navigation depends on a native module outside of React Native core: it now depends on react-native-gesture-handler. This library provides an excellent set of primitives for leveraging the operating systems’ native gesture APIs and has enabled us to fix a variety of issues with stack and drawer navigators. React Navigation also depends on react-native-screens, but you don’t need to install the native module if you prefer not to use it (we have a blog post coming soon that will explain what react-native-screens is and why you may want to use it, or you can watch [this talk](https://www.youtube.com/watch?v=Z0Jl1KCWiag) by the author of the library).
1013

14+
<!--truncate-->
15+
1116
We didn’t get around to every feature that we wanted to land for this release, but we also didn’t want to hold it up further because we expect that you will want to start using it right away - the release includes performance improvements, bugfixes, ergonomics improvements, some handy new features, and a re-organizing of the internals to improve support for web as a target of React Navigation.
1217

1318
Let’s get started with react-navigation 3.0.
@@ -218,4 +223,3 @@ See a simple web app with Create React App [here](https://github.com/react-navig
218223
----------
219224
220225
Thanks for reading, please post any issues you encounter to https://github.com/react-navigation/react-navigation/issues!
221-

website/blog/2018-11-17-react-navigation-3.0.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
---
22
title: React Navigation 3.0
3-
author: Core Team
4-
authorURL: https://twitter.com/reactnavigation
3+
author: Brent Vatne
4+
author_url: https://twitter.com/notbrent
5+
author_title: Core Team
6+
author_image_url: https://avatars0.githubusercontent.com/u/90494?s=200&v=4
7+
tags: [release, announcement]
58
---
69

710
The documentation is now live at https://reactnavigation.org, and v2 lives [here](/docs/en/2.x/getting-started.html).
811

912
This is the first release where React Navigation depends on a native module outside of React Native core: it now depends on react-native-gesture-handler. This library provides an excellent set of primitives for leveraging the operating systems’ native gesture APIs and has enabled us to fix a variety of issues with stack and drawer navigators. React Navigation also depends on react-native-screens, but you don’t need to install the native module if you prefer not to use it (we have a blog post coming soon that will explain what react-native-screens is and why you may want to use it, or you can watch [this talk](https://www.youtube.com/watch?v=Z0Jl1KCWiag) by the author of the library).
1013

14+
<!--truncate-->
15+
1116
We didn’t get around to every feature that we wanted to land for this release, but we also didn’t want to hold it up further because we expect that you will want to start using it right away - the release includes performance improvements, bugfixes, ergonomics improvements, some handy new features, and a re-organizing of the internals to improve support for web as a target of React Navigation.
1217

1318
Let’s get started with react-navigation 3.0.

website/blog/2019-09-16-react-navigation-4.0.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
---
22
title: React Navigation 4.0
33
author: Satyajit Sahoo
4-
authorURL: https://twitter.com/satya164
4+
author_url: https://twitter.com/satya164
5+
author_title: Core Team
6+
author_image_url: https://avatars2.githubusercontent.com/u/1174278?s=200&v=4
7+
tags: [release, announcement]
58
---
69

710
The documentation is now live at https://reactnavigation.org, and v3 lives [here](/docs/en/3.x/getting-started.html).
811

912
In this release, we have removed the navigators from the react-navigation package. The navigators have lived in separate packages for quite a while and you could already use those packages manually, but we still bundled them in the react-navigation package. This made it difficult for us to release significant updates to navigators, because we had to then do a major version release of react-navigation too. By separating the navigator packages there is more freedom to update and improve navigators without any impact on folks that don't use them.
1013

14+
<!--truncate-->
15+
1116
For example, you will find when you install the latest versions of the drawer and tab navigators that the animations are more performant because they use react-native-reanimated to smoothly animate gestures. These have been available in react-navigation-drawer and react-navigation-tabs for several months now but we delayed updating them in react-navigation itself because we did not want to force every user to update.
1217

1318
With this version, you now install the navigators from their respective packages, which means that you can independently update them.

website/blog/2019-10-17-react-navigation-native.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
---
22
title: React Navigation meets native
33
author: Michał Osadnik
4-
authorURL: https://twitter.com/mosdnk
4+
author_url: https://twitter.com/mosdnk
5+
author_title: Core Team
6+
author_image_url: https://avatars3.githubusercontent.com/u/25709300?s=460&v=4
7+
tags: [announcement]
58
---
69

710
React Navigation steps firmly into the next level and we’re very excited to announce to you something great happening in React Navigation codebase.
811

12+
<!--truncate-->
13+
914
## Make it custom
1015

1116
From the very beginning of React Navigation we have been following the important motto to make navigation experience customizable in every detail. We, front-end engineers, mobile developers and User Experience lovers, have a deep need to make decisions about each layout component.

website/blog/2019-11-04-using-react-navigation-5-with-ui-kitten.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
---
22
title: Using React Navigation 5 with UI Kitten
33
author: Artur Yorsh
4-
authorURL: https://twitter.com/artyorsh
4+
author_url: https://twitter.com/artyorsh
5+
author_title: UI Kitten Team
6+
author_image_url: https://avatars0.githubusercontent.com/u/10753921?s=200&v=4
7+
tags: [tutorial, ui-kitten]
58
---
69

710
This is a guest post by the [UI Kitten](http://akveo.github.io/react-native-ui-kitten) team. If you like this guide, checkout UI Kitten for more!
811
In this blog post, we'll show a step-by-step guide on using React Navigation 5 with UI Kitten.
912

13+
<!--truncate-->
14+
1015
## Introduction
1116

1217
The new React Navigation comes with several significant improvements such as [improving animation performance](https://blog.expo.io/re-writing-react-navigation-stack-db6a376522b1) with [gesture-handler](https://github.com/software-mansion/react-native-gesture-handler) and [reanimated](https://github.com/software-mansion/react-native-reanimated) libraries. What's more, it was migrated to TypeScript for improving the quality of your code base with type checking and more. But the biggest update is migrating to component-based API.

website/blog/2020-01-29-using-react-navigation-5-with-react-native-paper.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
---
22
title: React Navigation v5 + React Native Paper = ❤️
33
author: Dawid Urbaniak
4-
authorURL: https://twitter.com/trensik
4+
author_url: https://twitter.com/trensik
5+
author_title: Paper Team
6+
author_image_url: https://avatars0.githubusercontent.com/u/18584155?s=200&v=4
7+
tags: [tutorial, react-native-paper]
58
---
69

710
This is a guest post by the [React Native Paper](https://reactnativepaper.com/) team. If you like this guide, check out React Native Paper for more!
811

912
In this blog post, we'll show you how to build a Twitter clone app using React Navigation v5 and Paper.
1013

14+
<!--truncate-->
15+
1116
## Introduction
1217

1318
The React Navigation v5 comes with many great improvements compared to previous version. It not only provides a cross-platform native Stack, but also the API was redesigned from the ground up to allow things that were never possible before. Thanks to the component-based API, all of the configuration is happening inside the **render method**. This means we can access **props**, **state** and **context** and can **dynamically change configuration** for the navigator.
@@ -429,7 +434,7 @@ The Function that we pass to `header` prop has access to 3 properties:
429434

430435
Thanks to the **scene** property we can access the title of topmost screen on the stack and display it in the header.
431436
**Previous** property tells us if there are any other screens lower on the Stack.
432-
</br>
437+
<br />
433438
Finally, **navigation** property allows navigating to different screens e.g. opening a Drawer.
434439

435440
The thing that we haven't covered yet and it is very important is how to actually navigate between Stack Navigator screens.
@@ -524,7 +529,7 @@ export const BottomTabs = () => {
524529

525530
When we check the screen of the phone now, we will see a nice looking, material bottom navigation. What's more, Stack Navigator integrates nicely with Tab.Navigator and we can still navigate to the tweet `Details` screen.
526531

527-
</br>
532+
<br />
528533
<img src="/blog/assets/using-react-navigation-5-with-paper/bottom-navigation.gif" height="480"/>
529534

530535
## FAB and Portal
@@ -920,11 +925,11 @@ export function DrawerContent(props) {
920925
```
921926

922927
Firstly, we get a current theme using `useTheme` hook from Paper. This means we can check `dark` property on it and pass the correct value to `Switch`.
923-
</br>Secondly, we pass a `toggleTheme` function to `TouchableRipple` to toggle theme whenever user presses a Switch.
928+
<br />Secondly, we pass a `toggleTheme` function to `TouchableRipple` to toggle theme whenever user presses a Switch.
924929

925930
You should be able to toggle a switch now and both `Provider` from Paper and `NativeNavigationContainer` from React Navigation will automatically apply correct colors to the components.
926931

927-
</br>
932+
<br />
928933
<img src="/blog/assets/using-react-navigation-5-with-paper/theming.gif" height="480"/>
929934

930935
## Summary

website/blog/2020-02-06-react-navigation-5.0.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
---
22
title: React Navigation 5.0 - A new way to navigate
33
author: Satyajit Sahoo, Michał Osadnik
4-
authorURL: https://twitter.com/reactnavigation
4+
author_url: https://twitter.com/reactnavigation
5+
author_title: Core Team
6+
author_image_url: https://avatars1.githubusercontent.com/u/29647600?s=200&v=4
7+
tags: [release, announcement]
58
---
69

710
Exactly two years ago, we published the first stable version of React Navigation. Throughout this time, the library has been actively developed by adding many new features and bug fixes. The essence of React Navigation was that it was a project that was to become not only a project of individual programmers adapting it to their requirements, but a community as a whole, hence the emphasis on versatility, extensibility, and the tendency to reconsider the assumptions if there were such needs. Thanks to this, the Library has been undergoing metamorphosis of both incremental and completely reorganized shape.
811

12+
<!--truncate-->
13+
914
This led us to the moment when React Navigation became one of the most popular navigation solutions in React Native and we are incredibly proud of it.
1015

1116
Today is the day, when we want to mark this vision and major refactoring of the project, that has taken place over the last six months, as stable. One could say that this significant change concerned the core library, and therefore the API, which has been developed and made more dynamic.

0 commit comments

Comments
 (0)