README-prerelease.md

PRERELEASE v3

This documentation is for the new v3 release which unifies the 4.x and 5.x APIs of react-navigation in a single codebase. You can install it using yarn add react-navigation-shared-element@prerelease.

React Navigation Shared Element

React Navigation bindings for react-native-shared-element 💫

Documentation

• Shared element for React Navigation 5.x
• Shared element for React Navigation 4.x
• Migration guide

Compatibility

The following versions or react-navigation and the stack navigator are supported.

Version	React-Navigation	Comments
3.x	4 & 5	Use createSharedElementStackNavigator4 to use it with 4.x. In this version the sharedElements function was changed to use route instead of navigator.
2.x	3 & 4	This version is compatible with react-navigation-stack@2.
1.x	3 & 4	This version is compatible with react-navigation-stack@1.

Unlikely to be supported:

• react-native-screens/createNativeStackNavigator

Demo App

• ./example
• react-navigation-shared-element-demo

Videos

• Airbnb Shared Transition - “Can it be done in React Native?”

License

React navigation shared element library is licensed under The MIT License.