Add example to doc comment

roycehaynes · Oct 7, 2014 · 360a00d · 360a00d
1 parent 0813090
commit 360a00d
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/modules/mixins/ActiveState.js b/modules/mixins/ActiveState.js
@@ -3,6 +3,20 @@ var React = require('react');
 /**
  * A mixin for components that need to know the routes, URL
  * params and query that are currently active.
+ *
+ * Example:
+ *
+ *   var AboutLink = React.createClass({
+ *     mixins: [ Router.ActiveState ],
+ *     render: function () {
+ *       var className = this.props.className;
+ *   
+ *       if (this.isActive('about'))
+ *         className += ' is-active';
+ *   
+ *       return React.DOM.a({ className: className }, this.props.children);
+ *     }
+ *   });
  */
 var ActiveState = {