Expanded API docs for context.router
#3346
Conversation
Explain usage of `context.router` for: * Components created with `React.createClass` * Components created with ES classes extending `React.Component` * Components created as stateless functions
| ```js | ||
| var MyComponent = React.createClass({ | ||
| contextTypes: { | ||
| router: React.PropTypes.object.isRequired |
There was a problem hiding this comment.
To keep consistent with the other docs, can you make this router: Router.PropTypes.router?
There was a problem hiding this comment.
@timdorr wdyt of renaming this to routerShape so users can just do
import { routerShape } from 'react-router'without any issues with collisions, or having to do e.g.
import { * as Router } from 'react-router'?
There was a problem hiding this comment.
We'd have to do that on next. But we can completely overhaul/redo the prop types at that point, so it's whatever we want it to be.
There was a problem hiding this comment.
We can do the deprecations/&c. in place. I have them on #3349, and I think it'd be a good fix to get in place for 2.3.0.
There was a problem hiding this comment.
To keep consistent with the other docs, can you make this router: Router.PropTypes.router?
Yes, will do.
* Replaced occurances of `React.PropTypes.object.isRequired` with `Router.PropTypes.router` * Expanded abbreviation 'i.c.w' to 'in combination with' remix-run#3346
|
Thanks for the updates! |
|
Great, thanks for merging it! 👍 |
|
|
||
| ```js | ||
| class MyComponent extends React.Component { | ||
| static contextTypes = { |
There was a problem hiding this comment.
Are you talking about the static keyword?
There was a problem hiding this comment.
Yeah; I'll update this part, just waiting to see where we got with #3349.
There was a problem hiding this comment.
Yeah, that's just a proposal right now.
There was a problem hiding this comment.
Good point. I forgot about that. Babel makes using more experimental features very easy :)
|
This has me thinking we should make a import { withRouter } from 'react-router'
withRouter(createClass | ES class | function)
// in the component
this.props.routerThen, it'll all be the same. This also shields apps from context changes in the future. |
|
👍 I'm going to clean up these docs a bit, then cut 2.3.0. |
Explain usage of
context.routerfor:React.createClassReact.Component