Merge pull request react-bootstrap#1183 from insin/button-type-docs

Document Button's default type attribute
vasdhara · Aug 20, 2015 · c73f458 · c73f458
2 parents 34784b4 + 9cd2db0
commit c73f458
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/generate-metadata.js b/docs/generate-metadata.js
@@ -64,6 +64,11 @@ function applyPropDoclets(props, propName){
   if ( doclets.required) {
     prop.required = true;
   }
+
+  // Use @defaultValue to provide a prop's default value
+  if (doclets.defaultValue) {
+    prop.defaultValue = cleanDocletValue(doclets.defaultValue);
+  }
 }
 
 

diff --git a/src/Button.js b/src/Button.js
@@ -22,6 +22,7 @@ const Button = React.createClass({
     /**
      * Defines HTML button type Attribute
      * @type {("button"|"reset"|"submit")}
+     * @defaultValue 'button'
      */
     type: React.PropTypes.oneOf(ButtonInput.types)
   },