Expanded API docs for context.router

[Download]

Explain usage of context.router for:

• Components created with React.createClass
• Components created with ES classes extending React.Component
• Components created as stateless functions

[timdorr]

To keep consistent with the other docs, can you make this router: Router.PropTypes.router?

[taion]

@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'

?

[timdorr]

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.

[taion]

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.

[Download]

To keep consistent with the other docs, can you make this router: Router.PropTypes.router?

Yes, will do.

[timdorr]

Thanks for the updates!

[Download]

Great, thanks for merging it! 👍

[taion]

This isn't part of ES6.

[Download]

Are you talking about the static keyword?

[taion]

Yeah; I'll update this part, just waiting to see where we got with #3349.

[ryanflorence]

Yeah, that's just a proposal right now.

[Download]

Good point. I forgot about that. Babel makes using more experimental features very easy :)

[ryanflorence]

This has me thinking we should make a withRouter higher-order component.

import { withRouter } from 'react-router'
withRouter(createClass | ES class | function)

// in the component
this.props.router

Then, it'll all be the same. This also shields apps from context changes in the future.

[taion]

👍 I'm going to clean up these docs a bit, then cut 2.3.0.