Releases: remix-run/react-router
v2.1.1
v2.1.0
v2.0.1
v2.0.0
Goals
You might enjoy reading this issue: #2646
- Clear up the coupling between History and Router with simpler APIs.
- Provide cleaner integrations with other libraries like Redux, Relay, Async Props etc.
- Stop providing API that conceals usage of
context
. It is now a documented feature of React so developers using Router can implement their own opinions on how best to use context: Mixins, higher-order components, decorators, etc. React Router no longer has an opinion, but instead uses the lowest level feature of React. This project wants to be an incredibly useful routing library and doesn't want to get hung up on best-practice patterns for getting stuff from up top to down low. - Draw a clean line between what goes to Route Components as
props
and what goes oncontext
.
For a lot of apps this upgrade might look like API churn. Underneath the hood there are significant differences that make integrating with the rest of the React ecosystem more straightforward. Thanks for your continued patience and support as we all build this tool together. It's hard to imagine the top-level API changing much after this. But if it does, rest assured we are committed to ...
Backwards Compatibility and Deprecation Warnings
This has been a community project from the start, we need your help making the upgrade as smooth as possible for everybody!
We have done our best to provide backwards compatibility with deprecated APIs. If you drop in v2.x into a v1.x application and it doesn't run, then there is a bug. Please open an issue when you discover what the problem is so we can get a fix out.
The deprecation warnings should also lead you to the relevant part of this document. If one doesn't, please open a pull request with a fix. Also, if any part of this document could be improved, please let us know how. Confound it, our bias is often inescapable!
Upgrade Automatically with Codemods
Using a tool called jscodeshift, we have made available some codemods for upgrading your code to the new APIs automatically: https://github.com/rackt/rackt-codemod
A codemod is much like Babel, but instead of converting your ES2015 code to ES5 compatible syntax, it does a limited set of transformations on function names, arguments, common patterns and more. One way to think of jscodeshift (the underlying tool) is "jQuery for code". These codemods aren't bulletproof, so be sure to test your code after you run them. But they can help with upgrading a large codebase to remove deprecation warnings you're now triggering.
Changes since rc6
- Add back basename support in
match
(#3054)
v2.0.0-rc6
v2.0.0-rc5
v2.0.0-rc4
- Also do not create a
hashHistory
on the server.
v2.0.0-rc3
rc2 hit an NPM packaging bug. This is a repackaging with one fix included:
Changes
- Rebuilt with
history
correctly included. - Don’t create
browserHistory
on the server
v2.0.0-rc2
Read the fancy upgrade guide.
Changes
Lots of stuff! Here's the summary.
- Added
render
prop toRouter
- Added singleton
browserHistory
andhashHistory
- Added
createMemoryHistory
- Deprecated all mixins
- Replaced
context.history
withcontext.router
- Deprecated Route Component
props.history
- Deprecated
context.location
v2.0.0-rc1
Don't worry about it. See v2.0.0-rc2 instead!