make-event-props
Advanced tools
Comparing version 1.3.0 to 1.4.0
@@ -20,2 +20,3 @@ // As defined on the list of supported events: https://reactjs.org/docs/events.html | ||
export var allEvents = [].concat(clipboardEvents, compositionEvents, keyboardEvents, focusEvents, formEvents, genericEvents, mouseEvents, pointerEvents, selectionEvents, touchEvents, uiEvents, wheelEvents, mediaEvents, imageEvents, animationEvents, transitionEvents, otherEvents); | ||
/** | ||
@@ -27,4 +28,3 @@ * Returns an object with on-event callback props curried with provided args. | ||
*/ | ||
var makeEventProps = function makeEventProps(props, getArgs) { | ||
export default function makeEventProps(props, getArgs) { | ||
var eventProps = {}; | ||
@@ -35,3 +35,2 @@ allEvents.forEach(function (eventName) { | ||
} | ||
if (!getArgs) { | ||
@@ -41,3 +40,2 @@ eventProps[eventName] = props[eventName]; | ||
} | ||
eventProps[eventName] = function (event) { | ||
@@ -48,4 +46,2 @@ return props[eventName](event, getArgs(eventName)); | ||
return eventProps; | ||
}; | ||
export default makeEventProps; | ||
} |
{ | ||
"name": "make-event-props", | ||
"version": "1.3.0", | ||
"version": "1.4.0", | ||
"description": "Returns an object with on-event callback props curried with provided args.", | ||
"main": "dist/umd/index.js", | ||
"main": "dist/cjs/index.js", | ||
"module": "dist/esm/index.js", | ||
@@ -10,11 +10,11 @@ "source": "src/index.js", | ||
"scripts": { | ||
"build": "yarn build-esm && yarn build-umd", | ||
"build": "yarn build-esm && yarn build-cjs", | ||
"build-esm": "BABEL_ENV=production-esm babel src -d dist/esm --ignore \"**/*.spec.js\"", | ||
"build-umd": "BABEL_ENV=production-umd babel src -d dist/umd --ignore \"**/*.spec.js\"", | ||
"build-cjs": "BABEL_ENV=production-cjs babel src -d dist/cjs --ignore \"**/*.spec.js\"", | ||
"clean": "rimraf dist", | ||
"jest": "jest", | ||
"jest-coverage": "jest --coverage", | ||
"lint": "eslint src/ --ext .jsx,.js", | ||
"lint": "eslint .", | ||
"prepack": "yarn clean && yarn build", | ||
"test": "yarn lint && yarn jest" | ||
"prettier": "prettier --check . --cache", | ||
"test": "yarn lint && yarn prettier && yarn jest" | ||
}, | ||
@@ -35,5 +35,8 @@ "keywords": [ | ||
"@babel/preset-env": "^7.15.0", | ||
"eslint": "~7.19.0", | ||
"eslint-config-wojtekmaj": "^0.5.0", | ||
"jest": "^27.0.0", | ||
"eslint": "^8.26.0", | ||
"eslint-config-wojtekmaj": "^0.7.1", | ||
"husky": "^8.0.0", | ||
"jest": "^29.0.0", | ||
"prettier": "^2.7.0", | ||
"pretty-quick": "^3.1.0", | ||
"rimraf": "^3.0.0" | ||
@@ -45,6 +48,4 @@ }, | ||
"files": [ | ||
"LICENSE", | ||
"README.md", | ||
"dist/", | ||
"src/" | ||
"dist", | ||
"src" | ||
], | ||
@@ -55,3 +56,4 @@ "repository": { | ||
}, | ||
"funding": "https://github.com/wojtekmaj/make-event-props?sponsor=1" | ||
"funding": "https://github.com/wojtekmaj/make-event-props?sponsor=1", | ||
"packageManager": "yarn@3.1.0" | ||
} |
@@ -1,6 +0,5 @@ | ||
[![npm](https://img.shields.io/npm/v/make-event-props.svg)](https://www.npmjs.com/package/make-event-props) ![downloads](https://img.shields.io/npm/dt/make-event-props.svg) [![CI](https://github.com/wojtekmaj/make-event-props/workflows/CI/badge.svg)](https://github.com/wojtekmaj/make-event-props/actions) ![dependencies](https://img.shields.io/david/wojtekmaj/make-event-props.svg | ||
) ![dev dependencies](https://img.shields.io/david/dev/wojtekmaj/make-event-props.svg | ||
) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest) | ||
[![npm](https://img.shields.io/npm/v/make-event-props.svg)](https://www.npmjs.com/package/make-event-props) ![downloads](https://img.shields.io/npm/dt/make-event-props.svg) [![CI](https://github.com/wojtekmaj/make-event-props/workflows/CI/badge.svg)](https://github.com/wojtekmaj/make-event-props/actions) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest) | ||
# Make-Event-Props | ||
A function that, given props, returns an object of event callback props optionally curried with additional arguments. | ||
@@ -11,19 +10,20 @@ | ||
## tl;dr | ||
* Install by executing `npm install make-event-props` or `yarn add make-event-props`. | ||
* Import by adding `import makeEventProps from 'make-event-props'`. | ||
* Create your event props object: | ||
```js | ||
get eventProps() { | ||
return makeEventProps(this.props, (eventName) => additionalArgs); | ||
} | ||
``` | ||
* Use your event props: | ||
```js | ||
render() { | ||
return ( | ||
<div {...this.eventProps} /> | ||
); | ||
} | ||
``` | ||
- Install by executing `npm install make-event-props` or `yarn add make-event-props`. | ||
- Import by adding `import makeEventProps from 'make-event-props'`. | ||
- Create your event props object: | ||
```js | ||
get eventProps() { | ||
return makeEventProps(this.props, (eventName) => additionalArgs); | ||
} | ||
``` | ||
- Use your event props: | ||
```js | ||
render() { | ||
return ( | ||
<div {...this.eventProps} /> | ||
); | ||
} | ||
``` | ||
## License | ||
@@ -30,0 +30,0 @@ |
@@ -8,4 +8,34 @@ // As defined on the list of supported events: https://reactjs.org/docs/events.html | ||
export const genericEvents = ['onError', 'onLoad']; | ||
export const mouseEvents = ['onClick', 'onContextMenu', 'onDoubleClick', 'onDrag', 'onDragEnd', 'onDragEnter', 'onDragExit', 'onDragLeave', 'onDragOver', 'onDragStart', 'onDrop', 'onMouseDown', 'onMouseEnter', 'onMouseLeave', 'onMouseMove', 'onMouseOut', 'onMouseOver', 'onMouseUp']; | ||
export const pointerEvents = ['onPointerDown', 'onPointerMove', 'onPointerUp', 'onPointerCancel', 'onGotPointerCapture', 'onLostPointerCapture', 'onPointerEnter', 'onPointerLeave', 'onPointerOver', 'onPointerOut']; | ||
export const mouseEvents = [ | ||
'onClick', | ||
'onContextMenu', | ||
'onDoubleClick', | ||
'onDrag', | ||
'onDragEnd', | ||
'onDragEnter', | ||
'onDragExit', | ||
'onDragLeave', | ||
'onDragOver', | ||
'onDragStart', | ||
'onDrop', | ||
'onMouseDown', | ||
'onMouseEnter', | ||
'onMouseLeave', | ||
'onMouseMove', | ||
'onMouseOut', | ||
'onMouseOver', | ||
'onMouseUp', | ||
]; | ||
export const pointerEvents = [ | ||
'onPointerDown', | ||
'onPointerMove', | ||
'onPointerUp', | ||
'onPointerCancel', | ||
'onGotPointerCapture', | ||
'onLostPointerCapture', | ||
'onPointerEnter', | ||
'onPointerLeave', | ||
'onPointerOver', | ||
'onPointerOut', | ||
]; | ||
export const selectionEvents = ['onSelect']; | ||
@@ -15,3 +45,27 @@ export const touchEvents = ['onTouchCancel', 'onTouchEnd', 'onTouchMove', 'onTouchStart']; | ||
export const wheelEvents = ['onWheel']; | ||
export const mediaEvents = ['onAbort', 'onCanPlay', 'onCanPlayThrough', 'onDurationChange', 'onEmptied', 'onEncrypted', 'onEnded', 'onError', 'onLoadedData', 'onLoadedMetadata', 'onLoadStart', 'onPause', 'onPlay', 'onPlaying', 'onProgress', 'onRateChange', 'onSeeked', 'onSeeking', 'onStalled', 'onSuspend', 'onTimeUpdate', 'onVolumeChange', 'onWaiting']; | ||
export const mediaEvents = [ | ||
'onAbort', | ||
'onCanPlay', | ||
'onCanPlayThrough', | ||
'onDurationChange', | ||
'onEmptied', | ||
'onEncrypted', | ||
'onEnded', | ||
'onError', | ||
'onLoadedData', | ||
'onLoadedMetadata', | ||
'onLoadStart', | ||
'onPause', | ||
'onPlay', | ||
'onPlaying', | ||
'onProgress', | ||
'onRateChange', | ||
'onSeeked', | ||
'onSeeking', | ||
'onStalled', | ||
'onSuspend', | ||
'onTimeUpdate', | ||
'onVolumeChange', | ||
'onWaiting', | ||
]; | ||
export const imageEvents = ['onLoad', 'onError']; | ||
@@ -23,6 +77,19 @@ export const animationEvents = ['onAnimationStart', 'onAnimationEnd', 'onAnimationIteration']; | ||
export const allEvents = [ | ||
...clipboardEvents, ...compositionEvents, ...keyboardEvents, ...focusEvents, ...formEvents, | ||
...genericEvents, ...mouseEvents, ...pointerEvents, ...selectionEvents, ...touchEvents, | ||
...uiEvents, ...wheelEvents, ...mediaEvents, ...imageEvents, ...animationEvents, | ||
...transitionEvents, ...otherEvents, | ||
...clipboardEvents, | ||
...compositionEvents, | ||
...keyboardEvents, | ||
...focusEvents, | ||
...formEvents, | ||
...genericEvents, | ||
...mouseEvents, | ||
...pointerEvents, | ||
...selectionEvents, | ||
...touchEvents, | ||
...uiEvents, | ||
...wheelEvents, | ||
...mediaEvents, | ||
...imageEvents, | ||
...animationEvents, | ||
...transitionEvents, | ||
...otherEvents, | ||
]; | ||
@@ -36,3 +103,3 @@ | ||
*/ | ||
const makeEventProps = (props, getArgs) => { | ||
export default function makeEventProps(props, getArgs) { | ||
const eventProps = {}; | ||
@@ -54,4 +121,2 @@ | ||
return eventProps; | ||
}; | ||
export default makeEventProps; | ||
} |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
265
15040
10