@smakss/react-scroll-direction 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 MAKSS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Readme.md

@@ -0,0 +1,61 @@
+# Detect react scroll direction
+
+![npm](https://img.shields.io/npm/v/@smakss/react-scroll-direction) ![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/@smakss/react-scroll-direction) ![NPM](https://img.shields.io/npm/l/@smakss/react-scroll-direction) ![npm](https://img.shields.io/npm/dt/@smakss/react-scroll-direction) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@smakss/react-scroll-direction)
+
+This is a custom hook for react which is useful to detect scroll direction in react applications with a efficient way and custom threshold.
+
+## How it works?
+
+To install it you can simply do the following command:
+
+```bash
+npm i @smakss/react-scroll-direction
+or
+yarn add @smakss/react-scroll-direction
+```
+
+to include it with common js module you should do this:
+
+```js
+var { useDetectScroll } = require("@smakss/react-scroll-direction");
+```
+
+and to include it with ECMAscript module you can simply do this one:
+
+```js
+import { useDetectScroll } from "@smakss/react-scroll-direction";
+```
+
+then to use it within your application you can do it just like below:
+
+The useDetectScroll custom hook will accept 3 input parameter:
+
+- `thr` (`Number`): A number to indicate the threshold of firing scroll direction event, which is `0` by default and it is only accept a positive numeric value. If it gets higher value the steps will be longer.
+- `up` (`string`): A string value for the output of custom hook if the scroll direction is upward. The default value is `up`.
+- `down` (`string`): A string value for the output of custom hook if the scroll direction is downward. The default value is `down`.
+
+## Examples of usage
+
+if scroll goes upward:
+
+```js
+const [scrollDir] = useDetectScroll();
+
+// scrollDir: "up"
+```
+
+if scroll goes downward:
+
+```js
+const [scrollDir] = useDetectScroll();
+
+// scrollDir: "down"
+```
+
+## Demo
+
+You can check the [working demo](https://runkit.com/smakss/) in runkit.
+
+or
+
+[![View @smakss/search](https://codesandbox.io/static/img/play-codesandbox.svg)]()