Update docs

Author: mjackson

docs/api/README.md

@@ -12,15 +12,14 @@ React Router API
   - [`RouteHandler`](/docs/api/components/RouteHandler.md)
   - [`Routes`](/docs/api/components/Routes.md)
 
-- Misc 
-  - [`transition`](/docs/api/misc/transition.md)
-
 - Mixins
   - [`ActiveState`](/docs/api/mixins/ActiveState.md)
   - [`AsyncState`](/docs/api/mixins/AsyncState.md)
-  - [`PathState`](/docs/api/mixins/PathState.md)
-  - [`RouteLookup`](/docs/api/mixins/RouteLookup.md)
-  - [`Transitions`](/docs/api/mixins/Transitions.md)
+  - [`CurrentPath`](/docs/api/mixins/CurrentPath.md)
+  - [`Navigation`](/docs/api/mixins/Navigation.md)
+
+- Misc 
+  - [`transition`](/docs/api/misc/transition.md)
 
 Public Modules
 --------------

docs/api/misc/Location.md

@@ -7,11 +7,9 @@ following methods must be implemented:
 Methods
 -------
 
-### `setup(onChange)`
+### `setup()`
 
-Called when the router is first setup. Whenever an external actor should
-cause the router to react, call `onChange` (for example, on
-`window.hashchange`).
+Called when the router is first setup.
 
 ### `teardown`
 
@@ -30,10 +28,6 @@ another.
 
 Called when the router attempts to go back one entry in the history.
 
-### `getCurrentPath`
-
-Should return the current path as a string.
-
 ### `toString`
 
 Should return a useful string for logging and debugging.
@@ -47,7 +41,7 @@ implementations in this repository.
 ```js
 var MyLocation = {
 
-  setup: function (onChange) {},
+  setup: function () {},
 
   teardown: function () {},
 
@@ -57,10 +51,7 @@ var MyLocation = {
 
   pop: function () {},
 
-  getCurrentPath: function () {},
-
   toString: function () {}
 
 };
 ```
-

docs/api/mixins/ActiveState.md

@@ -7,17 +7,22 @@ query that are currently active (like links).
 Instance Methods
 ----------------
 
-### `isActive(routeName, params, query)`
+### `getActiveRoutes()`
 
-Returns `true` if a route, params, and query are active, `false`
-otherwise.
+Returns an array of the `<Route>`s that are currently active.
+
+### `getActiveParams()`
+
+Returns a hash of the currently active URL params.
+
+### `getActiveQuery()`
 
-Lifecycle Methods
------------------
+Returns a hash of the currently active query params.
 
-### `updateActiveState`
+### `isActive(routeName, params, query)`
 
-Called when the active state changes.
+Returns `true` if a route, params, and query are active, `false`
+otherwise.
 
 Example
 -------
@@ -26,25 +31,16 @@ Let's say you are using bootstrap and want to get `active` on those `li`
 tags for the Tabs:
 
 ```js
-var Link = require('react-router/Link');
-var ActiveState = require('react-router/ActiveState');
+var Link = require('react-router').Link;
+var ActiveState = require('react-router').ActiveState;
 
 var Tab = React.createClass({
 
   mixins: [ ActiveState ],
 
-  getInitialState: function () {
-    return { isActive: false };
-  },
-
-  updateActiveState: function () {
-    this.setState({
-      isActive: this.isActive(this.props.to, this.props.params, this.props.query)
-    })
-  },
-
   render: function() {
-    var className = this.state.isActive ? 'active' : '';
+    var isActive = this.isActive(this.props.to, this.props.params, this.props.query);
+    var className = isActive ? 'active' : '';
     var link = Link(this.props);
     return <li className={className}>{link}</li>;
   }
@@ -55,4 +51,3 @@ var Tab = React.createClass({
 // with an automatic `active` class on both.
 <Tab to="foo">Foo</Tab>
 ```
-

docs/api/mixins/CurrentPath.md

@@ -0,0 +1,27 @@
+API: `CurrentPath` (mixin)
+==========================
+
+A mixin for components that need to know the current URL path.
+
+Instance Methods
+----------------
+
+### `getCurrentPath()`
+
+Returns the current URL path.
+
+Example
+-------
+
+```js
+var CurrentPath = require('react-router').CurrentPath;
+
+var ShowThePath = React.createClass({
+  mixins: [ CurrentPath ],
+  render: function () {
+    return (
+      <div>The current path is: {this.getCurrentPath()}</div>
+    );
+  }
+});
+```

docs/api/mixins/Transitions.md renamed to docs/api/mixins/Navigation.md

@@ -1,7 +1,7 @@
-API: `Transitions` (mixin)
+API: `Navigation` (mixin)
 ==========================
 
-A mixin for components that need to initiate transitions to other routes.
+A mixin for components that need to create URLs and/or initiate transitions to other routes.
 
 Instance Methods
 ----------------
@@ -43,6 +43,10 @@ entry from the browser history.
 this.goBack();
 ```
 
+### `makePath(routeName, params, query)`
+
+Creates a URL path to a route.
+
 ### `makeHref(routeName, params, query)`
 
 Creates an `href` to a route. Use this along with `ActiveState` when you
@@ -60,8 +64,10 @@ Example
 -------
 
 ```js
+var Navigation = require('react-router').Navigation;
+
 React.createClass({
-  mixins: [Transitions],
+  mixins: [Navigation],
 
   whenever: function() {
     this.transitionTo('something');
@@ -70,4 +76,3 @@ React.createClass({
   }
 });
 ```
-