swipe

Categories: Events

swipe eventversion added: 1.0

Description: Triggered when a horizontal drag of 30px or more (and less than 30px vertically) occurs within 1 second duration.

  • jQuery( window ).on( "swipe", function( event ) { ... } )

Triggered when a horizontal drag of 30px or more (and less than 30px vertically) occurs within 1 second duration but these can be configured:

  • $.event.special.swipe.scrollSupressionThreshold (default: 10px) – More than this horizontal displacement, and we will suppress scrolling.
  • $.event.special.swipe.durationThreshold (default: 1000ms) – More time than this, and it isn't a swipe.
  • $.event.special.swipe.horizontalDistanceThreshold (default: 30px) – Swipe horizontal displacement must be more than this.
  • $.event.special.swipe.verticalDistanceThreshold (default: 30px) – Swipe vertical displacement must be less than this.

The swipe event can also be extend to add your own logic or functionality. The following methods can be extended:

  • $.event.special.swipe.start Default:
    1
    2
    3
    4
    5
    6
    7
    8
    9
    		 
    function( event ) {
      var data = event.originalEvent.touches ?
          event.originalEvent.touches[ 0 ] : event;
      return {
          time: ( new Date() ).getTime(),
          coords: [ data.pageX, data.pageY ],
          origin: $( event.target )
        };
    }

    This method recieves a touchstart event and returns an object of data about the starting location.

  • $.event.special.swipe.stop Default:
    1
    2
    3
    4
    5
    6
    7
    8
    		 
    function( event ) {
      var data = event.originalEvent.touches ?
          event.originalEvent.touches[ 0 ] : event;
      return {
          time: ( new Date() ).getTime(),
          coords: [ data.pageX, data.pageY ]
        };
    }

    This method recieves a touchend event and returns an object of data about the ending location.

  • $.event.special.swipe.handleSwipe Default:
    1
    2
    3
    4
    5
    6
    7
    8
    9
    		 
    function( start, stop ) {
      if ( stop.time - start.time < $.event.special.swipe.durationThreshold &&
        Math.abs( start.coords[ 0 ] - stop.coords[ 0 ] ) > $.event.special.swipe.horizontalDistanceThreshold &&
        Math.abs( start.coords[ 1 ] - stop.coords[ 1 ] ) < $.event.special.swipe.verticalDistanceThreshold ) {
     
        start.origin.trigger( "swipe" )
          .trigger( start.coords[0] > stop.coords[ 0 ] ? "swipeleft" : "swiperight" );
      }
    }

    This method recieves the start and stop objects and handles the logic for and triggering for the swipe events.

Example:

A simple example of the capturing and acting upon a swipe event

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>swipe demo</title>
  <link rel="stylesheet" href="//code.jquery.com/mobile/1.5.0-alpha.1/jquery.mobile-1.5.0-alpha.1.min.css">
  <script src="//code.jquery.com/jquery-3.2.1.min.js"></script>
  <script src="//code.jquery.com/mobile/1.5.0-alpha.1/jquery.mobile-1.5.0-alpha.1.min.js"></script>
  <style>
  html, body { padding: 0; margin: 0; }
  html, .ui-mobile, .ui-mobile body {
    height: 105px;
  }
  .ui-mobile, .ui-mobile .ui-page {
    min-height: 105px;
  }
  #nav {
    font-size: 200%;
    width:17.1875em;
    margin:17px auto 0 auto;
  }
  #nav a {
    color: #777;
    border: 2px solid #777;
    background-color: #ccc;
    padding: 0.2em 0.6em;
    text-decoration: none;
    float: left;
    margin-right: 0.3em;
  }
  #nav a:hover {
    color: #999;
    border-color: #999;
    background: #eee;
  }
  #nav a.selected,
  #nav a.selected:hover {
    color: #0a0;
    border-color: #0a0;
    background: #afa;
  }
  div.box {
    width: 30em;
    height: 3em;
    background-color: #108040;
  }
  div.box.swipe {
    background-color: #7ACEF4;
  }
  </style>
</head>
<body>
 
<h3>Swipe the green rectangle to change its color:</h3>
<div class="box"></div>
 
<script>
$(function(){
  // Bind the swipeHandler callback function to the swipe event on div.box
  $( "div.box" ).on( "swipe", swipeHandler );
 
  // Callback function references the event target and adds the 'swipe' class to it
  function swipeHandler( event ){
    $( event.target ).addClass( "swipe" );
  }
});
</script>
 
</body>
</html>

Demo: