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] Don't document standard DOM events #4433

Merged
merged 1 commit into from
Jun 12, 2016
Merged
Show file tree
Hide file tree
Changes from all 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
16 changes: 3 additions & 13 deletions src/AutoComplete/AutoComplete.js
Original file line number Diff line number Diff line change
Expand Up @@ -118,21 +118,11 @@ class AutoComplete extends Component {
* Override style for menu.
*/
menuStyle: PropTypes.object,
/**
* Callback function that is fired when the `TextField` loses focus.
*
* @param {object} event `blur` event targeting the `TextField`.
*/
/** @ignore */
onBlur: PropTypes.func,
/**
* Callback function that is fired when the `TextField` gains focus.
*
* @param {object} event `focus` event targeting the `TextField`.
*/
/** @ignore */
onFocus: PropTypes.func,
/**
* Callback function that is fired when the `TextField` receives a keydown event.
*/
/** @ignore */
onKeyDown: PropTypes.func,
/**
* Callback function that is fired when a list item is selected, or enter is pressed in the `TextField`.
Expand Down
2 changes: 0 additions & 2 deletions src/DatePicker/DatePicker.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,6 @@ class DatePicker extends Component {
onDismiss: PropTypes.func,
/**
* Callback function that is fired when the Date Picker's `TextField` gains focus.
*
* @param {object} event `focus` event targeting the `TextField`.
*/
onFocus: PropTypes.func,
/**
Expand Down
18 changes: 3 additions & 15 deletions src/FlatButton/FlatButton.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,23 +69,11 @@ class FlatButton extends Component {
* @param {boolean} isKeyboardFocused Indicates whether the element is focused.
*/
onKeyboardFocus: PropTypes.func,
/**
* Callback function fired when the mouse enters the element.
*
* @param {object} event `mouseenter` event targeting the element.
*/
/** @ignore */
onMouseEnter: PropTypes.func,
/**
* Callback function fired when the mouse leaves the element.
*
* @param {object} event `mouseleave` event targeting the element.
*/
/** @ignore */
onMouseLeave: PropTypes.func,
/**
* Callback function fired when the element is touched.
*
* @param {object} event `touchstart` event targeting the element.
*/
/** @ignore */
onTouchStart: PropTypes.func,
/**
* If true, colors button according to
Expand Down
36 changes: 6 additions & 30 deletions src/FloatingActionButton/FloatingActionButton.js
Original file line number Diff line number Diff line change
Expand Up @@ -107,41 +107,17 @@ class FloatingActionButton extends Component {
* If true, the button will be a small floating action button.
*/
mini: PropTypes.bool,
/**
* Callback function fired when a mouse button is pressed down on the element.
*
* @param {object} event `mousedown` event targeting the element.
*/
/** @ignore */
onMouseDown: PropTypes.func,
/**
* Callback function fired when the mouse enters the element.
*
* @param {object} event `mouseenter` event targeting the element.
*/
/** @ignore */
onMouseEnter: PropTypes.func,
/**
* Callback function fired when the mouse leaves the element.
*
* @param {object} event `mouseleave` event targeting the element.
*/
/** @ignore */
onMouseLeave: PropTypes.func,
/**
* Callback function fired when a mouse button is released on the element.
*
* @param {object} event `mouseup` event targeting the element.
*/
/** @ignore */
onMouseUp: PropTypes.func,
/**
* Callback function fired when a touch point is removed from the element.
*
* @param {object} event `touchend` event targeting the element.
*/
/** @ignore */
onTouchEnd: PropTypes.func,
/**
* Callback function fired when the element is touched.
*
* @param {object} event `touchstart` event targeting the element.
*/
/** @ignore */
onTouchStart: PropTypes.func,
/**
* If true, the button will use the secondary button colors.
Expand Down
12 changes: 2 additions & 10 deletions src/FontIcon/FontIcon.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,9 @@ class FontIcon extends Component {
* This is the icon color when the mouse hovers over the icon.
*/
hoverColor: PropTypes.string,
/**
* Callback function fired when the mouse enters the element.
*
* @param {object} event `mouseenter` event targeting the element.
*/
/** @ignore */
onMouseEnter: PropTypes.func,
/**
* Callback function fired when the mouse leaves the element.
*
* @param {object} event `mouseleave` event targeting the element.
*/
/** @ignore */
onMouseLeave: PropTypes.func,
/**
* Override the inline-styles of the root element.
Expand Down
29 changes: 5 additions & 24 deletions src/IconButton/IconButton.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,9 @@ class IconButton extends Component {
* Override the inline-styles of the icon element.
*/
iconStyle: PropTypes.object,
/**
* Callback function fired when the element loses focus.
* @param {object} event `blur` event targeting the element.
*/
/** @ignore */
onBlur: PropTypes.func,
/**
* Callback function fired when the element gains focus.
* @param {object} event `focus` event targeting the element.
*/
/** @ignore */
onFocus: PropTypes.func,
/**
* Callback function fired when the element is focused or blurred by the keyboard.
Expand All @@ -90,24 +84,11 @@ class IconButton extends Component {
* @param {boolean} keyboardFocused Indicates whether the element is focused.
*/
onKeyboardFocus: PropTypes.func,
/**
* Callback function fired when the mouse enters the element.
*
* @param {object} event `mouseenter` event targeting the element.
*/
/** @ignore */
onMouseEnter: PropTypes.func,
/**
* Callback function fired when the mouse leaves the element.
*
* @param {object} event `mouseleave` event targeting the element.
*/
/** @ignore */
onMouseLeave: PropTypes.func,
/**
* Callback function fired when the mouse leaves the element. Unlike `onMouseLeave`,
* this callback will fire on disabled icon buttons.
*
* @param {object} event `mouseout` event targeting the element.
*/
/** @ignore */
onMouseOut: PropTypes.func,
/**
* Override the inline-styles of the root element.
Expand Down
24 changes: 4 additions & 20 deletions src/IconMenu/IconMenu.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,29 +55,13 @@ class IconMenu extends Component {
* @param {boolean} keyboardFocused If true, the `IconButton` element is focused.
*/
onKeyboardFocus: PropTypes.func,
/**
* Callback function fired when a mouse button is pressed down on the `IconButton` element.
*
* @param {object} event `mousedown` event targeting the `IconButton` element.
*/
/** @ignore */
onMouseDown: PropTypes.func,
/**
* Callback function fired when the mouse enters the `IconButton` element.
*
* @param {object} event `mouseenter` event targeting the `IconButton` element.
*/
/** @ignore */
onMouseEnter: PropTypes.func,
/**
* Callback function fired when the mouse leaves the `IconButton` element.
*
* @param {object} event `mouseleave` event targeting the `IconButton` element.
*/
/** @ignore */
onMouseLeave: PropTypes.func,
/**
* Callback function fired when a mouse button is released on the `IconButton` element.
*
* @param {object} event `mouseup` event targeting the `IconButton` element.
*/
/** @ignore */
onMouseUp: PropTypes.func,
/**
* Callback function fired when the `open` state of the menu is requested to be changed.
Expand Down
24 changes: 4 additions & 20 deletions src/List/ListItem.js
Original file line number Diff line number Diff line change
Expand Up @@ -213,35 +213,19 @@ class ListItem extends Component {
* @param {boolean} isKeyboardFocused If true, the `ListItem` is focused.
*/
onKeyboardFocus: PropTypes.func,
/**
* Callback function fired when the mouse enters the `ListItem`.
*
* @param {object} event `mouseenter` event targeting the `ListItem`.
*/
/** @ignore */
onMouseEnter: PropTypes.func,
/**
* Callback function fired when the mouse leaves the `ListItem`.
*
* @param {object} event `mouseleave` event targeting the `ListItem`.
*/
/** @ignore */
onMouseLeave: PropTypes.func,
/**
* Callbak function fired when the `ListItem` toggles its nested list.
*
* @param {object} listItem The `ListItem`.
*/
onNestedListToggle: PropTypes.func,
/**
* Callback function fired when the `ListItem` is touched.
*
* @param {object} event `touchstart` event targeting the `ListItem`.
*/
/** @ignore */
onTouchStart: PropTypes.func,
/**
* Callback function fired when the `ListItem` is touch-tapped.
*
* @param {object} event TouchTap event targeting the `ListItem`.
*/
/** @ignore */
onTouchTap: PropTypes.func,
/**
* This is the block element that contains the primary text.
Expand Down
7 changes: 1 addition & 6 deletions src/Menu/Menu.js
Original file line number Diff line number Diff line change
Expand Up @@ -136,12 +136,7 @@ class Menu extends Component {
* @param {number} index The index of the menu item.
*/
onItemTouchTap: PropTypes.func,
/**
* Callback function fired when the menu is focused and a key
* is pressed.
*
* @param {object} event `keydown` event targeting the menu.
*/
/** @ignore */
onKeyDown: PropTypes.func,
/**
* This is the placement of the menu relative to the `IconButton`.
Expand Down
37 changes: 6 additions & 31 deletions src/RaisedButton/RaisedButton.js
Original file line number Diff line number Diff line change
Expand Up @@ -176,42 +176,17 @@ class RaisedButton extends Component {
* Override the inline-styles of the button's label element.
*/
labelStyle: PropTypes.object,
/**
* Callback function fired when a mouse button is pressed down on
* the element.
*
* @param {object} event `mousedown` event targeting the element.
*/
/** @ignore */
onMouseDown: PropTypes.func,
/**
* Callback function fired when the mouse enters the element.
*
* @param {object} event `mouseenter` event targeting the element.
*/
/** @ignore */
onMouseEnter: PropTypes.func,
/**
* Callback function fired when the mouse leaves the element.
*
* @param {object} event `mouseleave` event targeting the element.
*/
/** @ignore */
onMouseLeave: PropTypes.func,
/**
* Callback function fired when a mouse button is released on the element.
*
* @param {object} event `mouseup` event targeting the element.
*/
/** @ignore */
onMouseUp: PropTypes.func,
/**
* Callback function fired when a touch point is removed from the element.
*
* @param {object} event `touchend` event targeting the element.
*/
/** @ignore */
onTouchEnd: PropTypes.func,
/**
* Callback function fired when the element is touched.
*
* @param {object} event `touchstart` event targeting the element.
*/
/** @ignore */
onTouchStart: PropTypes.func,
/**
* If true, the button will use the theme's primary color.
Expand Down
12 changes: 2 additions & 10 deletions src/SelectField/SelectField.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,7 @@ class SelectField extends Component {
* Override the inline-styles of the underlying `DropDownMenu` element.
*/
menuStyle: PropTypes.object,
/**
* Callback function fired when the select field loses focus.
*
* @param {object} event `blur` event targeting the select field.
*/
/** @ignore */
onBlur: PropTypes.func,
/**
* Callback function fired when a menu item is selected.
Expand All @@ -103,11 +99,7 @@ class SelectField extends Component {
* @param {any} payload The `value` prop of the selected menu item.
*/
onChange: PropTypes.func,
/**
* Callback function fired when the select field gains focus.
*
* @param {object} event `focus` event targeting the select field.
*/
/** @ignore */
onFocus: PropTypes.func,
/**
* Override the inline-styles of the underlying `DropDownMenu` element.
Expand Down
8 changes: 2 additions & 6 deletions src/Slider/Slider.js
Original file line number Diff line number Diff line change
Expand Up @@ -188,9 +188,7 @@ class Slider extends Component {
* of an input element.
*/
name: PropTypes.string,
/**
* Callback function that is fired when the focus has left the slider.
*/
/** @ignore */
onBlur: PropTypes.func,
/**
* Callback function that is fired when the user changes the slider's value.
Expand All @@ -204,9 +202,7 @@ class Slider extends Component {
* Callback function that is fried when the slide has stopped moving.
*/
onDragStop: PropTypes.func,
/**
* Callback fired when the user has focused on the slider.
*/
/** @ignore */
onFocus: PropTypes.func,
/**
* Whether or not the slider is required in a form.
Expand Down
18 changes: 3 additions & 15 deletions src/Stepper/StepButton.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,11 @@ class StepButton extends Component {
PropTypes.string,
PropTypes.number,
]),
/**
* Callback function fired when the mouse enters the element.
*
* @param {object} event `mouseenter` event targeting the element.
*/
/** @ignore */
onMouseEnter: PropTypes.func,
/**
* Callback function fired when the mouse leaves the element.
*
* @param {object} event `mouseleave` event targeting the element.
*/
/** @ignore */
onMouseLeave: PropTypes.func,
/**
* Callback function fired when the element is touched.
*
* @param {object} event `touchstart` event targeting the element.
*/
/** @ignore */
onTouchStart: PropTypes.func,
/**
* Override the inline-style of the root element.
Expand Down
Loading