Black Lives Matter. Support the Equal Justice Initiative.
NAV

interact

Methods

(static) isSet(element) → {boolean}

Check if an element or selector has been set with the interact function

Source:
Parameters:
NameTypeDescription
elementElement

The Element being searched for

Returns:
Type:
boolean

Indicates if the element or CSS selector was previously passed to interact

(static) maxInteractions(newValueopt)

Returns or sets the maximum number of concurrent interactions allowed. By default only 1 interaction is allowed at a time (for backwards compatibility). To allow multiple interactions on the same Interactables and elements, you need to enable it in the draggable, resizable and gesturable 'max' and 'maxPerElement' options.

Source:
Parameters:
NameTypeAttributesDescription
newValuenumber<optional>

Any number. newValue <= 0 means no interactions.

(static) off(type, listener, options) → {object}

Removes a global InteractEvent listener or DOM event from document

Source:
Parameters:
NameTypeDescription
typestring | array | object

The types of events that were listened for

listenerfunction

The listener function to be removed

optionsobject | boolean

[options] object or useCapture flag for removeEventListener

Returns:
Type:
object

interact

(static) on(type, listener, optionsopt) → {object}

Add a global listener for an InteractEvent or adds a DOM event to document

Source:
Parameters:
NameTypeAttributesDescription
typestring | array | object

The types of events to listen for

listenerfunction

The function event (s)

optionsobject | boolean<optional>

object or useCapture flag for addEventListener

Returns:
Type:
object

interact

(static) pointerMoveTolerance(newValueopt) → {interact|number}

Returns or sets the distance the pointer must be moved before an action sequence occurs. This also affects tolerance for tap events.

Source:
Parameters:
NameTypeAttributesDescription
newValuenumber<optional>

The movement from the start position must be greater than this value

Returns:
Type:
interact | number

(static) stop() → {object}

Cancels all interactions (end events are not fired)

Source:
Returns:
Type:
object

interact

(static) supportsPointerEvent() → {boolean}

Source:
Returns:
Type:
boolean

Whether or not the browser supports PointerEvents

(static) supportsTouch() → {boolean}

Source:
Returns:
Type:
boolean

Whether or not the browser supports touch input

(static) use(plugin) → {Interact.InteractStatic}

Use a plugin

Source:
Parameters:
NameTypeDescription
pluginObject
NameTypeDescription
installfunction
Returns:
Type:
Interact.InteractStatic