API Docs for: 1.0b
Show:

Events Class

Defined in: src/Events/Events.js:124
Module: Events

Events Provider.

Can function either as a standalone or a Mixin

Constructor

Events

(
  • el
)

Defined in src/Events/Events.js:124

Parameters:

  • el Element

    element to use as event target. Optional

Methods

addEvent

(
  • the
  • a
)
chainable

Defined in src/Events/Events.js:276

Adds an event

Parameters:

  • the String

    event type

  • a Function

    function to add

addEventOnce

(
  • the
  • a
)
chainable

Defined in src/Events/Events.js:387

Adds an event for one execution, then removes it

Parameters:

  • the String

    event type

  • a Function

    function to add

addEvents

(
  • literal
)
chainable

Defined in src/Events/Events.js:306

Helper to add multiple events at once

Parameters:

  • literal Object

    object of event types => callbacks

Events.createEvent

(
  • type
  • dispatcher
  • args
)
private static

Defined in src/Events/Events.js:87

cross-browser function to create event object for fire method

Created object will always have following properties: - dispatcher: a reference to dispatching object (since we can't use 'this') - args: arguments passed alongside the event - object_event: a flag set to true to easily check if this is an object event or a normal DOM event.

Parameters:

  • type String
  • dispatcher Object
  • args Mixed

Returns:

event object

Events.removeOn

(
  • type
)
String static

Defined in src/Events/Events.js:35

removes the on* prefix from event names

Parameters:

  • type String

Returns:

String:

fireEvent

(
  • event
  • arguments
)
chainable

Defined in src/Events/Events.js:325

dispatches an event

Parameters:

  • event String

    type

  • arguments Mixed

    to pass with the event

fireLatchedEvent

(
  • the
  • arguments
)
chainable

Defined in src/Events/Events.js:409

Fires a latched event

Parameters:

  • the String

    event type

  • arguments Mixed

    to pass with the event

getPseudo

(
  • type
)
Object private static

Defined in src/Events/Events.js:50

returns a structured data object about a type's pseudo-events

Parameters:

  • type String

Returns:

Object: data

processType

(
  • type
)
Object private static

Defined in src/Events/Events.js:73

proccesses an event type, returning a valid data object from that name

Parameters:

  • type String

Returns:

Object: data

removeEvent

(
  • event
  • function
)
chainable

Defined in src/Events/Events.js:364

removes a function from an event

Parameters:

  • event String

    type

  • function Function

    to remove from stack