{"_id":"@byteclaw/use-overflow-scroll-position","_rev":"4-faa3270654870baf282e781e942a240e","name":"@byteclaw/use-overflow-scroll-position","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.0":{"name":"@byteclaw/use-overflow-scroll-position","version":"1.0.0","description":"React hook for calculating number of pixels scrolled through in an overflow:scroll enabled container","source":"src/index.ts","main":"dist/use-overflow-scroll-position.cjs.js","umd:main":"dist/use-overflow-scroll-position.umd.js","jsnext:main":"dist/use-overflow-scroll-position.m.js","module":"dist/use-overflow-scroll-position.m.js","typings":"dist/index.d.js","scripts":{"build":"npx tsc && microbundle build -o dist","lint":"eslint src/**/*.{ts,tsx}","prebuild":"rimraf dist temp","postbuild":"rimraf .rts2*","prepublishOnly":"npm run build","test":"jest","test:watch":"jest --watch","typecheck":"tsc --noEmit"},"peerDependencies":{"@types/react":"^16.7.13","react":"^16.8.3"},"devDependencies":{"react-dom":"^16.8.3","react-testing-library":"^5.3.0","typescript":"3.2.2"},"sideEffects":false,"repository":{"type":"git","url":"git+https://github.com/byteclaw/hooks.git"},"keywords":["react","hooks"],"license":"MIT","bugs":{"url":"https://github.com/byteclaw/hooks/issues"},"homepage":"https://github.com/byteclaw/hooks#readme","contributors":[{"name":"Michal Kvasničák","url":"https://github.com/michalkvasnicak"},{"name":"Juraj Hríb","url":"https://github.com/jurajhrib"}],"publishConfig":{"access":"public"},"jest":{"collectCoverageFrom":["src/**/*.{js,jsx,ts,tsx}","!**/node_modules/**","!**/__tests__/**","!**/__fixtures__/**","!**/dist/**","!**/temp/**"],"setupFilesAfterEnv":["<rootDir>/jest/setup.js"],"moduleDirectories":["./node_modules","./src"],"moduleFileExtensions":["ts","tsx","js","jsx"],"transform":{"^.+\\.(js|jsx|ts|tsx)$":"babel-jest"}},"gitHead":"5544933a4d7c42e5b1f35c5f9004cdaaecef24d7","_id":"@byteclaw/use-overflow-scroll-position@1.0.0","_nodeVersion":"10.15.0","_npmVersion":"lerna/3.13.1/node@v10.15.0+x64 (darwin)","dist":{"integrity":"sha512-G+kehIjIahN9O7N/VNc1SQ0ZXNI9hJcotofyv5QCl6nl8HVdOwxE/p/M1SiCFLSmTVy2L+rDZqcKkRTijI483A==","shasum":"ae1cb039f836bf50f6ad61e1f8e0ed9462ae8b98","tarball":"https://registry.npmjs.org/@byteclaw/use-overflow-scroll-position/-/use-overflow-scroll-position-1.0.0.tgz","fileCount":10,"unpackedSize":11694,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcdmpJCRA9TVsSAnZWagAABSYP/37ha459TwpGTKA/7sIe\nbchC+Qvsu0Rh+iZLA3/1Sfgzp7JJB2JtcOGWOpWykeU6mlXG1XpFYDMmTp0j\nBItjyucqQ/tHlDtmtjQYvus8VzRM6WgmLDPMmKQo/G6mZaeLQ55APw0EUprg\ncUcUiqg9lDetjLMSHJ7TA0KywvFNHcuWdCbpYDUnsf83aiH6Y83FATMJzpnE\n4C2QW3iqUzBxoTsiCI9L96KqJWx/zxQ9sxvTdOpWwg18yRFYr9pQXj9mYZLs\nBTj/mWzsXS0gDZZkjnh1eC/YScX2NRHPBnPcj0szdGGIYlmtEV2x8WG+yvMy\nVpPI64Kg63zUky+C1PHLr2kp2JkM/M+iyraRNNcBUb0GnKcKIJJRX9qWVFL6\nuY7zjkT0ZhP28L7RJc9XqE0zmD4SBbprDJvmPJQmdHO9CkZw25rZK45fIPOE\nREeAS66iM1wvQ4dj7wuT3Lo4PibqL7FZ1Ff7+RKuBwiiYcV9zjamv9s0YQct\nN5A0DZ93R6J6meRKkLQyNFgLJ0493TwPv3UgsLHGidMUMDGWzcSkjhYG4jWx\nqBzQX2q+b7hQhBIPdMTNRgTHByp2rwR5VkO9kRahD8SuLNVSbmn9gtCBoFcF\n6xf808hMzB4aQhN068MG7YSginPTKkRbSV7yQhiX4TeGAoqQTK8vkSUCo/1R\nma3L\r\n=MeYi\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFbr3k7U0rMhp5V0qLV0W5HPdTW1DlIAguqtibvPS408AiEA+/aKN6/WjiCZmcjOlNNpsD1k6LZtgZCAty8HtHFwB5Y="}]},"maintainers":[{"name":"michalkvasnicak","email":"michal.kvasnicak@gmail.com"},{"name":"jurajhrib","email":"jurajhrib@gmail.com"}],"_npmUser":{"name":"jurajhrib","email":"jurajhrib@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/use-overflow-scroll-position_1.0.0_1551264329006_0.9804118444779166"},"_hasShrinkwrap":false},"1.0.1":{"name":"@byteclaw/use-overflow-scroll-position","version":"1.0.1","description":"React hook for calculating number of pixels scrolled through in an overflow:scroll enabled container","main":"dist/use-overflow-scroll-position.js","module":"dist/use-overflow-scroll-position.esm.js","unpkg":"dist/use-overflow-scroll-position.umd.js","source":"src/index.ts","types":"dist/index.d.ts","typings":"dist/index.d.js","scripts":{"build":"microbundle build -o dist","prebuild":"rimraf dist","prepublishOnly":"npm run build","test":"jest","test:watch":"jest --watch","typecheck":"tsc --noEmit"},"peerDependencies":{"@types/react":"^16.9.11","react":"^16.12.0"},"devDependencies":{"@testing-library/react":"^9.3.2","react-dom":"^16.12.0"},"sideEffects":false,"repository":{"type":"git","url":"git+https://github.com/byteclaw/hooks.git"},"keywords":["react","hooks","scroll-position"],"license":"MIT","bugs":{"url":"https://github.com/byteclaw/hooks/issues"},"homepage":"https://github.com/byteclaw/hooks/packages/use-overflow-scroll-position#readme","contributors":[{"name":"Michal Kvasničák","url":"https://github.com/michalkvasnicak"},{"name":"Juraj Hríb","url":"https://github.com/jurajhrib"}],"publishConfig":{"access":"public"},"gitHead":"7d259fd7d780579fd2a158d96df4bb0da25b5fe7","_id":"@byteclaw/use-overflow-scroll-position@1.0.1","_nodeVersion":"12.13.0","_npmVersion":"lerna/3.18.4/node@v12.13.0+x64 (darwin)","_npmUser":{"name":"michalkvasnicak","email":"michal.kvasnicak@gmail.com"},"dist":{"integrity":"sha512-8m7pdW8vl+5QPl5PHbdiu3SXgfO6qxIllsOdoJoGg7fWanJnGL3mOGunHwIWfsRTARfAW1j5M9Xut4sTVxiXaw==","shasum":"938d3f7d39d9a2c8cbc8de241e853dfd13364c5b","tarball":"https://registry.npmjs.org/@byteclaw/use-overflow-scroll-position/-/use-overflow-scroll-position-1.0.1.tgz","fileCount":13,"unpackedSize":14071,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdzocJCRA9TVsSAnZWagAAWFkP/RMTaKroG9pwgiE9GPf3\nkuJ+XkzOuTT99hjoO7EqzCKCa/pAjwLW3qQFWjgrE7Ydg8ULY9w5XbSxFBMJ\n5b3gZQ+9FJ1vDrf0zXoDaDc8Rl86ujxSkC3ivczpv+e5OanikdgTUNuXQWf9\n3kTwNeCvdG3Zwxv65V6pmIWhOnp3ctEt5Ekk2YLmM44cwdlV7GXny++Xlka7\nxQ8roub8r22rhHhwFXsMfU3xQI+DgeLPx4Ss8jhlo1VO26DsQvETgQtBlHCJ\niTb+J+1ck1D3VUhR4da0zQRhUze9CQ2BNJJE4GQQsDEtuzsLJ7DDt/Pmxxro\nLBSlQfKleK0QscvMG4wxKKjTfDQ9POUazM1AyZRw8sOol/thAw+HLsikaiYV\nr5A6KRwQQn9PeHII8eP/lPZtmGqX3Lo/nSZoHnBiHo28rMiQr8oRjhZWOChc\nhGPbXrWaT5iFZP9jm9rNqniSRAUCwDSLSTdSiY6hV1J5eaH4dNfaGACbeOCu\nESRGdIZfb/fsinTFTRO+xKZyKnZm5j/VD495mzbTrWCGTK8eGoeXE9sv3els\n3IZbUHzW3RIepG6aDSWwzsc9+AZp+z8uLD7xDKebpq/GQjWVK4IryKZLpaw+\no2iirtB9AYoB4Vuc5/OCGN/Z9Tl7qE/0TMjjIwlvTemjztNfuacTBpd2hm3S\nW/o0\r\n=s4w5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICwe+7h8FsD8jcKl4neo8A7bxlmMfJwx/dw9Js87V2z4AiEAg01fMhK/pVDSmN25c/00tUsefBlC9K2ni4bekdrM4FA="}]},"maintainers":[{"name":"jurajhrib","email":"jurajhrib@gmail.com"},{"name":"michalkvasnicak","email":"michal.kvasnicak@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/use-overflow-scroll-position_1.0.1_1573816072760_0.5910049118430085"},"_hasShrinkwrap":false},"1.0.2":{"name":"@byteclaw/use-overflow-scroll-position","version":"1.0.2","description":"React hook for calculating number of pixels scrolled through in an overflow:scroll enabled container","main":"dist/use-overflow-scroll-position.js","module":"dist/use-overflow-scroll-position.esm.js","unpkg":"dist/use-overflow-scroll-position.umd.js","source":"src/index.ts","types":"dist/index.d.ts","typings":"dist/index.d.js","scripts":{"build":"microbundle build -o dist","prebuild":"rimraf dist","prepublishOnly":"npm run build","test":"jest","test:watch":"jest --watch","typecheck":"tsc --noEmit"},"peerDependencies":{"@types/react":"^16.9.11","react":"^16.12.0 || ^17.x"},"sideEffects":false,"repository":{"type":"git","url":"git+https://github.com/byteclaw/hooks.git"},"keywords":["react","hooks","scroll-position"],"license":"MIT","bugs":{"url":"https://github.com/byteclaw/hooks/issues"},"homepage":"https://github.com/byteclaw/hooks/packages/use-overflow-scroll-position#readme","contributors":[{"name":"Michal Kvasničák","url":"https://github.com/michalkvasnicak"},{"name":"Juraj Hríb","url":"https://github.com/jurajhrib"}],"publishConfig":{"access":"public"},"gitHead":"9a4673d3353b8ae334f377bc3aa1a4472d17b547","_id":"@byteclaw/use-overflow-scroll-position@1.0.2","_nodeVersion":"12.20.0","_npmVersion":"lerna/3.21.0/node@v12.20.0+x64 (darwin)","dist":{"integrity":"sha512-39nlLN8VKfwBDG2rXkhwJqXyCTy1h8VXX6ODABzv2T5JcvxPiEXpcXi05Zyb8V8cj/AJIBWEby1lyZEvXyqVlg==","shasum":"a063d3a6def3468857ebb0cb1188be25d6350817","tarball":"https://registry.npmjs.org/@byteclaw/use-overflow-scroll-position/-/use-overflow-scroll-position-1.0.2.tgz","fileCount":14,"unpackedSize":14366,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf6eaSCRA9TVsSAnZWagAAFNgP/2qHCP810+SPmXQ0EWTN\nsimiA6TCsIV2Qz6FxW9GQ9qupgPbf01eeMECh/obtxl1ehV54ZAlhY9VI7qQ\nveSo+HNZlQYL0FOudPdBNHqJ2Z+vTTf4evujtP4GYP7/f1D9O6Q2hRUiS8Hw\nuRj9wwiSAlHxF7oKUcV/ndiw97gkkEhCzrXjnQUOwBkoJbHoT6GtderN13A/\npXBJLoaS7YpDI5DhsycURlktkHUazXFSUsq8kFbjUQeqa+bXBMQ4kKn/2QsR\nZcgHV+OR2D27M442b+JodtvRyK92JZcVVmqsPtX0fWpwop08LOZrJw2oAz4E\nTUECWcC/vLH6hwrf+NsZFfAKWUkYMZhQHPIb+JkRGxIfc8zuQzu/NMXPRQ+I\nQ0xi9/2198rUwPo2eZS/yEdZ+fdUFVCCArKc2fvrjkvR38888bsvwmhVEyBt\nnhEP8eLB6S7TMWcWsu99dyB+blyc5ebrTqes196k58F8KnwUnHq8LvqtKnRQ\nHE4GRNt5LT4zjdKm+Jh7Av/AQHJBCU34J7yIj955Qd8Of5YUqQIhaG4tiECm\nh1FTgDycrfnMkFxFw/yY8xAw8OFCsElOxvf9bMDsF0F8fowq1+WYiUZoYA0Y\nT0LW24rAQjtZ54l7rP1Nszrh/4aLB8Mkazury4yxx87mz0w7P+CM4qbgN8sX\nEzXO\r\n=2YBO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG8cqE2b23WWbMHq5LDOvYKY5V0HLBw/asoqlfvYXnKvAiBBXISpLCex2uQgm47nW0MVGORP0HQ8IV51qm7rCbkt1g=="}]},"_npmUser":{"name":"michalkvasnicak","email":"michal.kvasnicak@gmail.com"},"directories":{},"maintainers":[{"name":"jurajhrib","email":"jurajhrib@gmail.com"},{"name":"michalkvasnicak","email":"michal.kvasnicak@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/use-overflow-scroll-position_1.0.2_1609164434068_0.7785410233043115"},"_hasShrinkwrap":false},"1.0.3":{"name":"@byteclaw/use-overflow-scroll-position","version":"1.0.3","description":"React hook for calculating number of pixels scrolled through in an overflow:scroll enabled container","main":"dist/use-overflow-scroll-position.js","module":"dist/use-overflow-scroll-position.esm.js","unpkg":"dist/use-overflow-scroll-position.umd.js","source":"src/index.ts","types":"dist/index.d.ts","typings":"dist/index.d.js","scripts":{"build":"microbundle build -o dist","prebuild":"rimraf dist","prepublishOnly":"npm run build","test":"jest","test:watch":"jest --watch","typecheck":"tsc --noEmit"},"peerDependencies":{"@types/react":"^16.9.11 || ^17.0.0","react":"^16.12.0 || ^17.x"},"sideEffects":false,"repository":{"type":"git","url":"git+https://github.com/byteclaw/hooks.git"},"keywords":["react","hooks","scroll-position"],"license":"MIT","bugs":{"url":"https://github.com/byteclaw/hooks/issues"},"homepage":"https://github.com/byteclaw/hooks/tree/master/packages/use-overflow-scroll-position#readme","contributors":[{"name":"Michal Kvasničák","url":"https://github.com/michalkvasnicak"},{"name":"Juraj Hríb","url":"https://github.com/jurajhrib"}],"publishConfig":{"access":"public"},"gitHead":"6ec2f17204b3484a5d7ba1c717dbf54cd6ead901","_id":"@byteclaw/use-overflow-scroll-position@1.0.3","_nodeVersion":"12.21.0","_npmVersion":"lerna/4.0.0/node@v12.21.0+x64 (darwin)","dist":{"integrity":"sha512-zoGnchMdGCJc4vUxa7Z/kns9hDQFszDx9+CjkhUf04cwI/oJB7gHMmAAxMgxG7pL7qoeP9qGzSh5oiJIxO+t1w==","shasum":"08a4095fd2ef87d5e0575dc22ecdcfc78f78894a","tarball":"https://registry.npmjs.org/@byteclaw/use-overflow-scroll-position/-/use-overflow-scroll-position-1.0.3.tgz","fileCount":13,"unpackedSize":13820,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgq1X+CRA9TVsSAnZWagAAe2kP/iuCvnEgMlTtYvJRv2F0\nHgBd01nCF4htcFZ74RozypUpYRuc50VWSir3gu+bBC29OZeTKVFdvBAB985m\nTFBRJa2igXuh2pfaC5/TUFdbaGr54O7uc/tHyWclWaN/iuNXIYItyaNP8Km8\nnoP7ZwqvGIGx2PykJ+Zt3+b6lQbHg3+XlwMjuyIvtrlfXJfGzuDqMsiucjas\nDoSAfa9FsD0uTi07ET/JUM9wJ3oFIQcdHvhFcy/Zbo+GbbB/VAU0kKfmkW0Y\negGlz3lv0lDLZsXq8Ma8AhDRHb0erOVGAf7HN/LrvZgaV4AiozW+ucaT/Trd\npa2ZgpGx6fcttbtzN4eGwr238WdRJNNqjHLykJ1KJpecQZg3ifZvSPE5WLjw\nu4nG4u/KcKb+hGEJNmEkVdAOQgbBpvywhb8OO8kgU6X1Rdwh/OKqYhiYfJSz\nR09kfE/c+djJCsWRZB+f9MysWqeFyGQJn3tQNOmGwh0X8MKALtawDGZbqKtY\nS3dJFYH2tGeQyz6tV48jH0MxuEFVCI8oQZh4lIL2IsYjcRSw/9QKaYnJciGX\n7coMA/IgOSzjtuh0PXZVX7ym1tOlA8L/vc5aV8bcn3tGww9RO7YLGDoVyDYI\nAodTQja+F9SzIbWhSsWU/vopAYAJSfELnxzjmDfVMsmBN9r5NneAD7NV+SBs\nEZDt\r\n=aOaf\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIB5EubvFslBmtvqtAWfeq7a4S+mGbxmD1zWAmjjOAaRtAiEAjAZrleFgo5PEygR20Osn90hq2f1aJ/8U7rsauohoClw="}]},"_npmUser":{"name":"michalkvasnicak","email":"michal.kvasnicak@gmail.com"},"directories":{},"maintainers":[{"name":"jurajhrib","email":"jurajhrib@gmail.com"},{"name":"michalkvasnicak","email":"michal.kvasnicak@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/use-overflow-scroll-position_1.0.3_1621841405739_0.5379428729133888"},"_hasShrinkwrap":false}},"time":{"created":"2019-02-27T10:45:28.809Z","1.0.0":"2019-02-27T10:45:29.212Z","modified":"2022-04-04T21:21:30.420Z","1.0.1":"2019-11-15T11:07:52.882Z","1.0.2":"2020-12-28T14:07:14.232Z","1.0.3":"2021-05-24T07:30:05.883Z"},"maintainers":[{"name":"jurajhrib","email":"jurajhrib@gmail.com"},{"name":"michalkvasnicak","email":"michal.kvasnicak@gmail.com"}],"description":"React hook for calculating number of pixels scrolled through in an overflow:scroll enabled container","homepage":"https://github.com/byteclaw/hooks/tree/master/packages/use-overflow-scroll-position#readme","keywords":["react","hooks","scroll-position"],"repository":{"type":"git","url":"git+https://github.com/byteclaw/hooks.git"},"contributors":[{"name":"Michal Kvasničák","url":"https://github.com/michalkvasnicak"},{"name":"Juraj Hríb","url":"https://github.com/jurajhrib"}],"bugs":{"url":"https://github.com/byteclaw/hooks/issues"},"license":"MIT","readme":"# @Byteclaw/use-overflow-scroll-position\n\n[React](https://github.com/facebook/react) hook for tracking the scroll position inside an overflow:scroll enabled element.\n\n## Installation\n\n```console\nnpm install @byteclaw/use-overflow-scroll-position\nyarn add @byteclaw/use-overflow-scroll-position\n```\n\n## Usage\n\nHere is a quick example with a simple scrollable div container rendering a children. **It can be used with any element ref**:\n\n```jsx\nimport { useOverflowScrollPosition } from '@byteclaw/use-overflow-scroll-position';\n\nfunction ScrollableBox(children) {\n  const box = useRef(null);\n  const [scrollPosition, scrollHeight] = useOverflowScrollPosition(box);\n\n  if (scrollPosition !== null && scrollPosition === scrollHeight) {\n    console.log(`You've successfully scrolled to the end, yay!`);\n  }\n\n  return <div ref={box}>{children}</div>;\n}\n```\n\n## API\n\n`useOverflowScrollPosition(ref: MutableRefObject<HTMLElement | null>)` returns a tuple `[number | null, number | null]`.\nThe **first value** is how much of the content you've `actually scrolled` through, the **second value** is the content `total size`, so you can use it for calculations like scrolled percentage. The values are null until the ref is assigned an element.\n","readmeFilename":"README.md"}