index.html 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Home - 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. <section class="readme">
  26. <article><h1>TouchSwipe 1.6</h1><p>A jQuery plugin to be used on touch devices such as iPad, iPhone, Android etc.</p>
  27. <p>Detects single and multiple finger swipes, pinches and falls back to mouse 'drags' on the desktop.</p>
  28. <p>Time and distance thresholds can be set to distinguish between swipe gesture and slow drag.</p>
  29. <p>Allows exclusion of child elements (interactive elements) as well allowing page scrolling or page zooming depending on configuration.</p>
  30. <ul>
  31. <li>Detects swipes in 4 directions, &quot;up&quot;, &quot;down&quot;, &quot;left&quot; and &quot;right&quot;</li>
  32. <li>Detects pinches &quot;in&quot; and &quot;out&quot;</li>
  33. <li>Supports single finger or double finger touch events</li>
  34. <li>Supports click events both on the touchSwipe object and its child objects</li>
  35. <li>Definable threshold / maxTimeThreshold to determin when a gesture is actually a swipe</li>
  36. <li>Events triggered for swipe &quot;start&quot;,&quot;move&quot;,&quot;end&quot; and &quot;cancel&quot;</li>
  37. <li>End event can be triggered either on touch release, or as soon as threshold is met</li>
  38. <li>Allows swiping and page scrolling</li>
  39. <li>Disables user input elements (Button, form, text etc) from triggering swipes</li>
  40. </ul>
  41. <h2>Demos, examples and docs</h2><p><a href="http://labs.rampinteractive.co.uk/touchSwipe">http://labs.rampinteractive.co.uk/touchSwipe</a><br><a href="http://labs.rampinteractive.co.uk/touchSwipe/docs">http://labs.rampinteractive.co.uk/touchSwipe/docs</a></p>
  42. <h2>Installation</h2><h3>NPM</h3><pre class="prettyprint source lang-bash"><code>npm install jquery-touchswipe --save</code></pre><h3>Bower</h3><pre class="prettyprint source lang-bash"><code>bower install jquery-touchswipe --save</code></pre><h3>Manual</h3><p>Include the minified file in your project.</p>
  43. <pre class="prettyprint source lang-html"><code>&lt;script type=&quot;text/javascript&quot; src=&quot;js/jquery.touchSwipe.min.js&quot;>&lt;/script></code></pre><h2>Usage</h2><pre class="prettyprint source lang-javascript"><code>$(function() {
  44. $(&quot;#test&quot;).swipe( {
  45. //Generic swipe handler for all directions
  46. swipe:function(event, direction, distance, duration, fingerCount, fingerData) {
  47. $(this).text(&quot;You swiped &quot; + direction );
  48. }
  49. });
  50. //Set some options later
  51. $(&quot;#test&quot;).swipe( {fingers:2} );
  52. });</code></pre><p>For full demos, code examples and documentation, see below.</p>
  53. <h2>Development</h2><p>Install dependencies</p>
  54. <pre class="prettyprint source lang-bash"><code>npm install</code></pre><p>To minify</p>
  55. <pre class="prettyprint source lang-bash"><code>npm run minify</code></pre><p>To build docs</p>
  56. <pre class="prettyprint source lang-bash"><code>npm run docs</code></pre><p>To do both</p>
  57. <pre class="prettyprint source lang-bash"><code>npm run build</code></pre><h3>For port to XUI see:</h3><p>https://github.com/cowgp/xui-touchSwipe</p></article>
  58. </section>
  59. </div>
  60. <br class="clear">
  61. <footer>
  62. 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.
  63. </footer>
  64. <script>prettyPrint();</script>
  65. <script src="scripts/linenumber.js"></script>
  66. </body>
  67. </html>