Merge remote-tracking branch 'origin/master' into next

Author: timdorr

.babelrc

@@ -1,7 +1,14 @@
 {
-  "stage": 0,
-  "loose": "all",
-  "plugins": [
-    "dev-expression"
-  ]
+  "presets": ["stage-0", "react"],
+  "plugins": ["dev-expression"],
+
+  "env": {
+    "cjs": {
+      "presets": ["es2015-loose"],
+      "plugins": ["add-module-exports"]
+    },
+    "es": {
+      "presets": ["es2015-loose-native-modules"]
+    }
+  }
 }

CHANGES.md

@@ -1,10 +1,15 @@
-## [HEAD]
-> Unreleased
+## [v2.3.0]
+> April 18, 2016
 
-- **Feature:** Added `applyRouterMiddleware` ([#3327])
+- **Feature:** Add `applyRouterMiddleware` for extending router rendering ([#3327])
+- **Feature/Deprecation:** Add `routerShape` and `locationShape` as top-level exported prop types, and deprecate all the old prop types, including the ones that were previously incorrectly removed ([#3349])
+- **Minor:** Move ES module build back to `es6/` to avoid breaking people who were incorrectly importing from `react-router/es6` ([#3334])
 
-[HEAD]: https://github.com/reactjs/react-router/compare/v2.2.4...master
+[v2.3.0]: https://github.com/reactjs/react-router/compare/v2.2.4...v2.3.0
 [#3327]: https://github.com/reactjs/react-router/issues/3327
+[#3334]: https://github.com/reactjs/react-router/issues/3334
+[#3349]: https://github.com/reactjs/react-router/issues/3349
+
 
 ## [v2.2.4]
 > April 15, 2016

docs/API.md

@@ -165,12 +165,67 @@ An `<IndexLink>` is like a [`<Link>`](#link), except it is only active when the
 ### `<RouterContext>`
 A `<RouterContext>` renders the component tree for a given router state. Its used by `<Router>` but also useful for server rendering and integrating in brownfield development.
 
-It also provides a `router` object on `context`.
+It also provides a `router` object on [context](https://facebook.github.io/react/docs/context.html).
 
 #### `context.router`
 
 Contains data and methods relevant to routing. Most useful for imperatively transitioning around the application.
 
+To use it, you must signal to React that you need it by declaring your use of it in your component via `contextTypes`:
+
+```js
+var MyComponent = React.createClass({
+  contextTypes: {
+    router: routerShape.isRequired
+  },
+
+  render: function() {
+    // Here, you can use this.context.router.
+  }
+})
+```
+
+To use `context.router` on a component declared as an ES2015 class, define `contextTypes` as a static property of the class:
+
+```js
+class MyComponent extends React.Component {
+  render() {
+    // Here, you can use this.context.router.
+  }
+}
+
+MyComponent.contextTypes = {
+  router: routerShape.isRequired
+}
+```
+
+If you are using the class properties proposal, you can instead write:
+
+```js
+class MyComponent extends React.Component {
+  static contextTypes = {
+    router: routerShape.isRequired
+  }
+
+  render() {
+    // Here, you can use this.context.router.
+  }
+}
+```
+
+To use `context.router` with
+[stateless function components](https://facebook.github.io/react/docs/reusable-components.html#stateless-functions), declare `contextTypes` as a static property of the component function:
+
+```js
+function MyComponent(props, context) {
+  // Here, you can use context.router.
+}
+
+MyComponent.contextTypes = {
+  router: routerShape.isRequired
+}
+```
+
 ##### `push(pathOrLoc)`
 Transitions to a new URL, adding a new entry in the browser history.
 
@@ -639,14 +694,11 @@ One or many [`<Route>`](#route)s or [`PlainRoute`](#plainroute)s.
 
 
 ### `PropTypes`
-The following objects are exposed as properties of the exported PropTypes object:
-- `falsy`: Checks that a component does not have a prop
-- `history`
-- `location`
-- `component`
-- `components`
-- `route`
-- `routes`
+The following prop types are exported at top level and from `react-router/lib/PropTypes`:
+- `routerShape`: Shape for the `router` object on context
+- `locationShape`: Shape for the `location` object on route component props
+
+Previously, a number of prop types intended for internal use were also exported under `PropTypes`. These are deprecated and should not be used.
 
 
 ### `useRoutes(createHistory)` (deprecated)

docs/Glossary.md

@@ -231,6 +231,7 @@ A *route pattern* (or "path") is a string that describes a portion of a URL. Pat
   - `:paramName` – matches a URL segment up to the next `/`, `?`, or `#`. The matched string is called a [param](#params)
   - `()` – Wraps a portion of the URL that is optional
   - `*` – Matches all characters (non-greedy) up to the next character in the pattern, or to the end of the URL if there is none, and creates a `splat` [param](#params)
+  - `**` - Matches all characters (greedy) until the next `/`, `?`, or `#` and creates a `splat` [param](#params)
 
 Route patterns are relative to the pattern of the parent route unless they begin with a `/`, in which case they begin matching at the beginning of the URL.
 

docs/Troubleshooting.md

@@ -6,7 +6,7 @@ You need to add `router` to your component's `contextTypes` to make the router o
 
 ```js
 contextTypes: {
-  router: Router.PropTypes.router
+  router: routerShape.isRequired
 }
 ```
 

docs/guides/ConfirmingNavigation.md

@@ -6,7 +6,7 @@ You can prevent a transition from happening or prompt the user before leaving a
 const Home = React.createClass({
 
   contextTypes: {
-    router: Router.PropTypes.router
+    router: routerShape.isRequired
   },
 
   componentDidMount() {

examples/auth-flow-async-with-query-params/app.js

@@ -1,6 +1,8 @@
-import React, { createClass, PropTypes } from 'react'
+import React, { createClass } from 'react'
 import { render } from 'react-dom'
-import { Router, Route, IndexRoute, browserHistory, Link } from 'react-router'
+import {
+  Router, Route, IndexRoute, browserHistory, Link, routerShape
+} from 'react-router'
 
 function App(props) {
   return (
@@ -12,7 +14,7 @@ function App(props) {
 
 const Form = createClass({
   contextTypes: {
-    router: PropTypes.object.isRequired
+    router: routerShape.isRequired
   },
 
   getInitialState() {

examples/auth-flow/app.js

@@ -1,6 +1,6 @@
 import React from 'react'
 import { render } from 'react-dom'
-import { browserHistory, Router, Route, Link } from 'react-router'
+import { browserHistory, Router, Route, Link, routerShape } from 'react-router'
 import auth from './auth'
 
 const App = React.createClass({
@@ -58,7 +58,7 @@ const Dashboard = React.createClass({
 const Login = React.createClass({
 
   contextTypes: {
-    router: React.PropTypes.object.isRequired
+    router: routerShape.isRequired
   },
 
   getInitialState() {

examples/confirming-navigation/app.js

@@ -1,6 +1,6 @@
 import React from 'react'
 import { render } from 'react-dom'
-import { browserHistory, Router, Route, Link } from 'react-router'
+import { browserHistory, Router, Route, Link, routerShape } from 'react-router'
 
 const App = React.createClass({
   render() {
@@ -24,7 +24,7 @@ const Dashboard = React.createClass({
 
 const Form = React.createClass({
   contextTypes: {
-    router: React.PropTypes.object.isRequired
+    router: routerShape.isRequired
   },
 
   componentWillMount() {

examples/master-detail/app.js

@@ -1,6 +1,8 @@
 import React from 'react'
 import { render, findDOMNode } from 'react-dom'
-import { browserHistory, Router, Route, IndexRoute, Link } from 'react-router'
+import {
+  browserHistory, Router, Route, IndexRoute, Link, routerShape
+} from 'react-router'
 import ContactStore from './ContactStore'
 import './app.css'
 
@@ -63,7 +65,7 @@ const Index = React.createClass({
 
 const Contact = React.createClass({
   contextTypes: {
-    router: React.PropTypes.object.isRequired
+    router: routerShape.isRequired
   },
 
   getStateFromStore(props) {
@@ -120,7 +122,7 @@ const Contact = React.createClass({
 
 const NewContact = React.createClass({
   contextTypes: {
-    router: React.PropTypes.object.isRequired
+    router: routerShape.isRequired
   },
 
   createContact(event) {