Skip to content

Commit

Permalink
Merge pull request #3676 from theosherry/FlatButton_docs
Browse files Browse the repository at this point in the history
[FlatButton] add callback signatures to docs
  • Loading branch information
oliviertassinari committed Mar 13, 2016
2 parents 1f27ae0 + 8ab7114 commit ae1342a
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions src/flat-button.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -75,22 +75,31 @@ const FlatButton = React.createClass({
linkButton: React.PropTypes.bool,

/**
* Called when element is focused by the keyboard.
* Callback function fired when the element is focused or blurred by the keyboard.
*
* @param {object} event `focus` or `blur` event targeting the element.
* @param {boolean} isKeyboardFocused Indicates whether the element is focused.
*/
onKeyboardFocus: React.PropTypes.func,

/**
* Called when the mouse enters the element.
* Callback function fired when the mouse enters the element.
*
* @param {object} event `mouseenter` event targeting the element.
*/
onMouseEnter: React.PropTypes.func,

/**
* Called when the mouse leaves the element.
* Callback function fired when the mouse leaves the element.
*
* @param {object} event `mouseleave` event targeting the element.
*/
onMouseLeave: React.PropTypes.func,

/**
* Called when a touch event is started inside the element.
* Callback function fired when the element is touched.
*
* @param {object} event `touchstart` event targeting the element.
*/
onTouchStart: React.PropTypes.func,

Expand Down

0 comments on commit ae1342a

Please sign in to comment.