{"_id":"@alzintani/superevents","_rev":"4-be0c355bb4cc0926e65449d506d34dcc","name":"@alzintani/superevents","dist-tags":{"latest":"0.2.2"},"versions":{"0.1.0":{"name":"@alzintani/superevents","version":"0.1.0","description":"JavaScript library that handling any events in websites.","main":"gulpfile.js","scripts":{"start":"gulp watch","build":"gulp build","test":"test"},"repository":{"type":"git","url":"git+https://github.com/alzintani/SuperEvents.git"},"keywords":["JavaScript","Events","Scroll","Click","Hover"],"author":{"name":"Hassan Matooq"},"license":"MIT","bugs":{"url":"https://github.com/alzintani/SuperEvents/issues"},"homepage":"https://github.com/alzintani/SuperEvents#readme","devDependencies":{"@babel/core":"^7.8.7","@babel/plugin-proposal-class-properties":"^7.8.3","@babel/plugin-proposal-private-methods":"^7.8.3","@babel/preset-env":"^7.8.7","comment-parser":"^0.7.2","express":"^4.17.1","gulp":"^4.0.2","gulp-babel":"^8.0.0","gulp-header":"^2.0.9","gulp-include":"^2.4.1","gulp-minify":"^3.1.0","gulp-notify":"^3.2.0","gulp-pug":"^4.0.1","gulp-rename":"^2.0.0","gulp-sass":"^4.0.2"},"gitHead":"a798ab464592564b3d7522f60d492b66ee63aecc","_id":"@alzintani/superevents@0.1.0","_nodeVersion":"13.3.0","_npmVersion":"6.12.1","dist":{"integrity":"sha512-DkVwSxJCmR9fhIwdjD9JExzt645AxI4X4vzDDQD43wKMSqMlzCOM3g9AHfkMeubKHldvwTpcRIGK5srNA92zvA==","shasum":"13e1badf7bc1a5f7d6ac5c93d82a0d8bbd8aeb8a","tarball":"https://registry.npmjs.org/@alzintani/superevents/-/superevents-0.1.0.tgz","fileCount":45,"unpackedSize":262542,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJejVXaCRA9TVsSAnZWagAAIgsP/jQ3Ql13UsBGnvtyR43G\nq3i0p2O04grq0Y9zdDS2K0f7YY4F63I4/MPvIC92c+IkOz+LIN1mJApW76fA\nyI6S8uYyv0cKUKXi9Df/hrwA9XFBJJ0AEy1UYcU9Sq0tZvcKfHfEQ/tXDNDD\nAh4LkqQpI7OFFc/K4IZR+PcTBhCos+h8KiAU3hd8ijgr8KqOVPkpMB/tleQo\nShWiBts0S10n/wz+bV8U1AEiGg+ZeiRjx+MMWbRZiOLameYzRdXwZKXpZayK\n8s/+t5TFDGM+YOETHSLdeh6iwGSAfBBEpsrYbX1+84QVbEYnRLHo28O3qzAJ\nf0zMVknh5yAiJgwHKRoao2b8k3XylAKPHzYnUUUOM/EliIdg2Xo0CNEAGk2A\n8O6erawnJNlLRypX/isaPKVDFPYggULZFOL9AmzVbcprg/wSI3WwFxNpGc/N\nTi7hpMiBMqmXq5RLEZX50HjpBz0OneB9J4Yau2wKP5DMCJcZH7kVTObz7CkU\nDUU65xNIsiis9x8E0Qb0az6IGHNor+9upf4wCwwQWCtpnkcib+F2XDz74Uv3\nZ7FDqwQ6DSYZRGGSkpJAsFEkEUf54HmBRcYR4RgJFwpHDulKrXKRDA479eLa\n2q+psigMbCRyjYhIMDu0pz7VBtR57fGGiiNKV87OdUbfv7HDUwX/sbWbMWcJ\n4xN4\r\n=qsWG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG9itzv/aHIReGuk1myXAdRAVozg3msrfcFlxb30aE3fAiAYaOr588QMZ0/pDiTB7kevjQasZpYUYlwZfiXHw8/ynA=="}]},"maintainers":[{"name":"alzintani","email":"hassan.alzintani@gmail.com"}],"_npmUser":{"name":"alzintani","email":"hassan.alzintani@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/superevents_0.1.0_1586320857515_0.9830337777655309"},"_hasShrinkwrap":false},"0.2.0":{"name":"@alzintani/superevents","version":"0.2.0","description":"JavaScript library that handling any events in websites.","main":"gulpfile.js","scripts":{"start":"gulp watch","build":"gulp build","test":"test"},"repository":{"type":"git","url":"git+https://github.com/alzintani/SuperEvents.git"},"keywords":["JavaScript","Events","Scroll","Click","Hover"],"author":{"name":"Hassan Matooq"},"license":"MIT","bugs":{"url":"https://github.com/alzintani/SuperEvents/issues"},"homepage":"https://github.com/alzintani/SuperEvents#readme","devDependencies":{"@babel/core":"^7.8.7","@babel/plugin-proposal-class-properties":"^7.8.3","@babel/plugin-proposal-private-methods":"^7.8.3","@babel/preset-env":"^7.8.7","comment-parser":"^0.7.2","express":"^4.17.1","gulp":"^4.0.2","gulp-babel":"^8.0.0","gulp-header":"^2.0.9","gulp-include":"^2.4.1","gulp-minify":"^3.1.0","gulp-notify":"^3.2.0","gulp-pug":"^4.0.1","gulp-rename":"^2.0.0","gulp-sass":"^4.0.2"},"gitHead":"02a9a2abe57a9bab7c7ebd522c25ce6e917ab950","_id":"@alzintani/superevents@0.2.0","_nodeVersion":"13.3.0","_npmVersion":"6.12.1","dist":{"integrity":"sha512-WvdVi8eS033JrmSdCoTtDOgRKLX8TxdWImZPql6A5ytE6tkyqbgWpTkekX45HL2RpVn6CnrXvz5EEmIuRnbjeg==","shasum":"211df472ff2969fb452aa3790b929efa27fb041f","tarball":"https://registry.npmjs.org/@alzintani/superevents/-/superevents-0.2.0.tgz","fileCount":45,"unpackedSize":262465,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeje+fCRA9TVsSAnZWagAAR7IQAJ6KOCuFtc+dFJf8dqpl\n49+HXn009XZZ24/BVHxv5sdhEcXqeaQrhCilqCxIOzhL7TISn0eube7KoY0w\nTqIYwTxn42XaNiKdvtN1HJon2JVpnINiVFamqmrwx6Z4j3hW5VnwriQVvHms\nGg+8qzJ+J2ghfwclMhedAcYHpkkPReGfrUC7Ja6cH0cLcrUVjEZoLazUzka8\nvtmPVxZvZMy2dcKOeQ8BxC6vKiF8isI3JhR6uXQ37eEkwJDj6fg7mVrMwQEZ\nETLaOzdcaQcwEyXHC1boN1olWVEyNLdypcnXhsxwfxwrUumJK6YFi5+f03e+\ng1nKSooQXbZSlvyUvbDnZ3bCiujLbirjamxX05Udn885793iHCPEOJSX1SsQ\niiyz5U6ItXWzaj+6vO4zcKUe4sPpkx2IqcARUVNCD5RVBQslVMz/Y7bvZZf7\nte9c0B2HjnGWhNjgHC++TEx6aomI3dfCCTHaRW2T6Cq13+jfmU+z69kKil4d\nKF5K2925qP7m2bTi7GYKpW6PBjhiPvXcLZQOAqEyo93M6ynD/D6+G7OHfvKX\n4Y6MTXyeOTv6sw3DUBvG5fmoye8gwdPYiUI9ZMF0UrQ2PVsVnk/mKemw5tjG\nc4YoCcnLx90+i+gfm4pXIMnFaJCaofXxWTuJuhWTPTV37VHBDumH0sxXtToB\naNnt\r\n=Yjjg\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCi4rDqwJzmWWo5FwbXgHGur6h3+ynKUzcLLNI2+rmkhQIgN2rtT2koVtY11uI0Jiwhcxm0fz9KepJKZnRmJ/m9JA4="}]},"maintainers":[{"name":"alzintani","email":"hassan.alzintani@gmail.com"}],"_npmUser":{"name":"alzintani","email":"hassan.alzintani@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/superevents_0.2.0_1586360223065_0.3345994855307104"},"_hasShrinkwrap":false},"0.2.1":{"name":"@alzintani/superevents","version":"0.2.1","description":"JavaScript library that handling any events in websites.","main":"gulpfile.js","scripts":{"start":"gulp watch","build":"gulp build","test":"test"},"repository":{"type":"git","url":"git+https://github.com/alzintani/SuperEvents.git"},"keywords":["JavaScript","Events","Scroll","Click","Hover"],"author":{"name":"Hassan Matooq"},"license":"MIT","bugs":{"url":"https://github.com/alzintani/SuperEvents/issues"},"homepage":"https://github.com/alzintani/SuperEvents#readme","devDependencies":{"@babel/core":"^7.8.7","@babel/plugin-proposal-class-properties":"^7.8.3","@babel/plugin-proposal-private-methods":"^7.8.3","@babel/preset-env":"^7.8.7","comment-parser":"^0.7.2","express":"^4.17.1","gulp":"^4.0.2","gulp-babel":"^8.0.0","gulp-header":"^2.0.9","gulp-include":"^2.4.1","gulp-minify":"^3.1.0","gulp-notify":"^3.2.0","gulp-pug":"^4.0.1","gulp-rename":"^2.0.0","gulp-sass":"^4.0.2"},"gitHead":"a647b6e67159bc2dad33bc585a748ff518a77a91","_id":"@alzintani/superevents@0.2.1","_nodeVersion":"14.4.0","_npmVersion":"6.14.5","dist":{"integrity":"sha512-wwWadf4ymd5/bptbGmw8yhXkztIJLR36uhzq5EZrVW17kaCStf3m40CxBppWuCybns1JAZXXOROwNmvgZL/KBA==","shasum":"d91f7484c9f2ffff1d0099936f72b787c2547489","tarball":"https://registry.npmjs.org/@alzintani/superevents/-/superevents-0.2.1.tgz","fileCount":45,"unpackedSize":264927,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe/HsACRA9TVsSAnZWagAA8wMP/jAKb3t0hRypFk57bIch\nscuVB9Cu9ftHq+i4WUNCd8nAKt1ky4B51ZfnT9u1g7avEy8xMJq52bF8Yg4/\nU7dC4mGsmtM8GF9iB//V/JKCpCxdFZ6QC+IfwBfQ62V0crORhEbUFQaKk/c7\nnFLgNnO6dF8CBnfJCq5lB2SMcosaksduxwmsGs5IINLQY+YTSLJ+zszfkx75\nX92fg22uK0zXYfX3AzMg2OphQLXa3oxRp7vL6SJuqKWji4SqKGUdBk1/WxIC\numVLRHItN1NrmnAgTKjx1G5I7Wa0mD966A/UdMy+k4RPtoKHOpCnpnkdBQ45\nvnHnUEJWoRkSDqxJXaETe6Fn/lsGPtBJPj7MgSgRPwfecSTdrWbqzHhBcFU9\n6dMuhBi4b5uGeYCCjZ7aQOCOrBFzrYePKxM4R6WPtmIkuCGJY0amYqslFaQq\ndrJnSzNSvcNKRRGQlZVn9/WyRHRQJnEGswsj0O3AzRWuz8wiQkrlDtCEdMdo\nWryvclcZBm2/EgJL+EjeRApW38ECN8R1abgKhFn/zscFsDmMqcoliRBaAvwG\nt7yf6oLGjO/vjuI3PXy+JfdjaNHR42GA4QT2S3eID1mHv+wIOGiqkIWE+fkK\n7m54UjAWO3pnxltAbelHgONC1vD+5GPWxsjdv1vfu5235bF+v9QVBktdgiIG\nVHOS\r\n=SJzo\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDQbJfWlmdaShTsHepg3fo+6IAZFff9x3i4dSa/sfCYZQIhAKxWTO2uRjEWNU/TxuMzyyi/A5m4k3FHkbyG2uAdFFrH"}]},"maintainers":[{"name":"alzintani","email":"hassan.alzintani@gmail.com"}],"_npmUser":{"name":"alzintani","email":"hassan.alzintani@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/superevents_0.2.1_1593604864237_0.6633427227533581"},"_hasShrinkwrap":false},"0.2.2":{"name":"@alzintani/superevents","version":"0.2.2","description":"JavaScript library that handling any events in websites.","main":"gulpfile.js","scripts":{"start":"gulp watch","build":"gulp build","test":"test"},"repository":{"type":"git","url":"git+https://github.com/alzintani/SuperEvents.git"},"keywords":["JavaScript","Events","Scroll","Click","Hover"],"author":{"name":"Hassan Matooq"},"license":"MIT","bugs":{"url":"https://github.com/alzintani/SuperEvents/issues"},"homepage":"https://github.com/alzintani/SuperEvents#readme","devDependencies":{"@babel/core":"^7.8.7","@babel/plugin-proposal-class-properties":"^7.8.3","@babel/plugin-proposal-private-methods":"^7.8.3","@babel/preset-env":"^7.8.7","comment-parser":"^0.7.2","express":"^4.17.1","gulp":"^4.0.2","gulp-babel":"^8.0.0","gulp-header":"^2.0.9","gulp-include":"^2.4.1","gulp-minify":"^3.1.0","gulp-notify":"^3.2.0","gulp-pug":"^4.0.1","gulp-rename":"^2.0.0","gulp-sass":"^4.1.0"},"gitHead":"b01878fa00ac6653841b5a2dcb6e8735b11702d7","_id":"@alzintani/superevents@0.2.2","_nodeVersion":"14.6.0","_npmVersion":"6.14.7","dist":{"integrity":"sha512-O+zczXS9V0Nr5iw7wUDjdJZfvaxXdVYg2n0M71eAri2qhJzQjw0UVrV7WXuYa4EKSeIyM1kjGmEf2ljtOQMELg==","shasum":"8537fc10b0cd34e7846e9e40d34c5e3903578874","tarball":"https://registry.npmjs.org/@alzintani/superevents/-/superevents-0.2.2.tgz","fileCount":45,"unpackedSize":265802,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfG1SrCRA9TVsSAnZWagAASWsQAKJxtTq1l5L7SbGaBznO\nP3CyruozuTatJpJaZ2C4RChHlouZ8JFg6rVV/NCRUvb2DtvcAMMrCrLASMnQ\nrd7k9s7lxrJbXWtgar8k8g6Xq9MmRXyFYZjl6p+2TQk/JYb/qRIe9CF+srC1\nrAtpdmK/dSOgs1GXhdeAvSTC7PtZSvGnmccnKZ8vTUAQMVCRZ6eVSeXyuQEq\nAsq4Vw1w4BGDLfV5ZAJQemoXLWSJ7VHRJG9DFJ337yY1hd1RMf/vyn4z4EK/\neMpDtejSMGI17gUJ3PfwxZfTZBkhWXmVwx7iyN4d/ZCCpL8lHAhiRWHHncs2\n+nXKdOaNOdvxKjGclWJtMoFMBwML/eTAOEjhVdZmpLnUYjYB3ZmhgD9YFHsR\ndj8iyDmeYpBoLIdIzSOajaO5Xz7Z1Vsnb/ZAhFwrNq1q4x3782cFQo6yNqMy\nb+OFKuSPRDvlox8tAFPSM+1X4bSeKl2GL9p7QBZVpFch8HusbaAy/5GkZkO+\nsBLFGEIAQvzDAdMrUfbnBHKLzJJTgF7Mn1eQZuGb0Hmw2B6CuC3+dNvBosdF\nuOnYbv/Hed5RYaYDRIHM4WeHbLLGN+2G3aI078/x3ZLapL8FL+9/WtStXAhO\nxxcb+ZsgRiiqfZ6ZfrPa0UdwBLNbAK9gfdY+VqD0ItGzSJydB3dLM8vpIogr\nmMgx\r\n=rgG4\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCv0gGdB/nLy4X63+F7r6EBUPogyI3xSP/ht3KeYjDG2wIhANsWbMZnxaJVX/Ciw3IPr30qyrhk5IaCLmZaUqUaIUHe"}]},"maintainers":[{"name":"alzintani","email":"hassan.alzintani@gmail.com"}],"_npmUser":{"name":"alzintani","email":"hassan.alzintani@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/superevents_0.2.2_1595626666450_0.625259479955405"},"_hasShrinkwrap":false}},"time":{"created":"2020-04-08T04:40:57.275Z","0.1.0":"2020-04-08T04:40:57.685Z","modified":"2022-04-04T13:42:26.308Z","0.2.0":"2020-04-08T15:37:03.200Z","0.2.1":"2020-07-01T12:01:04.398Z","0.2.2":"2020-07-24T21:37:46.635Z"},"maintainers":[{"name":"alzintani","email":"hassan.alzintani@gmail.com"}],"description":"JavaScript library that handling any events in websites.","homepage":"https://github.com/alzintani/SuperEvents#readme","keywords":["JavaScript","Events","Scroll","Click","Hover"],"repository":{"type":"git","url":"git+https://github.com/alzintani/SuperEvents.git"},"author":{"name":"Hassan Matooq"},"bugs":{"url":"https://github.com/alzintani/SuperEvents/issues"},"license":"MIT","readme":"# SuperEvents\nJavaScript Scroll, Hover, Mouse move and Click effects library.\n\n[Examples](https://alzintani.github.io/SuperEvents/examples.html)\n\n-----\n\n## Table of Contents\n\n- [Description](#description)\n- [Installation](#installation)\n- [Quickstart](#quickstart)\n- [API Documentation](#api-documentation)\n  - [Event Functions](#event-functions)\n  - [Action Functions](#action-functions)\n  - [Easing](#easing-optional)\n- [Contributing](#contributing)\n- [Copyright and license](#copyright-and-license)\n\n-----\n\n\n## Description\nOften, when events happen, you may want to do something. SuperEvents allows you applying actions to target elements when events are detected in source element.\nSuperEvents right now can handel these events:-\n* Click\n* Hover\n* Mouse Move\n* Scroll\n\n\n-----\n\n\n## Installation\nDownload the latest version of SuperEvents from [GitHub repository](https://github.com/alzintani/SuperEvents/releases).\nInclude SuperEvents.min.js to your HTML file.\n```HTML\n<script src=\"/path/to/SuperEvents.min.js\"></script>\n```\nAnd SuperEvents is ready to use!\n\n\n-----\n\n\n## Quickstart\n\nFirst, you have to create an instance by passing the source element(s) and the target element(s) in object to SuperEvents, for example:-\n\n```javascript\nvar scrollInstance = new SuperEvents({\n  source: document.getElementById('any-element-id'),\n  target: document.querySelectorAll('.click-example-target')\n});\n```\nThen you have to call the event function and pass the required parameters (some of functions does't required any parameters or you can keep it empty to use default values) for example for scroll event call this function:\n```javascript\nvar scrollEvent = scrollInstance.scroll({\n  indicator: '80%',\n  duration: '20%',\n});\n```\n__indicator and duration is the space where you can apply the action.__\n\n\nThen call the action function:-\n```javascript\nvar scrollAction = scrollEvent.fromTo({ color: '#00FF00' }, { color: '#FF0000' });\n```\n\nfinally call the easing function like this way:-\n```javascript\nscrollAction.easing({\n  timing:'linear',\n  duration: 0.3,\n  delay: 0.3,\n  cubicBezier: false\n});\n```\n__easing function is Optional__\n\n[See some examples with code](https://superevents.org/examples.html)\n\n-----\n\n\n## API Documentation\n\n### Event Functions\n\n* **scroll( params = {} ): {object}**\n  * **Description**: The scroll event fires when the document view or an element has been scrolled.\n  * **Parameters**:-\n      params:\n      * name: params\n      * Description: The parameters\n      * type: object\n      * optional: true\n      * default:\n\n```javascript\n{\n    indicator: '80%', //\n    duration: '20%', //\n    listener: 'load', //\n    debug: false // Display debug lines for scrolling postion and start and end ponts\n}\n```\n\n-----\n\n* **mousemove(): {object}**\n  * **Description**: The mousemove function occurs when the mouse move over the target element.\n  * **Parameters**:-\n    null\n\n-----\n\n* **click()**\n  * **Description**: Execute a JavaScript when click the target element.\n  * **Parameters**:-\n    null\n\n-----\n\n* **.mousemove()**\n  * **Description**: The hover function occurs when the mouse pointer is over the selected element.\n  * **Parameters**:-\n    null\n\n-----\n\n### Action Functions\n\n* **call( callback ): {object}**\n  * **Description**: Scale in/out target element(s)\n  * **Parameters**: Boolean true, default value:- true *(set it to false for scale out)*\n\n-----\n\n* **fromTo( scrollEventFrom = {}, scrollEventTo = {} ): {object}**\n  * **Description**: From and To action\n  * **Parameters**: Object {}, Object {}\n      * example:\n\n```javascript\nevent.fromTo(\n  { color: '#FFF' },\n  { color: '#999' }\n)\n```\n\n-----\n\n### Easing (Optional)\n* **easing( params = {} ): {object}**\n  * **Parameters**: String '', Float 1, Boolean false\n      * example:\n\n```javascript\nevent.easing({\n  timing:'linear',\n  duration: 0.3,\n  delay: 0.3\n});\n```\n\n\n-----\n\n\n## Contributing\nWant to get involved with SuperEvents? Here's how you can help.\n\n[Fork](https://help.github.com/fork-a-repo/) SuperEvents, clone your fork, and configure the remotes:\n\n```BASH\n# Get code from repostery\ngit clone https://github.com/<your-username>/SuperEvents.git\n\n# Change your way to cloned directory\ncd SuperEvents\n\n# Configure the remotes\ngit remote add upstream https://github.com/alzintani/SuperEvents.git\n```\n\n\nInstall required packages `npm install` then run `npm run build` to build main files and documentation files.\n\nNow you can run `npm start`\n\nTo display the documentation go to [http://localhost:3001](http://localhost:3001) from your browser.\n\n\n-----\n\n[Real Example](https://hayyabuild.zintathemes.com/)\n\n-----\n\n## Copyright and license\nSuperEvents 2020 Hassan Matooq. Code released under the MIT license.\n\n","readmeFilename":"README.md"}