[changed] State -> IsActive

docs/IsActive.md

@@ -0,0 +1,37 @@
+# IsActive Mixin
+
+Provides `isActive` to a component.
+
+## Methods
+
+### `isActive(pathname, query)`
+
+Returns `true` or `false` depending on if the current path is active.
+Will be true for every route in the route branch matched by the
+`pathname` (child route is active, therefore parent is too).
+
+## Example
+
+Let's say you are using bootstrap and want to get `active` on those `li`
+tags for the Tabs:
+
+```js
+import { Link, IsActive } from 'react-router';
+
+let Tab = React.createClass({
+
+  mixins: [ IsActive ],
+
+  render() {
+    let isActive = this.isActive(this.props.to, this.props.query);
+    let className = isActive ? 'active' : '';
+    return <li className={className}><Link {...this.props}/></li>;
+  }
+
+});
+
+// use it just like <Link/>, and you'll get an anchor wrapped in an `li`
+// with an automatic `active` class on both.
+<Tab href="foo">Foo</Tab>
+```
+

docs/README.md

@@ -14,5 +14,7 @@
   - [Plain Route](Plain Route.md)
   - [Redirect](Redirect.md)
   - [Link](Link.md)
+  - [Navigation](Navigation.md)
+  - [IsActive](IsActive.md)
 
 - [Server Rendering](ServerRendering.md)

modules/State.js → modules/IsActiveMixin.js

@@ -3,15 +3,15 @@ import React from 'react';
 var { object } = React.PropTypes;
 
 /**
- * The State mixin provides components with an isActive(pathname, query)
+ * The IsActive mixin provides components with an isActive(pathname, query)
  * method they can use to check if a given pathname/query are active.
  *
  * Example:
  *
- *   import { State } from 'react-router';
+ *   import { IsActive } from 'react-router';
  *
  *   var AboutLink = React.createClass({
- *     mixins: [ State ],
+ *     mixins: [ IsActive ],
  *     render() {
  *       var className = this.props.className;
  *
@@ -22,7 +22,7 @@ var { object } = React.PropTypes;
  *     }
  *   });
  */
-var State = {
+var IsActive = {
 
   contextTypes: {
     history: object.isRequired
@@ -34,4 +34,4 @@ var State = {
 
 };
 
-export default State;
+export default IsActive;

modules/index.js

@@ -11,7 +11,7 @@ export Route from './Route';
 export Lifecycle from './Lifecycle';
 export Navigation from './Navigation';
 export RouteContext from './RouteContext';
-export State from './State';
+export IsActive from './IsActiveMixin';
 
 /* utils */
 export useRoutes from './useRoutes';