Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add onTouchTap documentation for FlatButton #6147

Merged
merged 5 commits into from
Feb 17, 2017
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/FlatButton/FlatButton.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,15 @@ class FlatButton extends Component {
onMouseLeave: PropTypes.func,
/** @ignore */
onTouchStart: PropTypes.func,
/**
* Callback function for when the element is selected via a touch tap.
Copy link
Member

@oliviertassinari oliviertassinari Feb 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of the time, we follow that template:

    /**
     * Callback function fired when the button is touch-tapped.
     *
     * @param {object} event TouchTap event targeting the button.
     */
    onTouchTap: PropTypes.func,

* @param {object} event `TouchTap` event targeting the button.
*/
onTouchTap: PropTypes.func,
/**
* If true, colors button according to
* primaryTextColor from the Theme.
*/
*/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oups

primary: PropTypes.bool,
/**
* Color for the ripple after button is clicked.
Expand Down