make createRouterHistory composable

particularly to pass along options to useBaseName
and useQueries

Author: ryanflorence

modules/__tests__/useRouterHistory-test.js

@@ -0,0 +1,23 @@
+import assert from 'assert'
+import expect from 'expect'
+import useRouterHistory from '../useRouterHistory'
+import createHistory from 'history/lib/createMemoryHistory'
+
+describe('useRouterHistory', function () {
+  it('adds backwards compatibility flag', function () {
+    const history = useRouterHistory(createHistory)()
+    expect(history.__v2_compatible__).toBe(true)
+  })
+
+  it('passes along options, especially query parsing', function (done) {
+    const history = useRouterHistory(createHistory)({
+      stringifyQuery() {
+        assert(true)
+        done()
+      }
+    })
+
+    history.push({ pathname: '/', query: { test: true } })
+  })
+})
+

modules/browserHistory.js

@@ -1,4 +1,4 @@
-import createRouterHistory from './createRouterHistory'
+import useRouterHistory from './useRouterHistory'
 import createBrowserHistory from 'history/lib/createBrowserHistory'
 
-export default createRouterHistory(createBrowserHistory)
+export default useRouterHistory(createBrowserHistory)()

modules/createRouterHistory.js

@@ -1,5 +1,5 @@
-import createRouterHistory from './createRouterHistory'
+import useRouterHistory from './useRouterHistory'
 import createHashHistory from 'history/lib/createHashHistory'
 
-export default createRouterHistory(createHashHistory)
+export default useRouterHistory(createHashHistory)()
 

modules/hashHistory.js

@@ -20,6 +20,7 @@ export { createRoutes } from './RouteUtils'
 export RouterContext from './RouterContext'
 export PropTypes from './PropTypes'
 export match from './match'
+export useRouterHistory from './useRouterHistory'
 
 /* histories */
 export browserHistory from './browserHistory'

modules/index.js

@@ -0,0 +1,10 @@
+import useQueries from 'history/lib/useQueries'
+import useBasename from 'history/lib/useBasename'
+
+export default function useRouterHistory(createHistory) {
+  return function (options) {
+    const history = useBasename(useQueries(createHistory))(options)
+    history.__v2_compatible__ = true
+    return history
+  }
+}

modules/useRouterHistory.js

@@ -222,3 +222,22 @@ const RouteComponent = React.createClass({
 })
 ```
 
+## Custom Query String Parsing
+
+```js
+// v1.x
+<Router
+  parseQueryString={parse}
+  stringifyQueryString={stringify}
+/>
+
+// v2.0.0
+import { useRouterHistory } from 'react-router'
+
+const appHistory = useRouterHistory({
+  parseQueryString: parse,
+  stringifyQueryString: stringify
+})
+
+<Router history={appHistory}/>
+