ElementOutput

A base class for viewable content and event targets inside a Famo.us application, containing a renderable document fragment. Like an HTML div, it can accept internal markup, properties, classes, and handle events.

Overview

Options
Methods
on
removeListener
emit
pipe
unpipe

ElementOutput(element)

Constructor Parameters

element

Node

document parent of this container

Methods

on(type, fn)

Bind a callback function to an event type handled by this object.

Parameters
type
String
event type key (for example, 'click')
fn
Function(string, Object)
handler callback
Returns
EventHandler
this

removeListener(type, fn)

Unbind an event by type and handler. This undoes the work of "on"

Parameters
type
String
event type key (for example, 'click')
fn
Function(string, Object)
handler

emit(type, event)

Trigger an event, sending to all downstream handlers listening for provided 'type' key.

Parameters
type
String
event type key (for example, 'click')
event
Object
event data
Returns
EventHandler
this

pipe(target)

Add event handler object to set of downstream handlers.

Parameters
target
EventHandler
event handler target object
Returns
EventHandler
passed event handler

unpipe(target)

Remove handler object from set of downstream handlers. Undoes work of "pipe"

Parameters
target
EventHandler
target handler object
Returns
EventHandler
provided target