tutorial-Trigger_handlers.html 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Tutorial: Trigger handlers - Documentation</title>
  6. <script src="scripts/prettify/prettify.js"></script>
  7. <script src="scripts/prettify/lang-css.js"></script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
  12. <link type="text/css" rel="stylesheet" href="styles/prettify.css">
  13. <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
  14. </head>
  15. <body>
  16. <input type="checkbox" id="nav-trigger" class="nav-trigger" />
  17. <label for="nav-trigger" class="navicon-button x">
  18. <div class="navicon"></div>
  19. </label>
  20. <label for="nav-trigger" class="overlay"></label>
  21. <nav>
  22. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="$.html">$</a></li><li><a href="$.fn.html">fn</a></li><li><a href="$.fn.swipe.html">swipe</a><ul class='methods'><li data-type='method'><a href="$.fn.swipe.html#destroy">destroy</a></li><li data-type='method'><a href="$.fn.swipe.html#disable">disable</a></li><li data-type='method'><a href="$.fn.swipe.html#enable">enable</a></li><li data-type='method'><a href="$.fn.swipe.html#option">option</a></li></ul></li></ul><h3>Events</h3><ul><li><a href="$.fn.swipe.html#event:click">click</a></li><li><a href="$.fn.swipe.html#event:doubleTap">doubleTap</a></li><li><a href="$.fn.swipe.html#event:hold">hold</a></li><li><a href="$.fn.swipe.html#event:longTap">longTap</a></li><li><a href="$.fn.swipe.html#event:pinchIn">pinchIn</a></li><li><a href="$.fn.swipe.html#event:pinchOut">pinchOut</a></li><li><a href="$.fn.swipe.html#event:pinchStatus">pinchStatus</a></li><li><a href="$.fn.swipe.html#event:swipe">swipe</a></li><li><a href="$.fn.swipe.html#event:swipeDown">swipeDown</a></li><li><a href="$.fn.swipe.html#event:swipeLeft">swipeLeft</a></li><li><a href="$.fn.swipe.html#event:swipeRight">swipeRight</a></li><li><a href="$.fn.swipe.html#event:swipeStatus">swipeStatus</a></li><li><a href="$.fn.swipe.html#event:swipeUp">swipeUp</a></li><li><a href="$.fn.swipe.html#event:tap">tap</a></li></ul><h3>Namespaces</h3><ul><li><a href="$.fn.swipe.defaults.html">defaults</a></li><li><a href="$.fn.swipe.directions.html">directions</a></li><li><a href="$.fn.swipe.fingers.html">fingers</a></li><li><a href="$.fn.swipe.pageScroll.html">pageScroll</a></li><li><a href="$.fn.swipe.phases.html">phases</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-Any_finger_swipe.html">Any finger swipe</a></li><li><a href="tutorial-Basic_swipe.html">Basic swipe</a></li><li><a href="tutorial-Enable_and_destroy.html">Enable and destroy</a></li><li><a href="tutorial-Excluded_children.html">Excluded children</a></li><li><a href="tutorial-Finger_swipe.html">Finger swipe</a></li><li><a href="tutorial-Handlers_and_events.html">Handlers and events</a></li><li><a href="tutorial-Hold.html">Hold</a></li><li><a href="tutorial-Image_gallery_example.html">Image gallery example</a></li><li><a href="tutorial-Options.html">Options</a></li><li><a href="tutorial-Page_scrolling.html">Page scrolling</a></li><li><a href="tutorial-Page_zoom.html">Page zoom</a></li><li><a href="tutorial-Pinch.html">Pinch</a></li><li><a href="tutorial-Pinch_and_Swipe.html">Pinch and Swipe</a></li><li><a href="tutorial-Pinch_status.html">Pinch status</a></li><li><a href="tutorial-Single_swipe.html">Single swipe</a></li><li><a href="tutorial-Stop_propegation.html">Stop_propegation</a></li><li><a href="tutorial-Swipe_status.html">Swipe status</a></li><li><a href="tutorial-Tap_vs_swipe.html">Tap vs swipe</a></li><li><a href="tutorial-Thresholds.html">Thresholds</a></li><li><a href="tutorial-Trigger_handlers.html">Trigger handlers</a></li><li><a href="tutorial-index_.html">index</a></li></ul>
  23. </nav>
  24. <div id="main">
  25. <h1 class="page-title">Tutorial: Trigger handlers</h1>
  26. <section>
  27. <header>
  28. <h2>Trigger handlers</h2>
  29. </header>
  30. <article>
  31. <!DOCTYPE HTML>
  32. <html>
  33. <head>
  34. <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
  35. <meta http-equiv="x-ua-compatible" content="IE=9">
  36. <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/css/bootstrap-combined.min.css" rel="stylesheet">
  37. <link href="http://twitter.github.com/bootstrap/assets/js/google-code-prettify/prettify.css" rel="stylesheet" />
  38. <link href="css/main.css" type="text/css" rel="stylesheet" />
  39. <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>
  40. <script type="text/javascript" src="https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js"></script>
  41. <script type="text/javascript" src="../jquery.touchSwipe.js"></script>
  42. <script type="text/javascript" src="js/main.js"></script>
  43. <title>touchSwipe</title>
  44. </head>
  45. <body>
  46. <a href="https://github.com/mattbryson"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png" alt="Fork me on GitHub"></a>
  47. <div class="container">
  48. <script id='code_1'>
  49. $(function() {
  50. //Enable swiping...
  51. $("#test").swipe( {
  52. swipeStatus:function(event, phase, direction, distance)
  53. {
  54. var str = "";
  55. if (phase=="move")
  56. str="You have moved " + distance +" pixels, past 200 and the handler will fire";
  57. if (phase=="end")
  58. str="Handler fired, you swiped " + direction;
  59. $(this).text(str);
  60. },
  61. triggerOnTouchEnd:false,
  62. threshold:200
  63. });
  64. });
  65. </script>
  66. <script id='code_2'>
  67. $(function() {
  68. $("#test2").swipe( {
  69. swipeStatus:function(event, phase, direction, distance, duration)
  70. {
  71. var str = "";
  72. if (phase=="move")
  73. str="You have moved for " + duration +" ms, If you go over 5000 the swipe will cancel";
  74. if (phase=="cancel")
  75. str="You took to long and the swipe was canceled";
  76. if (phase=="end")
  77. str="Handler fired, you swiped " + direction;
  78. $(this).text(str);
  79. },
  80. triggerOnTouchEnd:false,
  81. maxTimeThreshold:5000,
  82. threshold:null
  83. });
  84. });
  85. </script>
  86. <script id='code_3'>
  87. $(function() {
  88. $("#test3").swipe( {
  89. swipeStatus:function(event, phase, direction, distance, duration)
  90. {
  91. var str = "";
  92. if (phase=="move")
  93. str="You have moved " + distance +" px, If you leave the swipe object, the swipe will end";
  94. if (phase=="end")
  95. str="The swipe has ended"
  96. $(this).text(str);
  97. },
  98. triggerOnTouchLeave:true,
  99. threshold:null
  100. });
  101. });
  102. </script>
  103. <script id='code_4'>
  104. $(function() {
  105. $("#test4").swipe( {
  106. swipeStatus:function(event, phase, direction, distance, duration)
  107. {
  108. var str = "";
  109. if (phase=="move") {
  110. str="You have moved " + distance +" pixels, past 200 and the handler will fire <br/>";
  111. str+="You have moved for " + duration +" ms, If you go over 5000 the swipe will cancel <br/>";
  112. str+="If you leave the swipe object, and have made the distance, the swipe will end <br/>";
  113. str+="If you leave the swipe object, and have NOT made the distance, the swipe will cancel ";
  114. }
  115. if (phase=="end") {
  116. str="Handler fired, you met the thresholds:<br/>";
  117. str+=distance+"px (over 500px required) <br/>";
  118. str+=duration+"ms (under 5000ms required) <br/>";
  119. }
  120. if (phase=="cancel") {
  121. str="You didn't meet the thresholds, cancel was fired:<br/>";
  122. str+=distance+"px (over 500px required) <br/>";
  123. str+=duration+"ms (under 5000ms required) <br/>";
  124. }
  125. $(this).html(str);
  126. },
  127. triggerOnTouchEnd:false,
  128. triggerOnTouchLeave:true,
  129. maxTimeThreshold:5000,
  130. threshold:500
  131. });
  132. });
  133. </script>
  134. <span class='title'></span>
  135. <h4>properties: <span class='properties'><code>triggerOnTouchEnd</code>, <code>triggerOnTouchLeave</code></span></h4>
  136. <p>With <code>triggerOnTouchEnd</code> you can trigger the <code>swipe</code> end handler either when the user releases (default) or when the user has swiped the distance / time of the thresholds (but is still swiping).</p>
  137. <p>With <code>triggerOnTouchLeave</code> you can end the event if the user swipes off the element</p>
  138. <p>Swipe below, and the swipeEnd handler will trigger when you have swiped 200 px.</p>
  139. <button class='btn btn-small btn-info example_btn'>Jump to Example</button>
  140. <pre class="prettyprint lang-js" data-src="code_1"></pre>
  141. <script>getNavigation();</script>
  142. <div id="test" class="box">Swipe over 200px and the swipe event will fire</div>
  143. <pre class="prettyprint lang-js" data-src="code_2"></pre>
  144. <span class='navigation'></span>
  145. <div id="test2" class="box">Swipe in under 5000ms and the swipe event will fire</div>
  146. <pre class="prettyprint lang-js" data-src="code_3"></pre>
  147. <span class='navigation'></span>
  148. <div id="test3" class="box">Swipe out of this box and the swipe event will end</div>
  149. <pre class="prettyprint lang-js" data-src="code_4"></pre>
  150. <span class='navigation'></span>
  151. <div id="test4" class="box">Time, distance and trigger on END and trigger on Leave set..</div>
  152. <span class='navigation'></span>
  153. </div>
  154. </body>
  155. </html>
  156. </article>
  157. </section>
  158. </div>
  159. <br class="clear">
  160. <footer>
  161. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 17 2018 13:09:45 GMT+0100 (British Summer Time) using the docdash theme.
  162. </footer>
  163. <script>prettyPrint();</script>
  164. <script src="scripts/linenumber.js"></script>
  165. </body>
  166. </html>