#240

Changed prop name to "disableIfShiftIsPressed" and updated the api doc

Author: carlosfpo

docs/api.md

@@ -27,14 +27,15 @@ Contextmenu Trigger Component
 
 #### PropTypes
 
-| Property      | Type                    | Required? | Default | Description                                                                                                                                                                                                                                     |
-|---------------|-------------------------|-----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| id            | String                  | ✓         |         | The unique identifier of the menu to be called.                                                                                                                                                                                                 |
-| attributes    | Object                  |           |         | The attributes will be passed directly passed to the root element of component. Use this to customize it like adding custom classes, adding `colspan` etc.                                                                                      |
-| collect       | Function                |           |         | A simple function which takes `props` as input and returns the data to be passed to contextmenu.                                                                                                                                                  |
-| disable       | Boolean                 |           | `false` | Prop to ignore right clicks and display the default browser context menu.                                                                                                                                                                       |
-| holdToDisplay | Number                  |           | `1000`  | This is applicable only for touch screens. The time (in ms) for which, user has to hold down his/her finger before the menu is shown.  **Note:** To disable the long press trigger on left-click just set a negative holdToDisplay value such as `-1` |
-| renderTag     | String or React Element |           |         | The element inside which the Component must be wrapped. By default `div` is used. But this prop can used to customize it.                                                                                                                         |
+| Property                | Type                    | Required? | Default | Description                                                                                                                                                                                                                                     |
+|-------------------------|-------------------------|-----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| id                      | String                  | ✓         |         | The unique identifier of the menu to be called.                                                                                                                                                                                                 |
+| attributes              | Object                  |           |         | The attributes will be passed directly passed to the root element of component. Use this to customize it like adding custom classes, adding `colspan` etc.                                                                                      |
+| collect                 | Function                |           |         | A simple function which takes `props` as input and returns the data to be passed to contextmenu.                                                                                                                                                  |
+| disable                 | Boolean                 |           | `false` | Prop to ignore right clicks and display the default browser context menu.                                                                                                                                                                       |
+| holdToDisplay           | Number                  |           | `1000`  | This is applicable only for touch screens. The time (in ms) for which, user has to hold down his/her finger before the menu is shown.  **Note:** To disable the long press trigger on left-click just set a negative holdToDisplay value such as `-1` |
+| renderTag               | String or React Element |           |         | The element inside which the Component must be wrapped. By default `div` is used. But this prop can used to customize it.                                                                                                                         |
+| disableIfShiftIsPressed | Boolean                 |           | `false` | If true and shift is pressed, it will open the native browser context menu and ignore this custom component |
 
 ### `<MenuItem />`
 

src/ContextMenuTrigger.js

@@ -20,7 +20,7 @@ export default class ContextMenuTrigger extends Component {
             PropTypes.node,
             PropTypes.func
         ]),
-        disableOnShiftPressed: PropTypes.bool
+        disableIfShiftIsPressed: PropTypes.bool
     };
 
     static defaultProps = {
@@ -31,7 +31,7 @@ export default class ContextMenuTrigger extends Component {
         renderTag: 'div',
         posX: 0,
         posY: 0,
-        disableOnShiftPressed: false
+        disableIfShiftIsPressed: false
     };
 
     touchHandled = false;
@@ -96,7 +96,7 @@ export default class ContextMenuTrigger extends Component {
 
     handleContextClick = (event) => {
         if (this.props.disable) return;
-        if (this.props.disableOnShiftPressed && event.shiftKey) return;
+        if (this.props.disableIfShiftIsPressed && event.shiftKey) return;
 
         event.preventDefault();
         event.stopPropagation();