Gestures

Methods

(inner) setupMobileSwipeGestures(gestureZone, gestureCallback)

Setup mobile function gestures on swipe
Source:
Parameters:
Name Type Description
gestureZone string CSS selector for the zone to apply the gestures to
gestureCallback mobileGestureCallback callback to run on swipe

(inner) setupMouseWheelEvents(timeoutDelay, callback, scrollableElement)

Setup mouse wheel gestures, returns callback when mousewheel is scrolled up or down
Source:
Parameters:
Name Type Description
timeoutDelay number Time in ms before the next scroll can fire
callback mouseWheelScrollCallback callback to run on mouse scroll
scrollableElement HTMLElement Fire callbacks only when target HTML Element is already scrolled to the top or bottom

Type Definitions

mobileGestureCallback(direction)

This callback is executed when a mobile swipe gesture occurs
Source:
Parameters:
Name Type Description
direction string returns 'up' or 'down' or 'left' or 'right

mobileGestureCallback()

This callback is used to cancel the gesture, return true or false
Source:

mouseWheelScrollCallback(direction)

This callback is executed when any mousewheel action occurs
Source:
Parameters:
Name Type Description
direction string returns 'up' or 'down'

Methods

(inner) setupMobileSwipeGestures(gestureZone, gestureCallback)

Setup mobile function gestures on swipe
Source:
Parameters:
Name Type Description
gestureZone string CSS selector for the zone to apply the gestures to
gestureCallback mobileGestureCallback callback to run on swipe

(inner) setupMouseWheelEvents(timeoutDelay, callback, scrollableElement)

Setup mouse wheel gestures, returns callback when mousewheel is scrolled up or down
Source:
Parameters:
Name Type Description
timeoutDelay number Time in ms before the next scroll can fire
callback mouseWheelScrollCallback callback to run on mouse scroll
scrollableElement HTMLElement Fire callbacks only when target HTML Element is already scrolled to the top or bottom

Type Definitions

mobileGestureCallback(direction)

This callback is executed when a mobile swipe gesture occurs
Source:
Parameters:
Name Type Description
direction string returns 'up' or 'down' or 'left' or 'right

mobileGestureCallback()

This callback is used to cancel the gesture, return true or false
Source:

mouseWheelScrollCallback(direction)

This callback is executed when any mousewheel action occurs
Source:
Parameters:
Name Type Description
direction string returns 'up' or 'down'