events

events.js

Members

(inner) _supportsPassive

Whether passive event listeners are supported

(inner, constant) passiveEvents

Touch events Chrome expects to be passive

Methods

(static) any(elem, type, fn)

Trigger a listener only once and then turn if off for all configured events

Parameters:
NameTypeDescription
elemElement | Object

Element or object to bind to.

typestring | Array.<string>

Name/type of event

fnEvent~EventListener

Event listener function

(static) fixEvent(event) → {Object}

Fix a native event to have standard property values

Parameters:
NameTypeDescription
eventObject

Event object to fix.

Returns:

Fixed event object.

Type: 
Object

(static) off(elem, typeopt, fnopt)

Removes event listeners from an element

Parameters:
NameTypeAttributesDescription
elemElement | Object

Object to remove listeners from.

typestring | Array.<string><optional>

Type of listener to remove. Don't include to remove all events from element.

fnfunction<optional>

Specific listener to remove. Don't include to remove listeners for an event type.

(static) on(elem, type, fn)

Add an event listener to element It stores the handler function in a separate cache object and adds a generic handler to the element's event, along with a unique id (guid) to the element.

Parameters:
NameTypeDescription
elemElement | Object

Element or object to bind listeners to

typestring | Array.<string>

Type of event to bind to.

fnfunction

Event listener.

(static) one(elem, type, fn)

Trigger a listener only once for an event.

Parameters:
NameTypeDescription
elemElement | Object

Element or object to bind to.

typestring | Array.<string>

Name/type of event

fnEvent~EventListener

Event listener function

(static) trigger(elem, event, hashopt) → {boolean|undefined}

Trigger an event for an element

Parameters:
NameTypeAttributesDescription
elemElement | Object

Element to trigger an event on

eventEventTarget~Event | string

A string (the type) or an event object with a type attribute

hashObject<optional>

data hash to pass along with the event

Returns:

Returns the opposite of defaultPrevented if default was prevented. Otherwise, returns undefined

Type: 
boolean | undefined

(inner) _cleanUpEvents(elem, type)

Clean up the listener cache and dispatchers

Parameters:
NameTypeDescription
elemElement | Object

Element to clean up

typestring

Type of event to clean up

(inner) _handleMultipleEvents(fn, elem, types, callback)

Loops through an array of event types and calls the requested method for each type.

Parameters:
NameTypeDescription
fnfunction

The event method we want to use.

elemElement | Object

Element or object to bind listeners to

typesArray.<string>

Type of event to bind to.

callbackfunction

Event listener.