Update README.md

This commit is contained in:
Krzysztof Magiera
2018-09-12 16:52:14 +02:00
committed by GitHub
parent 4b6843d561
commit fecfa1f4b2

View File

@@ -4,7 +4,7 @@ This project aims to expose native navigation container components to React Nati
## Usage with [react-navigation](https://github.com/react-navigation/react-navigation)
Screens support is currently built into [stack navigator](https://reactnavigation.org/docs/en/stack-navigator.html). We plan on adding it to other navigators in near future.
Screens support is built into [stack navigator](https://reactnavigation.org/docs/en/stack-navigator.html) starting from version [2.14.0](https://github.com/react-navigation/react-navigation/releases/tag/2.14.0) of [react-navigation](https://github.com/react-navigation/react-navigation). We plan on adding it to other navigators in near future.
To enable stack navigator to use screens instead of plain RN Views for rendering stack cards follow the steps below:
@@ -29,8 +29,9 @@ useScreens();
Note that the above code need to execute before first render of a navigation screen. You can check Example's app [App.js](https://github.com/kmagiera/react-native-screens/blob/master/Example/App.js#L16) file as a reference.
4. Make sure that the version of (react-navigation)[https://github.com/react-navigation/react-navigation] you are using is 2.14.0 or higher
4. You are all set 🎉  when screens are enabled in your application code react-navigation will automatically use them instead of relying on plain React Native Views.
5. You are all set 🎉  when screens are enabled in your application code react-navigation will automatically use them instead of relying on plain React Native Views.
## Guide for navigation library authors