lism
Version:
Collection of TypeScript Utilities to help developers streamline their coding workflow.
16 lines (14 loc) • 11.1 kB
HTML
<html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useTouchLeaveRadius | lism</title><meta name="description" content="Documentation for lism"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">lism</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">lism</a></li><li><a href="useTouchLeaveRadius.html">useTouchLeaveRadius</a></li></ul><h1>Function useTouchLeaveRadius</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A custom React hook for detecting if a touch event has left a specified radius.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws" class="tsd-anchor"></a>Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Throws an error if the <code>radius</code> parameter is less than or equal to 0.</p>
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-0">ExampleComponent</span><span class="hl-1"> = () </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-6">delta</span><span class="hl-1">, </span><span class="hl-6">isLeave</span><span class="hl-1">, </span><span class="hl-6">handleTouchStart</span><span class="hl-1">, </span><span class="hl-6">handleTouchMove</span><span class="hl-1">, </span><span class="hl-6">handleTouchEnd</span><span class="hl-1"> } = </span><span class="hl-0">useTouchLeaveRadius</span><span class="hl-1">(</span><span class="hl-4">20</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-13">return</span><span class="hl-1"> (</span><br/><span class="hl-1"> <</span><span class="hl-8">div</span><br/><span class="hl-1"> </span><span class="hl-8">onTouchStart</span><span class="hl-1">={</span><span class="hl-8">handleTouchStart</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-8">onTouchMove</span><span class="hl-1">={</span><span class="hl-8">handleTouchMove</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-8">onTouchEnd</span><span class="hl-1">={</span><span class="hl-8">handleTouchEnd</span><span class="hl-1">}</span><br/><span class="hl-1"> ></span><br/><span class="hl-1"> </span><span class="hl-8">Touch</span><span class="hl-1"> </span><span class="hl-8">and</span><span class="hl-1"> </span><span class="hl-8">move</span><span class="hl-1"> </span><span class="hl-5">this</span><span class="hl-1"> </span><span class="hl-8">element</span><span class="hl-1"> </span><span class="hl-5">in</span><span class="hl-1"> </span><span class="hl-8">a</span><span class="hl-1"> </span><span class="hl-8">mobile</span><span class="hl-1"> </span><span class="hl-8">browser</span><span class="hl-1">.</span><br/><span class="hl-1"> <</span><span class="hl-7">p</span><span class="hl-1">></span><span class="hl-8">Delta</span><span class="hl-1">: </span><span class="hl-7">X</span><span class="hl-1">: {</span><span class="hl-7">delta</span><span class="hl-1">.</span><span class="hl-8">x</span><span class="hl-1">}, </span><span class="hl-8">Y</span><span class="hl-1">: {</span><span class="hl-7">delta</span><span class="hl-1">.</span><span class="hl-8">y</span><span class="hl-1">}</</span><span class="hl-7">p</span><span class="hl-1">></span><br/><span class="hl-1"> {</span><span class="hl-8">isLeave</span><span class="hl-1"> && <</span><span class="hl-8">p</span><span class="hl-1">></span><span class="hl-8">You</span><span class="hl-1"> </span><span class="hl-8">have</span><span class="hl-1"> </span><span class="hl-8">left</span><span class="hl-1"> </span><span class="hl-8">the</span><span class="hl-1"> </span><span class="hl-8">specified</span><span class="hl-1"> </span><span class="hl-8">radius</span><span class="hl-1">!</</span><span class="hl-8">p</span><span class="hl-1">>}</span><br/><span class="hl-1"> </</span><span class="hl-8">div</span><span class="hl-1">></span><br/><span class="hl-1"> );</span><br/><span class="hl-1">};</span>
</code><button type="button">Copy</button></pre>
</div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="usetouchleaveradius" class="tsd-anchor"></a><span class="tsd-kind-call-signature">useTouchLeaveRadius</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">radius</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UseTouchLeaveRadiusResult</span><a href="#usetouchleaveradius" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">radius</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The radius (in pixels) within which the touch event is considered inside. Must be greater than 0.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UseTouchLeaveRadiusResult</span></h4><p>An object containing:</p>
<ul>
<li><code>delta</code>: An object representing the distance moved in the x and y directions.</li>
<li><code>isLeave</code>: A boolean indicating whether the touch event has left the specified radius.</li>
<li><code>handleTouchStart</code>: A callback function to handle the start of a touch event.</li>
<li><code>handleTouchMove</code>: A callback function to handle the movement of a touch event.</li>
<li><code>handleTouchEnd</code>: A callback function to handle the end of a touch event.</li>
</ul>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dragmove/lism/blob/bef8a264677aab4916acc17c4928479f350f3c7b/src/hooks/useTouchLeaveRadius.ts#L43">hooks/useTouchLeaveRadius.ts:43</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">lism</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>