You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: blog/2018-04-06-react-navigation-2.0-rc.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Exactly two months after the release of React Navigation 1.0, we are close to an
15
15
yarn add react-navigation@^2.0.0-rc.1
16
16
```
17
17
18
-
The documentation for 2.0 is available at <https://reactnavigation.org/>
18
+
The documentation for 2.0 is available at [reactnavigation.org](https://reactnavigation.org)
19
19
20
20
We’re bumping the major version because some of the changes in this release are backwards incompatible. That said, this should be a fairly easy upgrade. We are improving React Navigation incrementally because we don't want to leave developers feeling stranded in an old version. If you use React Navigation in a conventional way and don't have any custom navigators, I can't imagine this update would take you more than an hour.
21
21
@@ -77,5 +77,5 @@ This change was made to improve the ease of learning and understanding the libra
77
77
## New feature highlights
78
78
79
79
- State persistence - automatically save state and reload it when the app restarts. See [state persistence docs](docs/state-persistence)
80
-
- Transitions between screens in stack with headers and without headers now animates as expected on iOS. <https://github.com/react-navigation/react-navigation/pull/3821>. Thanks [skevy](https://github.com/skevy)!
80
+
- Transitions between screens in stack with headers and without headers now animates as expected on iOS. [#3821](https://github.com/react-navigation/react-navigation/pull/3821). Thanks [skevy](https://github.com/skevy)!
81
81
- As mentioned above, `createMaterialBottomNavigator` is a new navigator type that provides the material design bottom tab bar pattern.
Copy file name to clipboardExpand all lines: blog/2018-11-01-react-navigation-3.0-rc.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ First, install the library using your favorite package manager: `yarn add react-
23
23
24
24
Next, install react-native-gesture-handler. If you’re using Expo you don’t need to do anything here, it’s included in the SDK. Otherwise: `yarn add react-native-gesture-handler && react-native link`
25
25
26
-
Optionally, you can install react-native-screens. If you’re using Expo you don’t need to do anything here, it’s included in SDK 30 and higher. Otherwise, follow the instructions in the README on <https://github.com/kmagiera/react-native-screens>.
26
+
Optionally, you can install react-native-screens. If you’re using Expo you don’t need to do anything here, it’s included in SDK 30 and higher. Otherwise, follow the instructions in the README on [`react-native-screens`](https://github.com/software-mansion/react-native-screens).
27
27
28
28
> **Warning**: if you have manually installed any navigators in your project, for example react-navigation-material-bottom-tabs, you will need to update those to a version that is compatible with 3.0.0. In the case of react-navigation-material-bottom-tabs, 1.0.0-alpha.2 is compatible.
29
29
@@ -133,15 +133,15 @@ const Store = createStackNavigator({
133
133
- Basic support for hooks in `react-navigation-hooks`
134
134
-`headerBackgroundTransitionPreset: 'toggle' | 'fade' | 'translate'` lets you choose how to transition your custom `headerBackground` components between screens.
135
135
- Add options to opt in/out of the stack card overlay and shadow that are visible during transitions: `cardShadowEnabled` defaults to `true` and `cardOverlayEnabled` defaults to `false`.
136
-
- Export `StackGestureContext` and `DrawerGestureContext` from react-navigation-stack and react-navigation-drawer, so you can use the ref from the corresponding gestures with other gesture handlers (eg: <https://github.com/react-navigation/react-navigation-drawer/blob/bf4bdba7f6a4fbc12192f5d5ba2285f6280431b7/example/src/GestureInteraction.js>).
136
+
- Export `StackGestureContext` and `DrawerGestureContext` from react-navigation-stack and react-navigation-drawer, so you can use the ref from the corresponding gestures with other gesture handlers (eg: [GestureInteraction.js](https://github.com/react-navigation/react-navigation-drawer/blob/bf4bdba7f6a4fbc12192f5d5ba2285f6280431b7/example/src/GestureInteraction.js)).
137
137
138
138
## Assorted fixes & improvements
139
139
140
140
- Stack transition performance improved greatly by removing the shadow from the entire card and rendering it only on the slice where it is needed. The card opacity is also no longer directly animated but instead an overlay is put on top to create a similar effect but with better performance.
141
-
- Fix long-standing issues with stack that led to quietly re-mounting screens when navigating quickly in certain patterns: <https://github.com/react-navigation/react-navigation/issues/4155>
141
+
- Fix long-standing issues with stack that led to quietly re-mounting screens when navigating quickly in certain patterns: [react-navigation/issues/415](https://github.com/react-navigation/react-navigation/issues/4155)
142
142
- Support inverted gesture in modals.
143
143
- Stack card gesture uses react-native-gesture-handler and native driver so the gesture runs on the UI thread (except when the gesture ends, then it calls back to JS).
144
-
- Fix a variety of issues with drawer navigator, including issues around nesting (<https://github.com/react-navigation/react-navigation/issues/4154>) and bugs with firing open / close (eg: <https://github.com/react-navigation/react-navigation/issues/5146>).
144
+
- Fix a variety of issues with drawer navigator, including issues around nesting ([react-navigation/issues/4154](https://github.com/react-navigation/react-navigation/issues/4154)) and bugs with firing open / close (eg: [react-navigation/issues/5146](https://github.com/react-navigation/react-navigation/issues/5146)).
145
145
146
146
## Ecosystem and web support
147
147
@@ -215,4 +215,4 @@ See a simple web app with Create React App [here](https://github.com/react-navig
215
215
216
216
----------
217
217
218
-
Thanks for reading, please post any issues you encounter to <https://github.com/react-navigation/react-navigation/issues>!
218
+
Thanks for reading, please post any issues you encounter to [react-navigation/issues](https://github.com/react-navigation/react-navigation/issues)!
The documentation is now live at <https://reactnavigation.org>, and v2 lives [here](/docs/2.x/getting-started).
10
+
The documentation is now live at [reactnavigation.org](https://reactnavigation.org), and v2 lives [here](/docs/2.x/getting-started).
11
11
12
12
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).
13
13
@@ -23,7 +23,7 @@ First, install the library using your favorite package manager: `yarn add react-
23
23
24
24
Next, install react-native-gesture-handler. If you’re using Expo you don’t need to do anything here, it’s included in the SDK. Otherwise, follow [these installation instructions](https://kmagiera.github.io/react-native-gesture-handler/docs/getting-started.html#installation).
25
25
26
-
Optionally, you can install react-native-screens. If you’re using Expo you don’t need to do anything here, it’s included in SDK 30 and higher. Otherwise, follow the instructions in the README on <https://github.com/kmagiera/react-native-screens>.
26
+
Optionally, you can install react-native-screens. If you’re using Expo you don’t need to do anything here, it’s included in SDK 30 and higher. Otherwise, follow the instructions in the README on [`react-native-screens`](https://github.com/software-mansion/react-native-screens).
27
27
28
28
> **Warning**: if you have manually installed any navigators in your project, for example react-navigation-material-bottom-tabs, you will need to update those to a version that is compatible with 3.0.0. In the case of react-navigation-material-bottom-tabs, 1.0.0 is compatible.
29
29
@@ -150,16 +150,16 @@ const Store = createStackNavigator({
150
150
- Basic support for hooks in `react-navigation-hooks` (although this isn't too useful yet without a stable react-native build that supports hooks, you can play with it on the web!).
151
151
-`headerBackgroundTransitionPreset: 'toggle' | 'fade' | 'translate'` lets you choose how to transition your custom `headerBackground` components between screens.
152
152
- Add options to opt in/out of the stack card overlay and shadow that are visible during transitions: `cardShadowEnabled` defaults to `true` and `cardOverlayEnabled` defaults to `false`.
153
-
- Export `StackGestureContext` and `DrawerGestureContext` from react-navigation-stack and react-navigation-drawer, so you can use the ref from the corresponding gestures with other gesture handlers (eg: <https://github.com/react-navigation/react-navigation-drawer/blob/bf4bdba7f6a4fbc12192f5d5ba2285f6280431b7/example/src/GestureInteraction.js>).
153
+
- Export `StackGestureContext` and `DrawerGestureContext` from react-navigation-stack and react-navigation-drawer, so you can use the ref from the corresponding gestures with other gesture handlers (eg: [GestureInteraction.js](https://github.com/react-navigation/react-navigation-drawer/blob/bf4bdba7f6a4fbc12192f5d5ba2285f6280431b7/example/src/GestureInteraction.js)).
154
154
- Tab navigators support `tabBarOnLongPress` configuration option, which defaults to the same as the tab press event.
155
155
156
156
## Assorted fixes & improvements
157
157
158
158
- Stack transition performance improved greatly by removing the shadow from the entire card and rendering it only on the slice where it is needed. The card opacity is also no longer directly animated but instead an overlay is put on top to create a similar effect but with better performance.
159
-
- Fix long-standing issues with stack that led to quietly re-mounting screens when navigating quickly in certain patterns: <https://github.com/react-navigation/react-navigation/issues/4155>
159
+
- Fix long-standing issues with stack that led to quietly re-mounting screens when navigating quickly in certain patterns: [react-navigation/issues/4155](https://github.com/react-navigation/react-navigation/issues/4155)
160
160
- Support inverted gesture in modals.
161
161
- Stack card gesture uses react-native-gesture-handler and native driver so the gesture runs on the UI thread (except when the gesture ends, then it calls back to JS).
162
-
- Fix a variety of issues with drawer navigator, including issues around nesting (<https://github.com/react-navigation/react-navigation/issues/4154>) and bugs with firing open / close (eg: <https://github.com/react-navigation/react-navigation/issues/5146>).
162
+
- Fix a variety of issues with drawer navigator, including issues around nesting ([react-navigation/issues/4154](https://github.com/react-navigation/react-navigation/issues/4154)) and bugs with firing open / close (eg: [react-navigation/react-navigation/issues/5146](https://github.com/react-navigation/react-navigation/issues/5146)).
163
163
- Fix accessibility voiceover for tabs and stack back button.
164
164
165
165
## Ecosystem and web support
@@ -234,4 +234,4 @@ See a simple web app with Create React App [here](https://github.com/react-navig
234
234
235
235
---
236
236
237
-
Thanks for reading, please post any issues you encounter to <https://github.com/react-navigation/react-navigation/issues>!
237
+
Thanks for reading, please post any issues you encounter to [react-navigation/issues](https://github.com/react-navigation/react-navigation/issues)!
The documentation is now live at <https://reactnavigation.org>, and v3 lives [here](/docs/3.x/getting-started).
10
+
The documentation is now live at [reactnavigation.org](https://reactnavigation.org), and v3 lives [here](/docs/3.x/getting-started).
11
11
12
12
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.
13
13
@@ -29,4 +29,4 @@ If you're using TypeScript, navigator specific types were also removed from the
29
29
30
30
---
31
31
32
-
Thanks for reading, please post any issues you encounter to <https://github.com/react-navigation/react-navigation/issues>!
32
+
Thanks for reading, please post any issues you encounter to [react-navigation/issues](https://github.com/react-navigation/react-navigation/issues)!
Copy file name to clipboardExpand all lines: versioned_docs/version-1.x/stack-navigator.md
+1-2
Original file line number
Diff line number
Diff line change
@@ -62,8 +62,7 @@ Visual options:
62
62
*`fade-in-place` - Header components cross-fade without moving, similar to the Twitter, Instagram, and Facebook app for iOS. This is the default value.
63
63
*`uikit` - An approximation of the default behavior for iOS.
64
64
*`cardStyle` - Use this prop to override or extend the default style for an individual card in stack.
65
-
*`transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](
66
-
<https://github.com/react-navigation/react-navigation/blob/1.x/flow/react-navigation.js>)). Provided function will be passed the following arguments:
65
+
*`transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](https://github.com/react-navigation/react-navigation/blob/1.x/flow/react-navigation.js)). Provided function will be passed the following arguments:
67
66
*`transitionProps` - Transition props for the new screen.
68
67
*`prevTransitionProps` - Transitions props for the old screen.
69
68
*`isModal` - Boolean specifying if screen is modal.
Copy file name to clipboardExpand all lines: versioned_docs/version-2.x/custom-navigators.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -96,7 +96,7 @@ To help developers implement custom navigators, the following utilities are prov
96
96
97
97
### `createNavigator`
98
98
99
-
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: <https://v1.reactnavigation.org/docs/custom-navigators.html>
99
+
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: [v1.reactnavigation.org/docs/custom-navigators.html](https://v1.reactnavigation.org/docs/custom-navigators.html)
100
100
101
101
This utility combines a [router](routers.md) and a [navigation view](navigation-views.md) together in a standard way:
Copy file name to clipboardExpand all lines: versioned_docs/version-2.x/stack-navigator.md
+1-2
Original file line number
Diff line number
Diff line change
@@ -68,8 +68,7 @@ Visual options:
68
68
*`left` - Anchor the title to the left, near the back button or other left component. This is the default on Android. When used on iOS, the header back title is hidden. Content from the left component will overflow underneath the title, if you need to adjust this you can use `headerLeftContainerStyle` and `headerTitleContainerStyle`. Additionally, this alignment is incompatible with `headerTransitionPreset: 'uikit'`.
69
69
*`center` - Center the title, this is the default on iOS.
70
70
*`cardStyle` - Use this prop to override or extend the default style for an individual card in stack.
71
-
*`transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](
72
-
<https://github.com/react-navigation/react-navigation/blob/2.x/flow/react-navigation.js>)). Provided function will be passed the following arguments:
71
+
*`transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](https://github.com/react-navigation/react-navigation/blob/2.x/flow/react-navigation.js)). Provided function will be passed the following arguments:
73
72
*`transitionProps` - Transition props for the new screen.
74
73
*`prevTransitionProps` - Transitions props for the old screen.
75
74
*`isModal` - Boolean specifying if screen is modal.
Copy file name to clipboardExpand all lines: versioned_docs/version-3.x/custom-navigators.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -96,7 +96,7 @@ To help developers implement custom navigators, the following utilities are prov
96
96
97
97
### `createNavigator`
98
98
99
-
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: <https://v1.reactnavigation.org/docs/custom-navigators.html>
99
+
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: [v1.reactnavigation.org/docs/custom-navigators.html](https://v1.reactnavigation.org/docs/custom-navigators.html)
100
100
101
101
This utility combines a [router](routers.md) and a [navigation view](navigation-views.md) together in a standard way:
Copy file name to clipboardExpand all lines: versioned_docs/version-3.x/redux-integration.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Redux integration
4
4
sidebar_label: Redux integration
5
5
---
6
6
7
-
It is extremely easy to use Redux in an app with React Navigation. It's basically no different than without React Navigation. The following example shows how to do it end to end: <https://snack.expo.io/@react-navigation/redux-example>. The most important piece from it is the following:
7
+
It is extremely easy to use Redux in an app with React Navigation. It's basically no different than without React Navigation. The following example shows how to do it end to end: [snack.expo.io/@react-navigation/redux-example](https://snack.expo.io/@react-navigation/redux-example). The most important piece from it is the following:
Copy file name to clipboardExpand all lines: versioned_docs/version-3.x/stack-navigator.md
+1-2
Original file line number
Diff line number
Diff line change
@@ -72,8 +72,7 @@ Visual options:
72
72
*`cardStyle` - Use this prop to override or extend the default style for an individual card in stack.
73
73
*`cardShadowEnabled` - Use this prop to have visible shadows during transitions. Defaults to `true`
74
74
*`cardOverlayEnabled` - Use this prop to have visible stack card overlays during transitions. Defaults to `false`.
75
-
*`transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](
76
-
<https://github.com/react-navigation/react-navigation/blob/3.x/flow/react-navigation.js>)). Provided function will be passed the following arguments:
75
+
*`transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](https://github.com/react-navigation/react-navigation/blob/3.x/flow/react-navigation.js)). Provided function will be passed the following arguments:
77
76
*`transitionProps` - Transition props for the new screen.
78
77
*`prevTransitionProps` - Transitions props for the old screen.
79
78
*`isModal` - Boolean specifying if screen is modal.
Copy file name to clipboardExpand all lines: versioned_docs/version-4.x/custom-navigators.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -96,7 +96,7 @@ To help developers implement custom navigators, the following utilities are prov
96
96
97
97
### `createNavigator`
98
98
99
-
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: <https://v1.reactnavigation.org/docs/custom-navigators.html>
99
+
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: [v1.reactnavigation.org/docs/custom-navigators.html](https://v1.reactnavigation.org/docs/custom-navigators.html)
100
100
101
101
This utility combines a [router](routers.md) and a [navigation view](navigation-views.md) together in a standard way:
0 commit comments