terribleplan/next.js
1
0
Fork 0
mirror of https://github.com/terribleplan/next.js.git synced 2024-01-19 02:48:18 +00:00
Code Issues Releases Wiki Activity

Rephrase url deprecation text and add link to next-codemod (#4649)

Browse source 
* Rephrase url deprecation text and add link to next-codemod

* Clean up double words
This commit is contained in:
Tim Neutkens 2018-06-22 14:21:28 +02:00 committed by GitHub
parent 6cba9fa511
commit 3ae9f877a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
errors/url-deprecated.md
View file

@ -2,11 +2,18 @@
#### Why This Error Occurred
In version prior to 6.x `url` got magically injected into every page component, since this is confusing and can now be added by the user using a custom `_app.js` we have deprecated this feature. To be removed in Next.js 7.0
In versions prior to 6.x the `url` property got magically injected into every `Page` component (every page inside the `pages` directory).
The reason this is going away is that we want to make things very predictable and explicit. Having a magical url property coming out of nowhere doesn't aid that goal.
#### Possible Ways to Fix It
The easiest way to get the same values that `url` had is to use `withRouter`:
https://github.com/zeit/next-codemod#url-to-withrouter
Since Next 5 we provide a way to explicitly inject the Next.js router object into pages and all their decending components.
The `router` property that is injected will hold the same values as `url`, like `pathname`, `asPath`, and `query`.
Here's an example of using `withRouter`:
```js
import { withRouter } from 'next/router'
@ -21,3 +28,7 @@ class Page extends React.Component {
export default withRouter(Page)
```
We provide a codemod (a code to code transformation) to automatically change the `url` property usages to `withRouter`.
You can find this codemod and instructions on how to run it here: https://github.com/zeit/next-codemod#url-to-withrouter

2
readme.md
View file

@ -1704,7 +1704,7 @@ Please see our [contributing.md](./contributing.md)
## Authors
- Arunoda Susiripala ([@arunoda](https://twitter.com/arunoda)) – [ZEIT](https://zeit.co)
- Tim Neutkens ([@timneutkens](https://github.com/timneutkens)) – [ZEIT](https://zeit.co)
- Tim Neutkens ([@timneutkens](https://twitter.com/timneutkens)) – [ZEIT](https://zeit.co)
- Naoyuki Kanezawa ([@nkzawa](https://twitter.com/nkzawa)) – [ZEIT](https://zeit.co)
- Tony Kovanen ([@tonykovanen](https://twitter.com/tonykovanen)) – [ZEIT](https://zeit.co)
- Guillermo Rauch ([@rauchg](https://twitter.com/rauchg)) – [ZEIT](https://zeit.co)