Merge pull request mui#1930 from mbrookes/master

[Doc] Replacing function(e) with function(event) in docs for clarity
tyfoo · Oct 20, 2015 · 35d7e93 · 35d7e93
2 parents 72aa406 + 26288ba
commit 35d7e93
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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.'
           },