JsDoc Reference - $.fn.swipe.defaults

# $.fn.swipe.defaults

Instance members

### Namespace

$.fn.swipe.defaults Static
The default configuration, and available options to configure touch swipe with. You can set the default values by updating any of the properties prior to instantiation. code »

### Instance members

#### Instance PropertiesDefined By

allowPageScroll : string|undefined (default = 'auto') $.fn.swipe.defaults
How the browser handles page scrolls when the user is swiping on a touchSwipe object. See $.fn.swipe.pageScroll.
`"auto"` : all undefined swipes will cause the page to scroll in that direction.
`"none"` : the page will not scroll when user swipes.
`"horizontal"` : will force page to scroll on horizontal swipes.
`"vertical"` : will force page to scroll on vertical swipes.
code »
cancelThreshold : int (default = null) $.fn.swipe.defaults
The number of pixels that the user must move their finger back from the original swipe direction to cancel the gesture. code »
doubleTap : function (default = null) $.fn.swipe.defaults
A handler triggered when a user double taps on the item. The delay between taps can be set with the doubleTapThreshold property. See $.fn.swipe.defaults#doubleTapThreshold code »
doubleTapThreshold : int (default = 200) $.fn.swipe.defaults
Time in milliseconds between 2 taps to count as a double tap code »
excludedElements : string (default = "button, input, select, textarea, a, .noSwipe") $.fn.swipe.defaults
A jquery selector that specifies child elements that do NOT trigger swipes. By default this excludes all form, input, select, button, anchor and .noSwipe elements. code »
fallbackToMouseEvents : boolean (default = true) $.fn.swipe.defaults
If true mouse events are used when run on a non touch device, false will stop swipes being triggered by mouse events on non tocuh devices. code »
fingerReleaseThreshold : int (default = 250) $.fn.swipe.defaults
Time in milliseconds between releasing multiple fingers. If 2 fingers are down, and are released one after the other, if they are within this threshold, it counts as a simultaneous release. code »
fingers : int (default = 1) $.fn.swipe.defaults
The number of fingers to detect in a swipe. Any swipes that do not meet this requirement will NOT trigger swipe handlers. code »
longTap : function (default = null) $.fn.swipe.defaults
A handler triggered when a user long taps on the item. The delay between start and end can be set with the longTapThreshold property. See $.fn.swipe.defaults#doubleTapThreshold code »
longTapThreshold : int (default = 500) $.fn.swipe.defaults
Time in milliseconds between tap and release for a long tap code »
maxTimeThreshold : int (default = null) $.fn.swipe.defaults
Time, in milliseconds, between touchStart and touchEnd must NOT exceed in order to be considered a swipe. code »
pinchIn : function (default = null) $.fn.swipe.defaults
A handler triggered for pinch in events. See $.fn.swipe#event:pinchIn code »
pinchOut : function (default = null) $.fn.swipe.defaults
A handler triggered for pinch out events. See $.fn.swipe#event:pinchOut code »
pinchStatus : function (default = null) $.fn.swipe.defaults
A handler triggered for every phase of a pinch. See $.fn.swipe#event:pinchStatus code »
pinchThreshold : int (default = 20) $.fn.swipe.defaults
The number of pixels that the user must pinch their finger by before it is considered a pinch. code »
swipe : function (default = null) $.fn.swipe.defaults
A handler to catch all swipes. See $.fn.swipe#event:swipe code »
swipeDown : function (default = null) $.fn.swipe.defaults
A handler that is triggered for "down" swipes. See $.fn.swipe#event:swipeDown code »
swipeLeft : function (default = null) $.fn.swipe.defaults
A handler that is triggered for "left" swipes. See $.fn.swipe#event:swipeLeft code »
swipeRight : function (default = null) $.fn.swipe.defaults
A handler that is triggered for "right" swipes. See $.fn.swipe#event:swipeRight code »
swipeStatus : function (default = null) $.fn.swipe.defaults
A handler triggered for every phase of the swipe. See $.fn.swipe#event:swipeStatus code »
swipeUp : function (default = null) $.fn.swipe.defaults
A handler that is triggered for "up" swipes. See $.fn.swipe#event:swipeUp code »
tap : function (default = null) $.fn.swipe.defaults
A handler triggered when a user just taps on the item, rather than swipes it. If they do not move, tap is triggered, if they do move, it is not. code »
threshold : int (default = 75) $.fn.swipe.defaults
The number of pixels that the user must move their finger by before it is considered a swipe. code »
triggerOnTouchEnd : boolean (default = true) $.fn.swipe.defaults
If true, the swipe events are triggered when the touch end event is received (user releases finger). If false, it will be triggered on reaching the threshold, and then cancel the touch event automatically. code »
triggerOnTouchLeave : boolean (default = false) $.fn.swipe.defaults
If true, then when the user leaves the swipe object, the swipe will end and trigger appropriate handlers. code »