UNPKG

react-router

Version:
54 lines (35 loc) 1.24 kB
API: `ActiveState` (mixin) ========================== A mixin for components that need to know about the routes, params, and query that are currently active (like links). Instance Methods ---------------- ### `getActiveRoutes()` Returns an array of the `<Route>`s that are currently active. ### `getActiveParams()` Returns a hash of the currently active URL params. ### `getActiveQuery()` Returns a hash of the currently active query params. ### `isActive(routeName, params, query)` Returns `true` if a route, params, and query are active, `false` otherwise. Example ------- 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 Tab = React.createClass({ mixins: [ ActiveState ], render: function() { 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>; } }); // use it just like <Link/>, and you'll get an anchor wrapped in an `li` // with an automatic `active` class on both. <Tab to="foo">Foo</Tab> ```