UNPKG

hammerjs

Version:

A javascript library for multi-touch gestures

222 lines (134 loc) 7.05 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Touch - Hammer.JS</title> <link rel="stylesheet" href="http://yui.yahooapis.com/3.8.0pr2/build/cssgrids/cssgrids-min.css"> <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> <script src="http://yui.yahooapis.com/combo?3.8.0pr2/build/yui/yui-min.js"></script> </head> <body class="yui3-skin-sam"> <div id="doc"> <div id="hd" class="yui3-g header"> <div class="yui3-u-3-4"> <h1><a href="../index.html">Hammer.JS: Touch</a></h1> </div> <div class="yui3-u-1-4 version"> <em>API Docs for: 1.1.0</em> </div> </div> <div class="yui3-g"> <div id="sidebar" class="yui3-u"> <div id="modules" class="sidebox"> <div class="hd"> <h2 class="no-toc">Modules</h2> </div> <div class="bd"> <ul> <li><a href="../modules/gestures.html">gestures</a> </li> <li><a href="../modules/hammer.html">hammer</a> </li> </ul> </div> </div> <div id="classes" class="sidebox"> <div class="hd"> <h2 class="no-toc">Classes</h2> </div> <div class="bd"> <ul> <li><a href="../classes/Detection.html">Detection</a></li> <li><a href="../classes/Drag.html">Drag</a></li> <li><a href="../classes/Event.html">Event</a></li> <li><a href="../classes/Gesture.html">Gesture</a></li> <li><a href="../classes/Hammer.html">Hammer</a></li> <li><a href="../classes/Hold.html">Hold</a></li> <li><a href="../classes/Instance.html">Instance</a></li> <li><a href="../classes/PointerEvent.html">PointerEvent</a></li> <li><a href="../classes/Release.html">Release</a></li> <li><a href="../classes/Swipe.html">Swipe</a></li> <li><a href="../classes/Tap.html">Tap</a></li> <li><a href="../classes/Touch.html">Touch</a></li> <li><a href="../classes/Transform.html">Transform</a></li> <li><a href="../classes/Utils.html">Utils</a></li> </ul> </div> </div> <div id="events-on-page" class="sidebox on-page"> <div class="hd"> <h2 class="no-toc">Events On Page</h2> </div> <div class="bd"> <ul> <li><a href="#events_touch">touch</a></li> </ul> </div> </div> <div id="fileTree" class="sidebox"> <div class="hd"> <h2 class="no-toc">Files</h2> </div> <div class="bd"> <ul><li>src/<ul><li><a href="../files/src_detection.js.html">detection.js</a></li><li><a href="../files/src_event.js.html">event.js</a></li><li><a href="../files/src_export.js.html">export.js</a></li><li>gestures/<ul><li><a href="../files/src_gestures_drag.js.html">drag.js</a></li><li><a href="../files/src_gestures_gesture.js.html">gesture.js</a></li><li><a href="../files/src_gestures_hold.js.html">hold.js</a></li><li><a href="../files/src_gestures_release.js.html">release.js</a></li><li><a href="../files/src_gestures_swipe.js.html">swipe.js</a></li><li><a href="../files/src_gestures_tap.js.html">tap.js</a></li><li><a href="../files/src_gestures_touch.js.html">touch.js</a></li><li><a href="../files/src_gestures_transform.js.html">transform.js</a></li></ul></li><li><a href="../files/src_instance.js.html">instance.js</a></li><li><a href="../files/src_pointerevent.js.html">pointerevent.js</a></li><li><a href="../files/src_setup.js.html">setup.js</a></li><li><a href="../files/src_utils.js.html">utils.js</a></li></ul></li></ul> </div> </div> </div> <div id="main" class="yui3-u"> <div class="content"><h4>Class Touch</h4> <span class="foundat">Class defined in: <a href="../files/src_gestures_touch.js.html#l4"><code>src&#x2F;gestures&#x2F;touch.js:4</code></a></span> <div class="intro"><p>when a touch is being touched at the page</p> </div> <div id="classdocs"> <ul> <li><a href="#props">Properties</a></li> <li><a href="#events">Events</a></li> </ul> <div> <div id="props"> <a name="props_prevent_default"></a> <div class="props item"> <code>prevent_default</code> &lt;<strong><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></strong>&gt; <br> <span class="foundat"><a href="../files/src_gestures_touch.js.html#l18"><code>src&#x2F;gestures&#x2F;touch.js:18</code></a></span> <p>call preventDefault at touchstart, and makes the element blocking by disabling the scrolling of the page, but it improves gestures like transforming and dragging. be careful with using this, it can be very annoying for users to be stuck on the page</p> <strong>Default:</strong> false </div> <a name="props_prevent_mouseevents"></a> <div class="props item"> <code>prevent_mouseevents</code> &lt;<strong><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></strong>&gt; <br> <span class="foundat"><a href="../files/src_gestures_touch.js.html#l28"><code>src&#x2F;gestures&#x2F;touch.js:28</code></a></span> <p>disable mouse events, so only touch (or pen!) input triggers events</p> <strong>Default:</strong> false </div> </div> <div id="events"> <a name="events_touch"></a> <div class="events item"> <code>touch</code> <br> <span class="foundat"><a href="../files/src_gestures_touch.js.html#l10"><code>src&#x2F;gestures&#x2F;touch.js:10</code></a></span> <strong>Extra event object properties:</strong> <ul> <li> <code>ev</code> <strong>&lt;<a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a>&gt;</strong> </li> </ul> </div> </div> </div> </div> </div> </div> </div> </div> <script src="../assets/vendor/prettify/prettify-min.js"></script> <script>prettyPrint();</script> <script src="../assets/js/yui-prettify.js"></script> <script src="../assets/js/tabs.js"></script> </body> </html>