From 8ab7114b27d90d38b2e26026588dde74919877c0 Mon Sep 17 00:00:00 2001 From: theosherry Date: Sat, 12 Mar 2016 19:00:24 -0500 Subject: [PATCH] [FlatButton] add callback signatures to docs --- src/flat-button.jsx | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/src/flat-button.jsx b/src/flat-button.jsx index 39eb899933981a..c5440b5d7c90f3 100644 --- a/src/flat-button.jsx +++ b/src/flat-button.jsx @@ -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,