outdooricon / backbone.courier

Easily bubble events up your view hierarchy in your Backbone.js applications.

Backbone.Courier

Easily bubble events ("messages") up your view hierarchy in your Backbone.js applications.

Benefits

• Provides a hierarchal message path through which views can communicate.
• Is designed to promote encapsulation of concerns, and does not rely on the use of application globals.
• Makes it easy to modify messages for larger contexts as they bubble up your view hierarchy.
• Takes advantage of existing DOM tree to automatically infer view hierarchy structure (by default).
• Allows child views to call functions on their parent views that return values.
• Fits together with Backbone.Subviews so parents can act on messages from particular children.

How it works

Include Backbone.Courier in your project. Now you can mixin Backbone.Courier to your views:

var myView = new Backbone.View();
Backbone.Courier.add( myView ); // add courier functionality to myView

A view spawns a message that is passed to its parent using View.spawn( messageName, [data] ):

myView.spawn( "selected", { 
	methodOfSelection: "click"  // application defined data
} );

The view's parent can then "handle" the message and / or pass it to the parent's own parent, and so on, up the view hierarchy. By default, the DOM tree is used to automatically infer the view hierarchy structure.

MyViewClass = Backbone.View.extend( {
	initialize : function() {
		Backbone.Courier.add( this );
	}

	// "handle" the "selected" message from any child view.
	onMessages : {
		"selected" : "_onChildSelected"
	}

	// pass the "selected" message from any child view up to this view's
	// parent, changing the message's name to "resourceSelected"
	passMessages : {
		"selected" : "resourceSelected"
	},

	_onChildSelected : function( message ) {
		alert( "My child view just spawned the 'selected' message." );

		// the message argument that is passed to message 
		// handlers has three properties. The name of the message:
		assert( message.name === "selected" );

		// any application defined data that has been supplied:
		assert( message.data.methodOfSelection === "click" );

		// and the child view object that spawned or 
		// passed this message (in this case, myView):
		assert( message.source instanceof Backbone.View );

		alert( "After I'm done here, because of the entry in my passMessages " +
			"hash, I'll change this message's name to 'resourceSelected', " + 
			"then pass it to my own parent view." );
	}

	// a separate example. messages can also be used to get dynamic
	// values from ancestors, without explicit dependencies.
	_getInfoFromAncestor : function() {
		// messages that end in "!" have return values. They must
		// be handled by an ancestor, or an error will be thrown.
		var info = this.spawn( "giveMeYourInfo!" );
	}
}

Methods and Property reference

Public API index

• Backbone.Courier.add( view ) - add courier functionality to view
• View.spawn( messageName, [data] ) - spawn a message to pass up the view hierarchy
• View.onMessages - (hash) determines how messages from child views are handled
• View.passMessages - (hash) determines how / which messages are passed on to the parent view

---

Backbone.Courier.add( view )

Adds courier methods and behavior, as described below, to the view object referenced by the argument.

View.spawn( messageName, [data] )

The spawn method generates a new message and passes it to the view's "parent", i.e. the closest ancestor of this view in the DOM tree. The parent view can then "handle" this message, taking some action upon its receipt, by including an entry for this message in its onMessages hash, and it can optionally pass this message to its own parent, using its passMessages hash. In this manner the message may bubble up the view hierarchy, as determined (by default) by the DOM tree.

messageName is the name of the message being spawned. The name is used in the onMessages and passMessages hashes of ancestor views to handle or pass the message further up the view hierarchy, respectively.

data is an application defined data object that will be available to this view's ancestors when handling or passing this message.

Round trip messages

If messageName ends in !, the message is considered a "round trip message". Round trip messages are special in that they return values. That is, the spawn() method will return the value returned by the first (and only) method that handles the message. Using round trip messages, views can obtain dynamic information about their environment that, because it is dynamic, can not be passed in through configuration options. Round trip messages have two other special characteristics:

• Round trip messages must be handled. If they are not handled by any ancestor view, an error will be thrown.
• Round trip messages will continue to be passed up the hierarchy until they are handled (no entry in the passMessages hash is required).

View.onMessages

The onMessages hash is the means by which a parent view can take action on, or "handle", messages received from its children. Entries in the onMessages hash are written in the format:

"messageName source" : callback

• The messageName portion is matched against the name of the messages that are received.
• The source portion can be used to match only messages that come from a particular child view. In order to map the source name to a particular child view, by default Backbone.Courier expects a hash of child views to be stored in view.subviews, the keys of the hash being the names of the child views, and the values references to the child view objects. You can create this hash yourself, but an easier approach is to use the Backbone.Subviews mixin, which will automatically create it for you. (You may also override View._getChildViewNamed() to customize how source mapped to child view objects.)
• The "callback" portion determines what is done when a matching message is received. Just like Backbone's events hash, you can either provide the callback as the name of a method on the view, or a direct function body. In either case, the message object is provided as the sole argument for the callback function. The message object always contains exactly three properties:
  1. message.name is the name of the message
  2. message.data is an application defined data object, as provided the in second argument to View.spawn()
  3. message.source is the child view object that spawned or passed this message to this view.

Example entries in the onMessages hash:

onMessages : {
	"focused" : function( message ) {
		// handle the "focused" message
		alert( "child view focused" );
		console.log( message.source ); // output child view that spawned or passed this message
	},

	// when the "selected" message from the resourcesCollectionView child view
	// is received, call the _onResourceSelected method on this view
	"selected resourcesCollectionView" : "_onResourceSelected",

	"giveMeInfo!" : function( message ) {
		// handle the "giveMeInfo!" round trip message. return contents
		// of `value` to the view that spawned the message,
		// as the return value of the view.spawn() method
		var value = this._calculateDynamicValue();
		return value;
	}
},

_onResourceSelected : function( message ) {
	// handle the selected message from the resourcesCollectionView child view
}

...

View.passMessages

The passMessages hash is used to pass messages received from a child view further up the view hierarchy, to potentially be handled by a more distant ancestor. Each entry in the hash has the format:

"messageName source" : newMessage

The messageName and source parts of the hash key interpreted in exactly the same way as in the onMessages hash.

Note: An asterix character * can be used in both the passMessages and onMessages hashes as a wildcard in the messageName to match zero or more letters, numbers, or underscores. If multiple entries match the message name, the most specific entry will "win", that is, the entry with the greatest number of non-wildcard characters will be used.

The value of newMessage determines the message that is passed to the view's parent. It is often desirable to change a message slightly as it bubbles up to a new, larger context. For example, "selected" might become "resourceSelected" as it moves from a resource view to a larger parent view that contains resources as well as other items. Also, it is sometimes desirable to change some of the application defined data in message.data, either to add additional data or to remove data that should remain private to lower levels of the view hierarchy.

• If you do not want to change the message at all before passing it up the hierarchy, specify the string "." (a single period) as the value for newMessage.
• If you would like to change the name of the message, but keep the application defined data the same, specify the new name for the message as the value for newMessage.
• If you would like to change the application defined data in the message, specify a direct function body for the value of newMessage. The function will be called with two arguments. The first is the message object, with an empty object {} as its message.data property. The second argument will be the old application defined data, that is, the data passed up by the child view. You can also change the name of the message by setting message.name.

Example entries in the passMessages hash:

passMessages : {
	 // pass the "keyup" message on to parent, without any changes
	"keyup" : ".",

	// change the "selected" message from the resourcesCollectionView
	// child view to "resourceSelected", and pass to parent
	"selected resourcesCollectionView" : "resourceSelected", 

	// change the "sortStart" message from the resourcesCollectionView 
	// child view to "resourceSortStart", populate new message.data
	// with { resourceModel : oldData.modelBeingSorted }, and pass to parent
	"sortStart resourcesCollectionView" : function( message, oldData ) {
		message.name = "resourceSortStart";
		message.data.resourceModel = oldData.modelBeingSorted; 
	},

	 // pass all other messages on to parent, without any changes
	"*" : "."
},

...

Note that in all cases, when a message is passed, message.source is overwritten and set to the view that is passing the message. If you require a reference to the object that originally spawned the message, you will need to keep that in message.data as the message bubbles up the hierarchy.

Internal view methods that may be overridden

The following methods may be overridden to customize Backbone.Courier for your environment. To override one of the methods, attach your own version of the method to your view objects either before or after calling Backbone.Courier.add().

View._getParentView()

View._getParentView() is an internal method that returns a view's "parent view". You may supply your own version of this method on your view objects (which will override the default implementation) if you want to provide a custom means to determine a view's parent. The default implementation determines a view's parent by its position in the DOM tree, scanning the tree for the closest parent that has a Backbone view in $( el ).data( "view" ). This data value is set on each view's DOM element automatically by Backbone.Courier.

Note: The default implementation of '_getParentView' depends on jQuery's or Zepto's $.parent() and $.data() methods, which is the only dependency on a DOM library or tree in Backbone.Courier.

View._getChildViewNamed( childViewName )

View._getChildViewNamed( childViewName ) is an internal method that is used to resolve the child view names optionally supplied in the source part of the onMessages and passMessages hash. You may supply your own version of this method on your view objects in order to store child views in a location other than the default view.subviews[ childViewName ].

Dependencies

• Backbone.js (tested with v0.9.9 and later, untested with earlier versions)
• jQuery or Zepto. You can eliminate this dependency by overriding View._getParentView() and providing an alternate means to determine view hierarchy that does not rely on the $.parent() and $.data() functions.

Change log

v0.6.1

• Small bug fix that could cause errors of the form Cannot read property 'data' of undefined.

v0.6.0

• BREAKING: Removed spawnMessages hash. Use version v0.5.x if you want this functionality back.
• Now view.spawn( data ) will call backbone's native view.trigger( data ) automatically.
• Added UMD wrapper.