From 26288ba2cfd26990f8a6ee47882412b640d4bbbb Mon Sep 17 00:00:00 2001 From: Me Date: Tue, 20 Oct 2015 00:32:34 +0100 Subject: [PATCH] Replacing function(e) with function(event) in docs for clarity --- .../app/components/pages/components/drop-down-menu.jsx | 2 +- .../src/app/components/pages/components/icon-menus.jsx | 4 ++-- docs/src/app/components/pages/components/left-nav.jsx | 2 +- docs/src/app/components/pages/components/lists.jsx | 8 ++++---- docs/src/app/components/pages/components/menus.jsx | 6 +++--- docs/src/app/components/pages/components/sliders.jsx | 10 +++++----- docs/src/app/components/pages/components/snackbar.jsx | 2 +- .../app/components/pages/components/text-fields.jsx | 6 +++--- .../app/components/pages/components/time-picker.jsx | 2 +- 9 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/src/app/components/pages/components/drop-down-menu.jsx b/docs/src/app/components/pages/components/drop-down-menu.jsx index 1988043a8588d3..98695057dce287 100644 --- a/docs/src/app/components/pages/components/drop-down-menu.jsx +++ b/docs/src/app/components/pages/components/drop-down-menu.jsx @@ -99,7 +99,7 @@ class DropDownMenuPage extends React.Component { infoArray: [ { name: 'onChange', - header: 'function(e, selectedIndex, menuItem)', + header: 'function(event, selectedIndex, menuItem)', desc: 'Fired when a menu item is clicked that is not the one currently ' + 'selected.' } diff --git a/docs/src/app/components/pages/components/icon-menus.jsx b/docs/src/app/components/pages/components/icon-menus.jsx index e5dc029ebbaac4..50712d4279c120 100644 --- a/docs/src/app/components/pages/components/icon-menus.jsx +++ b/docs/src/app/components/pages/components/icon-menus.jsx @@ -114,12 +114,12 @@ class IconMenus extends React.Component { infoArray: [ { name: 'onItemTouchTap', - header: 'function(e, item)', + header: 'function(event, item)', desc: 'Fired when a menu item is touchTapped.' }, { name: 'onChange', - header: 'function(e, value)', + header: 'function(event, value)', desc: 'Fired when a menu item is touchTapped and the menu item value ' + 'is not equal to the current menu value.' } diff --git a/docs/src/app/components/pages/components/left-nav.jsx b/docs/src/app/components/pages/components/left-nav.jsx index 1237143e2ba37c..99049c6cd792e9 100644 --- a/docs/src/app/components/pages/components/left-nav.jsx +++ b/docs/src/app/components/pages/components/left-nav.jsx @@ -118,7 +118,7 @@ class LeftNavPage extends React.Component { infoArray: [ { name: 'onChange', - header: 'function(e, selectedIndex, menuItem)', + header: 'function(event, selectedIndex, menuItem)', desc: 'Fired when a menu item is clicked that is not the one currently ' + 'selected. Note that this requires the injectTapEventPlugin component. ' + 'See the "Get Started" section for more detail.' diff --git a/docs/src/app/components/pages/components/lists.jsx b/docs/src/app/components/pages/components/lists.jsx index 67d3c08498550b..074c27b2b4773a 100644 --- a/docs/src/app/components/pages/components/lists.jsx +++ b/docs/src/app/components/pages/components/lists.jsx @@ -177,19 +177,19 @@ class ListsPage extends React.Component { infoArray: [ { name: 'onKeyboardFocus', - type: 'function(e, isKeyboardFocused)', + type: 'function(event, isKeyboardFocused)', header: 'optional', desc: 'Called when the ListItem has keyboard focus.' }, { name: 'onMouseLeave', - type: 'function(e)', + type: 'function(event)', header: 'optional', desc: 'Called when the mouse is no longer over the ListItem.' }, { name: 'onMouseEnter', - type: 'function(e)', + type: 'function(event)', header: 'optional', desc: 'Called when the mouse is over the ListItem.' }, @@ -201,7 +201,7 @@ class ListsPage extends React.Component { }, { name: 'onTouchStart', - type: 'function(e)', + type: 'function(event)', header: 'optional', desc: 'Called when touches start.' }, diff --git a/docs/src/app/components/pages/components/menus.jsx b/docs/src/app/components/pages/components/menus.jsx index d1a93623398f02..9f2873b0adc540 100644 --- a/docs/src/app/components/pages/components/menus.jsx +++ b/docs/src/app/components/pages/components/menus.jsx @@ -165,17 +165,17 @@ class MenusPage extends React.Component { infoArray: [ { name: 'onEscKeyDown', - header: 'function(e)', + header: 'function(event)', desc: 'Fired when an Esc key is keyed down.' }, { name: 'onItemTouchTap', - header: 'function(e, item)', + header: 'function(event, item)', desc: 'Fired when a menu item is touchTapped.' }, { name: 'onChange', - header: 'function(e, value)', + header: 'function(event, value)', desc: 'Fired when a menu item is touchTapped and the menu item value ' + 'is not equal to the current menu value.' } diff --git a/docs/src/app/components/pages/components/sliders.jsx b/docs/src/app/components/pages/components/sliders.jsx index aa587d0b83bf49..1ac089fa43ae8e 100644 --- a/docs/src/app/components/pages/components/sliders.jsx +++ b/docs/src/app/components/pages/components/sliders.jsx @@ -92,32 +92,32 @@ class SlidersPage extends React.Component { infoArray: [ { name: 'onBlur', - type: 'function(e)', + type: 'function(event)', header: 'optional', desc: 'Callback function that is fired when the focus has left the slider.' }, { name: 'onChange', - type: 'function(e, value)', + type: 'function(event, value)', header: 'optional', desc: 'Callback function that is fired when the user changes the ' + 'slider\'s value.' }, { name: 'onDragStart', - type: 'function(e)', + type: 'function(event)', header: 'optional', desc: 'Callback function that is fired when the slider has begun to move.' }, { name: 'onDragStop', - type: 'function(e)', + type: 'function(event)', header: 'optional', desc: 'Callback function that is fried when teh slide has stopped moving.' }, { name: 'onFocus', - type: 'function(e)', + type: 'function(event)', header: 'optional', desc: 'Callback fired when the user has focused on the slider.' }, diff --git a/docs/src/app/components/pages/components/snackbar.jsx b/docs/src/app/components/pages/components/snackbar.jsx index a5274c730d21f2..3955a568310c34 100644 --- a/docs/src/app/components/pages/components/snackbar.jsx +++ b/docs/src/app/components/pages/components/snackbar.jsx @@ -75,7 +75,7 @@ class SnackbarPage extends React.Component { infoArray: [ { name: 'onActionTouchTap', - header: 'function(e)', + header: 'function(event)', desc: 'Fired when the action button is touchtapped.' }, { diff --git a/docs/src/app/components/pages/components/text-fields.jsx b/docs/src/app/components/pages/components/text-fields.jsx index fedb0d0934f7a7..8e3ecf22209ef4 100644 --- a/docs/src/app/components/pages/components/text-fields.jsx +++ b/docs/src/app/components/pages/components/text-fields.jsx @@ -188,19 +188,19 @@ let TextFieldsPage = React.createClass({ infoArray: [ { name: 'onBlur', - header: 'function(e)', + header: 'function(event)', desc: 'Callback function that is fired when the textfield loses' + 'focus.' }, { name: 'onChange', - header: 'function(e)', + header: 'function(event)', desc: 'Callback function that is fired when the textfield\'s value ' + 'changes.' }, { name: 'onFocus', - header: 'function(e)', + header: 'function(event)', desc: 'Callback function that is fired when the textfield gains ' + 'focus.' }, diff --git a/docs/src/app/components/pages/components/time-picker.jsx b/docs/src/app/components/pages/components/time-picker.jsx index d243a7ba9b63e8..d32e97000c1ce6 100644 --- a/docs/src/app/components/pages/components/time-picker.jsx +++ b/docs/src/app/components/pages/components/time-picker.jsx @@ -79,7 +79,7 @@ let TimePickerPage = React.createClass({ }, { name: 'onFocus', - header: 'function(e)', + header: 'function(event)', desc: 'Callback function that is fired when the timepicker field ' + 'gains focus.' },