{"_id":"@1ohooks/use-vertical-swipe-minimum","_rev":"1-a4857b4f2e3a0bf933f8cd908b122c8b","name":"@1ohooks/use-vertical-swipe-minimum","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@1ohooks/use-vertical-swipe-minimum","version":"0.1.0","main":"dist/packages/useVerticalSwipeMinimum/src/index.js","types":"dist/packages/useVerticalSwipeMinimum/src/index.d.ts","scripts":{"build":"tsc && copyfiles -u 1 src/**/*.{scss,png,jpg} dist/"},"keywords":[],"author":"","license":"ISC","_id":"@1ohooks/use-vertical-swipe-minimum@0.1.0","_nodeVersion":"18.14.2","_npmVersion":"9.5.1","dist":{"integrity":"sha512-66o9C+ipJer8AiyCsxM+mcKcUmQ5viWCqnCm8E/vLaoLWOsuLiJvCLzFndLhpWTjlQOXez1J8NcxNm7Rd47z1Q==","shasum":"f477cdf097cbbdce0644b215d4d6e4e8ce31903b","tarball":"https://registry.npmjs.org/@1ohooks/use-vertical-swipe-minimum/-/use-vertical-swipe-minimum-0.1.0.tgz","fileCount":7,"unpackedSize":3036,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFWyWJDHbEjpDjvCUCDemo8bDsrLdb2LMz0l4ypV37SFAiAJKVmv7vdDN+udYWiSbHitbjyN0MdDr4IGGQkskJebxQ=="}]},"_npmUser":{"name":"1ojames","email":"jameshuntdevelopment@gmail.com"},"directories":{},"maintainers":[{"name":"1ojames","email":"jameshuntdevelopment@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/use-vertical-swipe-minimum_0.1.0_1695583219255_0.20440689347681862"},"_hasShrinkwrap":false},"0.1.1":{"name":"@1ohooks/use-vertical-swipe-minimum","version":"0.1.1","main":"dist/packages/useVerticalSwipeMinimum/src/index.js","types":"dist/packages/useVerticalSwipeMinimum/src/index.d.ts","scripts":{"build":"tsc && copyfiles -u 1 src/**/*.{scss,png,jpg} dist/"},"keywords":[],"author":"","license":"ISC","description":"<h1>useVerticalSwipeMinimum</h1>","_id":"@1ohooks/use-vertical-swipe-minimum@0.1.1","_nodeVersion":"18.14.2","_npmVersion":"9.5.1","dist":{"integrity":"sha512-YPvE914qK4jHq1q9WLD+iM1kZAsgbbYtbCZxMywQ/paHT2OWxR6K9xfo0fvjkXfGm+5q/3lEa1obsTd1XDE5ag==","shasum":"7ee96ea691156400bd645246b2734a0b0de0cacf","tarball":"https://registry.npmjs.org/@1ohooks/use-vertical-swipe-minimum/-/use-vertical-swipe-minimum-0.1.1.tgz","fileCount":8,"unpackedSize":5470,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGHcbeDvpIvigfmpW7AzlTetLJxuCajQwN7pR7XYbACSAiEAvq4dHO5v8g1Mt9TQ/6zYeyipVZBsSFSlOATpkhhNCxw="}]},"_npmUser":{"name":"1ojames","email":"jameshuntdevelopment@gmail.com"},"directories":{},"maintainers":[{"name":"1ojames","email":"jameshuntdevelopment@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/use-vertical-swipe-minimum_0.1.1_1695587829406_0.7109140743654323"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-24T19:20:19.139Z","0.1.0":"2023-09-24T19:20:19.422Z","modified":"2023-09-24T20:37:09.787Z","0.1.1":"2023-09-24T20:37:09.596Z"},"maintainers":[{"name":"1ojames","email":"jameshuntdevelopment@gmail.com"}],"keywords":[],"license":"ISC","readme":"<h1>useVerticalSwipeMinimum</h1>\n\n<p><code>useVerticalSwipeMinimum</code> is a React hook that allows you to detect vertical swiping gestures with a minimum threshold. It's a part of the <code>@1ohooks/swipeable</code> package and provides a simple way to respond to vertical swipe actions in your components.</p>\n\n<h2>Installation</h2>\n\n<p>To use <code>useVerticalSwipeMinimum</code>, you'll need to have React and the required swipe-related hooks installed in your project. You can add them to your project using npm or yarn:</p>\n\n<pre><code>npm install react\nnpm install @1ohooks/use-vertical-swipe-minimum\n# or\nyarn add react\nyarn add @1ohooks/use-vertical-swipe-minimum\n</code></pre>\n\n<h2>Usage</h2>\n\n<p>You can import <code>useVerticalSwipeMinimum</code> in your components like this:</p>\n\n<pre><code>import { useVerticalSwipeMinimum } from '@1ohooks/use-vertical-swipe-minimum';\n</code></pre>\n\n<p><code>useVerticalSwipeMinimum</code> accepts a few optional parameters:</p>\n\n- `minSwipe` (number): The minimum swipe distance required to trigger a swipe action (default is 50 pixels).\n- `onSwipeUp` (function): A callback function to be executed when a swipe up gesture is detected.\n- `onSwipeDown` (function): A callback function to be executed when a swipe down gesture is detected.\n\nHere's an example of how to use <code>useVerticalSwipeMinimum</code> in your component:</p>\n\n<pre><code>import React from 'react';\nimport { useVerticalSwipeMinimum } from '@1ohooks/use-vertical-swipe-minimum';\n\nconst MyComponent = () =&gt; {\n  const handleSwipeUp = () =&gt; {\n    // Handle swipe up action here\n  };\n\n  const handleSwipeDown = () =&gt; {\n    // Handle swipe down action here\n  };\n\n  useVerticalSwipeMinimum(50, handleSwipeUp, handleSwipeDown);\n\n  return (\n    &lt;div&gt;\n      {/* Your component content */}\n    &lt;/div&gt;\n  );\n};\n\nexport default MyComponent;\n</code></pre>\n\n<p>This code snippet demonstrates how to use <code>useVerticalSwipeMinimum</code> to detect vertical swipes and trigger custom actions when swipes occur.</p>\n\n<h2>Contributing</h2>\n\n<p>Contributions are welcome! If you have suggestions, bug reports, or would like to contribute code, please visit the GitHub repository for <code>@1ohooks/swipeable</code>.</p>\n\n<h2>License</h2>\n\n<p>This package is licensed under the ISC License. Please refer to the <a href=\"https://github.com/1ohooks/swipeable/blob/main/LICENSE\">LICENSE</a> file for details.</p>","readmeFilename":"readme.md","description":"<h1>useVerticalSwipeMinimum</h1>"}