Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Tree: d33fdaf69c
Fetching contributors…

Cannot retrieve contributors at this time

6186 lines (5456 sloc) 603.763 kB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<title>Developing Backbone.js Applications - </title>
<style type="text/css">
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; }
code > span.dt { color: #902000; }
code > span.dv { color: #40a070; }
code > span.bn { color: #40a070; }
code > span.fl { color: #40a070; }
code > span.ch { color: #4070a0; }
code > span.st { color: #4070a0; }
code > span.co { color: #60a0b0; font-style: italic; }
code > span.ot { color: #007020; }
code > span.al { color: #ff0000; font-weight: bold; }
code > span.fu { color: #06287e; }
code > span.er { color: #ff0000; font-weight: bold; }
</style>
<link rel="stylesheet" href="style.css" type="text/css" />
</head>
<body>
<p>
<h1>Developing Backbone.js Applications</h1>
<h3>By Addy Osmani <a href="http://twitter.com/addyosmani">@addyosmani</a></h3>
</p>
<div style="width:500px">
<iframe src="http://ghbtns.com/github-btn.html?user=addyosmani&repo=backbone-fundamentals&type=watch&count=true"
allowtransparency="true" frameborder="0" scrolling="0" width="110px" height="20px"></iframe>
<iframe allowtransparency="true" frameborder="0" scrolling="no" src="http://platform.twitter.com/widgets/tweet_button.1333103182.html#_=1333404284780&amp;count=horizontal&amp;id=twitter-widget-0&amp;lang=en&amp;original_referer=http%3A%2F%2Faddyosmani.github.com%2Fbackbone-fundamentals%2F&amp;size=m&amp;text=Developing%20Backbone.js%20Applications&amp;url=https%3A%2F%2Fgithub.com%2Faddyosmani%2Fbackbone-fundamentals&amp;via=addy_osmani" class="twitter-share-button twitter-count-horizontal" style="width: 107px; height: 20px; " title="Twitter Tweet Button"></iframe>
<script id="twitter-wjs" src="//platform.twitter.com/widgets.js"></script><script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
<p>&nbsp;<br></p>
</div>
<h2 id="prelude">Prelude</h2>
<p><img src="img/logo.jpg" style="float:left"/> Welcome to my (in-progress) book about the <a href="http://documentcloud.github.com/backbone/">Backbone.js</a> framework for structuring JavaScript applications. It's released under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported <a href="http://creativecommons.org/licenses/by-nc-sa/3.0/">license</a> meaning you can both grab a copy of the book for free or help to further <a href="https://github.com/addyosmani/backbone-fundamentals/">improve</a> it.</p>
<p>I'm very pleased to announce that this book will be out in physical form later in the year via <a href="http://oreilly.com">O'Reilly Media</a>. Readers will have the option of purchasing the latest version in either print or a number of digital formats then or can grab a recent version from this repository.</p>
<p>Corrections to existing material are always welcome and I hope that together we can provide the community with an up-to-date resource that is of help. My extended thanks go out to <a href="https://github.com/jashkenas">Jeremy Ashkenas</a> for creating Backbone.js and <a href="https://github.com/addyosmani/backbone-fundamentals/contributors">these</a> members of the community for their assistance tweaking this project.</p>
<p>I hope you find this book helpful!</p>
<p><strong>Notes:</strong></p>
<ul>
<li>Items added or updated in the last month are marked with a * in the outline.</li>
<li>Once you're familiar with Backbone.js, you might be interested in checking out <a href="https://github.com/addyosmani/aura">Aura</a>.</li>
</ul>
<h2 id="table-of-contents">Table Of Contents</h2>
<ul>
<li><h4><a href="#introduction">Introduction</a></h4>
<ul>
<li>MVC, Or Rather MV* Frameworks</li>
<li>What is Backbone.js?</li>
<li>When Do You Need A JavaScript MV* Framework?</li>
<li>When To Consider Using Backbone.js</li>
</ul></li>
<li><h4><a href="#fundamentals">Fundamentals</a></h4>
<ul>
<li><a href="#mvc-mvp">MVC, MVP &amp; Backbone.js</a></li>
</ul></li>
<li><h4><a href="#theinternals">The Internals</a></h4>
<ul>
<li><a href="#thebasics-models">Models</a></li>
<li><a href="#thebasics-views">Views</a></li>
<li><a href="#thebasics-collections">Collections</a></li>
<li><a href="#thebasics-events">Events</a></li>
<li><a href="#thebasics-routers">Routers</a></li>
<li><a href="#thebasics-inheritance">Inheritance &amp; Mixins</a> *</li>
<li><a href="#thebasics-namespacing">Namespacing</a></li>
</ul></li>
<li><h4><a href="#practicaltodos">Practical: Todos - Your First Backbone.js App</a> *</h4></li>
<li><h4><a href="#backboneboilerplate">Backbone Boilerplate &amp; Grunt BBB</a> *</h4></li>
<li><h4><a href="#commonproblems">Common Problems &amp; Solutions</a> *</h4>
<ul>
<li>Sub-Views And Nesting</li>
<li>Managing Models In Nested Views</li>
<li>Views Triggering Other Views</li>
<li>Child Views Rendering Parent Views</li>
<li>Cleanly Disposing Views</li>
<li>Disposing Parent And Child Views</li>
<li>Appending Views</li>
</ul></li>
<li><h4><a href="#advanced">Modular Development</a></h4>
<ul>
<li><a href="#modularjs">Introduction</a></li>
<li><a href="#organizingmodules">Organizing modules with Require.js and AMD</a></li>
<li><a href="#externaltemplates">Keeping your templates external</a></li>
<li><a href="#practicalrequirejs">Practical: A Modular App Using AMD &amp; Require.js</a></li>
<li><a href="#optimizingrequirejs">Optimize Apps With The Require.js Optimizer</a></li>
<li><a href="#optimizebuild">Optimize Apps With Require.js Using Packages</a> *</li>
<li><a href="#decouplingbackbone">Decoupling Backbone With The Mediator and Facade patterns</a></li>
</ul></li>
<li><h4><a href="#restfulapps">RESTful Applications With Backbone.js</a></h4>
<ul>
<li><a href="#restful">Building RESTful applications</a></li>
<li><a href="#stack1">Apps With Node.js, Express, Mongoose and MongoDB</a></li>
<li><a href="#stack2">Apps with Ruby, Sinatra, Haml and MongoDB</a></li>
<li><a href="#pagination">Paginating Backbone.js Requests &amp; Collections</a> *</li>
</ul></li>
<li><h4>Mobile Applications</h4>
<ul>
<li>Backbone &amp; jQuery Mobile</li>
<li>Practical: Building A Modular Mobile App With Backbone &amp; jQuery Mobile</li>
</ul></li>
<li><h4><a href="#testing">Unit Testing</a></h4>
<ul>
<li><a href="#unittestingjasmine">Unit Testing Backbone Applications With Jasmine</a></li>
<li>Introduction</li>
<li>Jasmine
<ul>
<li>Suites, Specs And Spies</li>
<li>TDD With Backbone</li>
<li>Testing Models</li>
<li>Testing Collections</li>
<li>Testing Views</li>
</ul></li>
<li><a href="#unittestingqunit">Unit Testing Backbone Applications With QUnit And SinonJS</a></li>
<li>Introduction</li>
<li>QUnit
<ul>
<li>Assertions</li>
<li>Adding structure to assertions</li>
<li>Assertion examples</li>
<li>Fixtures</li>
<li>Asynchronous code</li>
</ul></li>
<li>SinonJS
<ul>
<li>Stubs</li>
<li>Mocks</li>
</ul></li>
<li>Practical
<ul>
<li>Testing Models</li>
<li>Testing Collections</li>
<li>Testing Views</li>
<li>Testing Events</li>
</ul></li>
</ul></li>
<li><h4><a href="#resources">Resources</a></h4></li>
</ul>
<h2 id="introduction"><a name="introduction">Introduction</a></h2>
<p>When writing a Web application from scratch, it’s easy to feel like we can get by simply by relying on a DOM manipulation library (like jQuery) and a handful of utility plugins. The problem with this is that it doesn’t take long to get lost in a nested pile of jQuery callbacks and DOM elements without any real structure in place for our applications.</p>
<p>In short, we’re stuck with spaghetti code. Fortunately there are modern JavaScript frameworks that can assist with bringing structure and organization to our projects, improving how easily maintainable they are in the long-run.</p>
<h3 id="what-is-mvc-or-rather-mv">What Is MVC, Or Rather MV*?</h3>
<p>These modern frameworks provide developers an easy path to organizing their code using variations of a pattern known as MVC (Model-View-Controller). MVC separates the concerns in an application down into three parts:</p>
<ul>
<li>Models represent the domain-specific knowledge and data in an application. Think of this as being a ‘type’ of data you can model — like a User, Photo or Note. Models should notify anyone observing them about their current state (e.g Views).</li>
<li>Views are typically considered the User-interface in an application (e.g your markup and templates), but don’t have to be. They should know about the existence of Models in order to observe them, but don’t directly communicate with them.</li>
<li>Controllers handle the input (e.g clicks, user actions) in an application and Views can be considered as handling the output. When a Controller updates the state of a model (such as editing the caption on a Photo), it doesn’t directly tell the View. This is what the observing nature of the View and Model relationship is for.</li>
</ul>
<p>JavaScript ‘MVC’ frameworks that can help us structure our code don’t always strictly follow the above pattern. Some frameworks will include the responsibility of the Controller in the View (e.g Backbone.js) whilst others add their own opinionated components into the mix as they feel this is more effective.</p>
<p>For this reason we refer to such frameworks as following the MV* pattern, that is, you’re likely to have a View and a Model, but more likely to have something else also included.</p>
<h3 id="what-exactly-is-backbone.js">What exactly is Backbone.js?</h3>
<img src="img/backbonejsorg.png" style="margin:0 auto;" width="700px"/>
<p>Backbone.js is a lightweight JavaScript framework for adding structure to your client-side code. It makes it easy to manage and decouple concerns in your application, leaving you with code that is more maintainable in the long term.</p>
<p>Developers commonly use frameworks like Backbone.js to create single-page applications or SPAs. To put it simply, these apps enable the browser to react to changes in data on the client-side without the need to completely load up all your markup from the server, meaning no complete page-refreshes are necessary.</p>
<p>Backbone.js is a mature, popular framework at the time of writing and has both a large development community online as well as a wealth of plugins and extensions available to build upon it. It has been used to create non-trivial applications by companies such as Disqus, Walmart, SoundCloud and Foursquare.</p>
<h3 id="when-do-you-need-a-javascript-mv-framework">When Do You Need A JavaScript MV* Framework?</h3>
<p>When building a single-page application using JavaScript, whether it involves a complex user interface or is simply trying to reduce the number of HTTP requests required for new Views, you will likely find yourself inventing many of the pieces that make up an MV* framework like Backbone or Ember.</p>
<p>At the outset, it isn’t terribly difficult to write an application framework that offers some opinionated way to avoid spaghetti code, however to say that it is equally as trivial to write something of the standard of Backbone would be a grossly incorrect assumption.</p>
<p>There’s a lot more that goes into structuring an application than tying together a DOM manipulation library, templating and routing. Mature MV* frameworks typically not only include many of the pieces you would find yourself writing, but also include solutions to problems you’ll find yourself running into later on down the road. This is a time-saver that you shouldn’t underestimate the value of.</p>
<p>So, where will you likely need an MV* framework and where won’t you?</p>
<p>If you’re writing an application that will likely only be communicating with an API or back-end data service, where much of the heavy lifting for viewing or manipulating that data will be occurring in the browser, you may find a JavaScript MV* framework useful. Good examples of applications that fall into this category are GMail and Google Docs.</p>
<p>These applications typically download a single payload containing all the scripts, stylesheets and markup users need for common tasks and then perform a lot of additional behavior in the background. It’s trivial to switch between reading an email or document to writing one and you don’t need to ask the application to render the whole page again at all.</p>
<p>If, however, you’re building an application that still relies on the server for most of the heavy-lifting of Views/pages and you’re just using a little JavaScript or jQuery to make things a little more interactive, an MV framework may be overkill. There certainly are complex Web applications where the partial rendering of views can* be coupled with a single-page application effectively, but for everything else, you may find yourself better sticking to a simpler setup.</p>
<p>Maturity in software (framework) development isn't simply about how long a framework has been around. It's about how solid the framework is and more importantly how well it's evolved to fill its role. Has it become more effective at solving common problems? Does it continue to improve as developers build larger and more complex applications with it?</p>
<h3 id="why-should-you-consider-using-backbone.js">Why should you consider using Backbone.js?</h3>
<p>Does the following describe you?:</p>
<p>&quot;I want something flexible which offers a minimalist solution to separating concerns in my application. It should support a persistence layer and RESTful sync, models, views (with controllers), event-driven communication, templating and routing. It should be imperative, allowing one to update the View when a model changes. I’d like some decisions about the architecture left up to me. Ideally, many large companies have used the solution to build non-trivial applications.</p>
<p>As I may be building something complex, I’d like there to be an active extension community around the framework that have already tried addressing larger problems (Marionette, Chaplin, Aura, Thorax). Ideally, there are also scaffolding tools (grunt-bbb, brunch) available for the solution.&quot;</p>
<p>If so, continue reading.</p>
<p>Backbone's main benefits, regardless of your target platform or device, include helping:</p>
<ul>
<li>Organize the structure to your application</li>
<li>Simplify server-side persistence</li>
<li>Decouple the DOM from your page's data</li>
<li>Model data, views and routers in a succinct manner</li>
<li>Provide DOM, model and collection synchronization</li>
</ul>
<p>The goal of this book is to create an authoritative and centralized repository of information that can help those developing real-world apps with Backbone. If you come across a section or topic which you think could be improved or expanded on, please feel free to submit a pull-request. It won't take long and you'll be helping other developers avoid problems you've run into before.</p>
<p>Topics will include MVC theory and how to build applications using Backbone's models, views, collections and routers. I'll also be taking you through advanced topics like modular development with Backbone.js and AMD (via Require.js), how to build applications using modern software stacks (like Node and Express), how to solve the routing problems with Backbone and jQuery Mobile, tips about scaffolding tools, and a lot more.</p>
<h2 id="fundamentals"><a name="fundamentals">Fundamentals</a></h2>
<p>In this section, we're going to explore how frameworks like Backbone.js fit in the world of JavaScript application architecture. Clasically, developers creating desktop and server-class applications have had a wealth of design patterns available for them to lean on, but it's only been in the past few years that such patterns have come to client-side development.</p>
<p>Before exploring any JavaScript frameworks that assist in structuring applications, it can be useful to gain a basic understanding of architectural design patterns.</p>
<h3 id="mvc-mvp-backbone.js"><a name="mvc-mvp">MVC, MVP &amp; Backbone.js</a></h3>
<p>Design patterns are proven solutions to common development problems and can suggest structural approaches to help guide developers in adding some organization to their applications.</p>
<p>Patterns are useful because they're a set of practices that build upon the collective experience of skilled developers who have repeatedly solved similar problems. Although developers 10 or 20 years ago may not have been using the same programming languages when implementing patterns in their projects, there are many lessons we can learn from their efforts.</p>
<p>In this section, we're going to review two popular patterns - MVC and MVP. We'll be exploring in greater detail how Backbone.js implements these patterns shortly to better appreciate where it fits in.</p>
<h2 id="mvc">MVC</h2>
<p>MVC (Model-View-Controller) is an architectural design pattern that encourages improved application organization through a separation of concerns. It enforces the isolation of business data (Models) from user interfaces (Views), with a third component (Controllers) traditionally present to manage logic, user-input and the coordination of models and views. The pattern was originally designed by <a href="http://en.wikipedia.org/wiki/Trygve_Reenskaug">Trygve Reenskaug</a> while working on Smalltalk-80 (1979), where it was initially called Model-View-Controller-Editor. MVC was described in depth in <a href="http://www.amazon.co.uk/Design-patterns-elements-reusable-object-oriented/dp/0201633612">“Design Patterns: Elements of Reusable Object-Oriented Software”</a> (The &quot;GoF&quot; or “Gang of Four” book) in 1994, which played a role in popularizing its use.</p>
<h3 id="smalltalk-80-mvc">Smalltalk-80 MVC</h3>
<p>It's important to understand what the original MVC pattern was aiming to solve as it has changed quite heavily since the days of its origin. Back in the 70's, graphical user-interfaces were few and far between. An approach known as <a href="http://martinfowler.com/eaaDev/uiArchs.html">Separated Presentation</a> began to be used as a means to make a clear division between domain objects which modeled concepts in the real world (e.g a photo, a person) and the presentation objects which were rendered to the user's screen.</p>
<p>The Smalltalk-80 implementation of MVC took this concept further and had an objective of separating out the application logic from the user interface. The idea was that decoupling these parts of the application would also allow the reuse of models for other interfaces in the application. There are some interesting points worth noting about Smalltalk-80's MVC architecture:</p>
<ul>
<li>A Domain element was known as a Model and were ignorant of the user-interface (Views and Controllers)</li>
<li>Presentation was taken care of by the View and the Controller, but there wasn't just a single view and controller. A View-Controller pair was required for each element being displayed on the screen and so there was no true separation between them</li>
<li>The Controller's role in this pair was handling user input (such as key-presses and click events), doing something sensible with them.</li>
<li>The Observer pattern was relied upon for updating the View whenever the Model changed</li>
</ul>
<p>Developers are sometimes surprised when they learn that the Observer pattern (nowadays commonly implemented as a Publish/Subscribe system) was included as a part of MVC's architecture decades ago. In Smalltalk-80's MVC, the View and Controller both observe the Model: anytime the Model changes, the Views react. A simple example of this is an application backed by stock market data - for the application to show real-time information, any change to the data in its Models should result in the View being refreshed instantly.</p>
<p>Martin Fowler has done an excellent job of writing about the <a href="http://martinfowler.com/eaaDev/uiArchs.html">origins</a> of MVC over the years and if you are interested in further historical information about Smalltalk-80's MVC, I recommend reading his work.</p>
<h2 id="mvc-as-we-know-it">MVC As We Know It</h2>
<p>We've reviewed the 70's, but let us now return to the here and now. The MVC pattern has been applied to a diverse range of programming languages. For example, the popular Ruby on Rails is an implementation of a web application framework based on MVC for the Ruby language. JavaScript now has a number of MVC frameworks, including Ember.js, JavaScriptMVC, and of course Backbone.js. Given the importance of avoiding &quot;spaghetti&quot; code, a term which describes code that is very difficult to read or maintain due to its lack of structure, let's look at what the MVC pattern enables the Javascript developer to do.</p>
<p>MVC is composed of three core components:</p>
<h3 id="models">Models</h3>
<p>Models manage the data for an application. They are concerned with neither the user-interface nor presentation layers, but instead represent structured data that an application may require. When a model changes (e.g when it is updated), it will typically notify its observers (e.g views, a concept we will cover shortly) that a change has occurred so that they may react accordingly.</p>
<p>To understand models better, let us imagine we have a JavaScript photo gallery application. In a photo gallery, a photo would merit its own model, as it represents a unique kind of domain-specific data. The Photo model may represent attributes such as a caption, image source and additional meta-data. A specific photo would be stored in an instance of a model. Here's an example of a simple Photo model implemented with Backbone.js:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="co">// Default attributes for the photo</span>
<span class="dt">defaults</span>: {
<span class="co">// Ensure that each photo created has an `src`.</span>
<span class="dt">src</span>: <span class="st">&quot;placeholder.jpg&quot;</span>,
<span class="dt">caption</span>: <span class="st">&quot;A default image&quot;</span>,
<span class="dt">viewed</span>: <span class="kw">false</span>
},
<span class="dt">initialize</span>: <span class="kw">function</span>() {
}
});</code></pre>
<p>The built-in capabilities of models vary across frameworks, however it's common for them to support validation of attributes, where attributes represent the properties of the model, such as a model identifier. When using models in real-world applications we generally also need a way of persisting models. Persistence allows us to edit and update models with the knowledge that their most recent states will be saved somewhere, for example in a web browser's localStorage data-store or synchronized with a database.</p>
<p>A model may also have multiple views observing it. Imagine our Photo model contained meta-data such as the longitude and latitude where the photo was taken, a list of people present in the photo, and a list of tags. A developer could create a single view that displayed all these attributes, or might create three separate views to display each attribute. The important detail is that the Photo model doesn't care how these views are organized, it simply announces updates to its data as necessary. We'll come back to Views in more detail later.</p>
<p>It is not uncommon for modern MVC/MV* frameworks to provide a means to group models together. In Backbone, these groups are called &quot;Collections&quot;. Managing models in groups allows us to write application logic based on notifications from the group, should any model it contains change. This avoids the need to manually observe individual model instances.</p>
<p>Here's how we might group Photo models into a simplified Backbone Collection:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoGallery = <span class="kw">Backbone.Collection</span>.<span class="fu">extend</span>({
<span class="co">// Reference to this collection&#39;s model.</span>
<span class="dt">model</span>: Photo,
<span class="co">// Filter down the list of all photos that have been viewed</span>
<span class="dt">viewed</span>: <span class="kw">function</span>() {
<span class="kw">return</span> <span class="kw">this</span>.<span class="fu">filter</span>(<span class="kw">function</span>(photo){ <span class="kw">return</span> <span class="kw">photo</span>.<span class="fu">get</span>(<span class="ch">&#39;viewed&#39;</span>); });
},
<span class="co">// Filter down the list to only photos that have not yet been viewed</span>
<span class="dt">unviewed</span>: <span class="kw">function</span>() {
<span class="kw">return</span> <span class="kw">this</span>.<span class="fu">without</span>.<span class="fu">apply</span>(<span class="kw">this</span>, <span class="kw">this</span>.<span class="fu">viewed</span>());
}
});</code></pre>
<p>If you read older texts on MVC, you may come across a description of models as also managing application 'state'. In JavaScript applications &quot;state&quot; has a specific meaning, typically referring to the current &quot;state&quot; of a view or sub-view on a user's screen at a fixed time. State is a topic which is regularly discussed when looking at Single-page applications, where the concept of state needs to be simulated.</p>
<h3 id="views">Views</h3>
<p>Views are a visual representation of models that present a filtered view of their current state. A view typically observes a model and is notified when the model changes, allowing the view to update itself accordingly. Design pattern literature commonly refers to views as 'dumb', given that their knowledge of models and controllers in an application is limited.</p>
<p>Users interact with views, which usually means reading and editing model data. For example, in our photo gallery application example, model viewing might happen in a user interface with a big image, a caption, and a list of tags. Model editing could be done through an &quot;edit&quot; view where a user who has selected a specific photo could edit its caption, tags, or other metadata in a form.</p>
<p>In MVC, the actual task of updating the Model falls to Controllers, which we'll be covering shortly.</p>
<p>Let's explore Views a little further using a simple JavaScript example. Below we can see a function that creates a single Photo view, consuming both a model instance and a controller instance.</p>
<p>We define a <code>render()</code> utility within our view which is responsible for rendering the contents of the <code>photoModel</code> using a JavaScript templating engine (<a href="http://underscorejs.org" title="Underscore.js">Underscore</a> templating) and updating the contents of our view, referenced by <code>photoEl</code>.</p>
<p>The <code>photoModel</code> then adds our <code>render()</code> callback as one of its subscribers, so that through the Observer pattern it can trigger the view to update when the model changes.</p>
<p>You may wonder where user interaction comes into play here. When users click on any elements within the view, it's not the view's responsibility to know what to do next. A Controller makes this decision. In our sample implementation, this is achieved by adding an event listener to <code>photoEl</code> which will delegate handling the click behavior back to the controller, passing the model information along with it in case it's needed.</p>
<p>The benefit of this architecture is that each component plays its own separate role in making the application function as needed.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> buildPhotoView = <span class="kw">function</span>( photoModel, photoController ){
<span class="kw">var</span> base = <span class="kw">document</span>.<span class="fu">createElement</span>(<span class="ch">&#39;div&#39;</span>),
photoEl = <span class="kw">document</span>.<span class="fu">createElement</span>(<span class="ch">&#39;div&#39;</span>);
<span class="kw">base</span>.<span class="fu">appendChild</span>(photoEl);
<span class="kw">var</span> render= <span class="kw">function</span>(){
<span class="co">// We use a templating library such as Underscore</span>
<span class="co">// templating which generates the HTML for our </span>
<span class="co">// photo entry</span>
<span class="kw">photoEl</span>.<span class="fu">innerHTML</span> = <span class="kw">_</span>.<span class="fu">template</span>(<span class="ch">&#39;photoTemplate&#39;</span>, {<span class="dt">src</span>: <span class="kw">photoModel</span>.<span class="fu">getSrc</span>()});
}
<span class="kw">photoModel</span>.<span class="fu">addSubscriber</span>( render );
<span class="kw">photoEl</span>.<span class="fu">addEventListener</span>(<span class="ch">&#39;click&#39;</span>, <span class="kw">function</span>(){
<span class="kw">photoController</span>.<span class="fu">handleEvent</span>(<span class="ch">&#39;click&#39;</span>, photoModel );
});
<span class="kw">var</span> show = <span class="kw">function</span>(){
<span class="kw">photoEl.style</span>.<span class="fu">display</span> = <span class="ch">&#39;&#39;</span>;
}
<span class="kw">var</span> hide = <span class="kw">function</span>(){
<span class="kw">photoEl.style</span>.<span class="fu">display</span> = <span class="ch">&#39;none&#39;</span>;
}
<span class="kw">return</span>{
<span class="dt">showView</span>: show,
<span class="dt">hideView</span>: hide
}
}</code></pre>
<p><strong>Templating</strong></p>
<p>In the context of JavaScript frameworks that support MVC/MV*, it is worth looking more closely at JavaScript templating and its relationship to Views.</p>
<p>It has long been considered bad practice (and computationally expensive) to manually create large blocks of HTML markup in-memory through string concatenation. Developers using this technique often find themselves iterating through their data, wrapping it in nested divs and using outdated techniques such as <code>document.write</code> to inject the 'template' into the DOM. This approach often means keeping scripted markup inline with standard markup, which can quickly become difficult to read and maintain, especially when building large applications.</p>
<p>JavaScript templating libraries (such as Handlebars.js or Mustache) are often used to define templates for views as HTML markup containing template variables. These template blocks can be either stored externally or within script tags with a custom type (e.g 'text/template'). Variables are delimited using a variable syntax (e.g {{name}}). Javascript template libraries typically accept data in JSON, and the grunt work of populating templates with data is taken care of by the framework itself. This has a several benefits, particularly when opting to store templates externally as this can let applications load templates dynamically on an as-needed basis.</p>
<p>Let's compare two examples of HTML templates. One is implemented using the popular Handlebars.js library, and the other uses Underscore's 'microtemplates'.</p>
<p><strong>Handlebars.js:</strong></p>
<pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;li</span><span class="ot"> class=</span><span class="st">&quot;photo&quot;</span><span class="kw">&gt;</span>
<span class="kw">&lt;h2&gt;</span>{{caption}}<span class="kw">&lt;/h2&gt;</span>
<span class="kw">&lt;img</span><span class="ot"> class=</span><span class="st">&quot;source&quot;</span><span class="ot"> src=</span><span class="st">&quot;{{src}}&quot;</span><span class="kw">/&gt;</span>
<span class="kw">&lt;div</span><span class="ot"> class=</span><span class="st">&quot;meta-data&quot;</span><span class="kw">&gt;</span>
{{metadata}}
<span class="kw">&lt;/div&gt;</span>
<span class="kw">&lt;/li&gt;</span></code></pre>
<p><strong>Underscore.js Microtemplates:</strong></p>
<pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;li</span><span class="ot"> class=</span><span class="st">&quot;photo&quot;</span><span class="kw">&gt;</span>
<span class="kw">&lt;h2&gt;</span><span class="er">&lt;</span>%= caption %&gt;<span class="kw">&lt;/h2&gt;</span>
<span class="kw">&lt;img</span><span class="ot"> class=</span><span class="st">&quot;source&quot;</span><span class="ot"> src=</span><span class="st">&quot;</span><span class="er">&lt;</span><span class="st">%= src %&gt;&quot;</span><span class="kw">/&gt;</span>
<span class="kw">&lt;div</span><span class="ot"> class=</span><span class="st">&quot;meta-data&quot;</span><span class="kw">&gt;</span>
<span class="er">&lt;</span>%= metadata %&gt;
<span class="kw">&lt;/div&gt;</span>
<span class="kw">&lt;/li&gt;</span></code></pre>
<p>You may also use double curly brackets (i.e <code>{{}}</code>) (or any other tag you feel comfortable with) in Microtemplates. In the case of curly brackets, this can be done by setting the Underscore <code>templateSettings</code> attribute as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">_</span>.<span class="fu">templateSettings</span> = { <span class="dt">interpolate </span>: <span class="ot">/</span><span class="fl">\{\{(</span><span class="ot">.</span><span class="fl">+?)\}\}</span><span class="ot">/g</span> };</code></pre>
<p><strong>A note on navigation and state</strong></p>
<p>It is also worth noting that in classical web development, navigating between independent views required the use of a page refresh. In single-page JavaScript applications, however, once data is fetched from a server via Ajax, it can be dynamically rendered in a new view within the same page. Since this doesn't automatically update the URL, the role of navigation thus falls to a &quot;router&quot;, which assists in managing application state (e.g allowing users to bookmark a particular view they have navigated to). As routers are however neither a part of MVC nor present in every MVC-like framework, I will not be going into them in greater detail in this section.</p>
<h3 id="controllers">Controllers</h3>
<p>Controllers are an intermediary between models and views which are classically responsible for two tasks: they both update the view when the model changes and update the model when the user manipulates the view.</p>
<p>In our photo gallery application, a controller would be responsible for handling changes the user made to the edit view for a particular photo, updating a specific photo model when a user has finished editing.</p>
<p>It's with controllers that most JavaScript MVC frameworks depart from this interpretation of the MVC pattern. The reasons for this vary, but in my opinion, Javascript framework authors likely initially looked at server-side interpretations of MVC (such as Ruby on Rails), realized that that approach didn't translate 1:1 on the client-side, and so re-interpreted the C in MVC to solve their state management problem. This was a clever approach, but it can make it hard for developers coming to MVC for the first time to understand both the classical MVC pattern and the &quot;proper&quot; role of controllers in other non-Javascript frameworks.</p>
<p>So does Backbone.js have Controllers? Not really. Backbone's Views typically contain &quot;controller&quot; logic, and Routers (discussed below) are used to help manage application state, but neither are true Controllers according to classical MVC.</p>
<p>In this respect, contrary to what might be mentioned in the official documentation or in blog posts, Backbone is neither a truly MVC/MVP nor MVVM framework. It's in fact better to see it a member of the MV* family which approaches architecture in its own way. There is of course nothing wrong with this, but it is important to distinguish between classical MVC and MV* should you be relying on discussions of MVC to help with your Backbone projects.</p>
<h3 id="controllers-in-spine.js-vs-backbone.js">Controllers in Spine.js vs Backbone.js</h3>
<p><strong>Spine.js</strong></p>
<p>We now know that controllers are traditionally responsible for updating the view when the model changes (and similarly the model when the user updates the view). Since Backbone doesn't have its <strong>own</strong> explicit controllers, it's useful to review the controller from another MVC framework to appreciate the difference in implementations. Let's take a look at <a href="http://spinejs.com/">Spine.js</a>:</p>
<p>In this example, we're going to have a controller called <code>PhotosController</code> which will be in charge of individual photos in the application. It will ensure that when the view updates (e.g a user edited the photo meta-data) the corresponding model does too.</p>
<p>(Note: We won't be delving heavily into Spine.js beyond this example, but it's worth looking at it to learn more about Javascript frameworks in general.)</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="co">// Controllers in Spine are created by inheriting from Spine.Controller</span>
<span class="kw">var</span> PhotosController = <span class="kw">Spine.Controller</span>.<span class="fu">sub</span>({
<span class="dt">init</span>: <span class="kw">function</span>(){
<span class="kw">this</span>.<span class="fu">item</span>.<span class="fu">bind</span>(<span class="st">&quot;update&quot;</span>, <span class="kw">this</span>.<span class="fu">proxy</span>(<span class="kw">this</span>.<span class="fu">render</span>));
<span class="kw">this</span>.<span class="fu">item</span>.<span class="fu">bind</span>(<span class="st">&quot;destroy&quot;</span>, <span class="kw">this</span>.<span class="fu">proxy</span>(<span class="kw">this</span>.<span class="fu">remove</span>));
},
<span class="dt">render</span>: <span class="kw">function</span>(){
<span class="co">// Handle templating</span>
<span class="kw">this</span>.<span class="fu">replace</span>($(<span class="st">&quot;#photoTemplate&quot;</span>).<span class="fu">tmpl</span>(<span class="kw">this</span>.<span class="fu">item</span>));
<span class="kw">return</span> <span class="kw">this</span>;
},
<span class="dt">remove</span>: <span class="kw">function</span>(){
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">remove</span>();
<span class="kw">this</span>.<span class="fu">release</span>();
}
});</code></pre>
<p>In Spine, controllers are considered the glue for an application, adding and responding to DOM events, rendering templates and ensuring that views and models are kept in sync (which makes sense in the context of what we know to be a controller).</p>
<p>What we're doing in the above example is setting up listeners in the <code>update</code> and <code>destroy</code> events using <code>render()</code> and <code>remove()</code>. When a photo entry gets updated, we re-render the view to reflect the changes to the meta-data. Similarly, if the photo gets deleted from the gallery, we remove it from the view. In case you were wondering about the <code>tmpl()</code> function in the code snippet: in the <code>render()</code> function, we're using this to render a JavaScript template called #photoTemplate which simply returns an HTML string used to replace the controller's current element.</p>
<p>What this provides us with is a very lightweight, simple way to manage changes between the model and the view.</p>
<p><strong>Backbone.js</strong></p>
<p>Later on in this section we're going to revisit the differences between Backbone and traditional MVC, but for now let's focus on controllers.</p>
<p>In Backbone, controller logic is shared between Backbone.View and Backbone.Router. Earlier releases of Backbone contained something called Backbone.Controller, but it was renamed to Router to clarify its role.</p>
<p>A Router's main purpose is to translate URL requests into application states. When a user browses to the URL www.example.com/photos/42, a Router could be used to show the photo with that ID, and to define what application behavior should be run in response to that request. Routers <em>can</em> contain traditional controller responsibilities, such as binding the events between models and views, or rendering parts of the page. However, Backbone contributor Tim Branyen has pointed out that it's possible to get away without needing Backbone.Router at all for this, so a way to think about it using the Router paradigm is probably:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoRouter = <span class="kw">Backbone.Router</span>.<span class="fu">extend</span>({
<span class="dt">routes</span>: { <span class="st">&quot;photos/:id&quot;</span>: <span class="st">&quot;route&quot;</span> },
<span class="dt">route</span>: <span class="kw">function</span>(id) {
<span class="kw">var</span> item = <span class="kw">photoCollection</span>.<span class="fu">get</span>(id);
<span class="kw">var</span> view = <span class="kw">new</span> PhotoView({ <span class="dt">model</span>: item });
<span class="kw">something</span>.<span class="fu">html</span>( <span class="kw">view</span>.<span class="fu">render</span>().<span class="fu">el</span> );
}
}):</code></pre>
<h2 id="what-does-mvc-give-us">What does MVC give us?</h2>
<p>To summarize, the separation of concerns in MVC facilitates modularization of an application's functionality and enables:</p>
<ul>
<li>Easier overall maintenance. When updates need to be made to the application it is clear whether the changes are data-centric, meaning changes to models and possibly controllers, or merely visual, meaning changes to views.<br /></li>
<li>Decoupling models and views means that it's straight-forward to write unit tests for business logic<br /></li>
<li>Duplication of low-level model and controller code is eliminated across the application</li>
<li>Depending on the size of the application and separation of roles, this modularity allows developers responsible for core logic and developers working on the user-interfaces to work simultaneously</li>
</ul>
<h3 id="delving-deeper">Delving deeper</h3>
<p>Right now, you likely have a basic understanding of what the MVC pattern provides, but for the curious, we'll explore it a little further.</p>
<p>The GoF (Gang of Four) do not refer to MVC as a design pattern, but rather consider it a &quot;set of classes to build a user interface&quot;. In their view, it's actually a variation of three other classical design patterns: the Observer (Pub/Sub), Strategy and Composite patterns. Depending on how MVC has been implemented in a framework, it may also use the Factory and Decorator patterns. I've covered some of these patterns in my other free book, JavaScript Design Patterns For Beginners if you would like to read into them further.</p>
<p>As we've discussed, models represent application data, while views handle what the user is presented on screen. As such, MVC relies on Pub/Sub for some of its core communication (something that surprisingly isn't covered in many articles about the MVC pattern). When a model is changed it &quot;publishes&quot; to the rest of the application that it has been updated. The &quot;subscriber&quot;--generally a Controller--then updates the view accordingly. The observer-viewer nature of this relationship is what facilitates multiple views being attached to the same model.</p>
<p>For developers interested in knowing more about the decoupled nature of MVC (once again, depending on the implementation), one of the goals of the pattern is to help define one-to-many relationships between a topic and its observers. When a topic changes, its observers are updated. Views and controllers have a slightly different relationship. Controllers facilitate views to respond to different user input and are an example of the Strategy pattern.</p>
<h3 id="summary">Summary</h3>
<p>Having reviewed the classical MVC pattern, you should now understand how it allows developers to cleanly separate concerns in an application. You should also now appreciate how JavaScript MVC frameworks may differ in their interpretation of MVC, and how they share some of the fundamental concepts of the original pattern.</p>
<p>When reviewing a new JavaScript MVC/MV* framework, remember - it can be useful to step back and consider how it's opted to approach Models, Views, Controllers or other alternatives, as this can better help you grok how the framework expects to be used.</p>
<h2 id="mvp">MVP</h2>
<p>Model-view-presenter (MVP) is a derivative of the MVC design pattern which focuses on improving presentation logic. It originated at a company named <a href="http://en.wikipedia.org/wiki/Taligent">Taligent</a> in the early 1990s while they were working on a model for a C++ CommonPoint environment. Whilst both MVC and MVP target the separation of concerns across multiple components, there are some fundamental differences between them.</p>
<p>For the purposes of this summary we will focus on the version of MVP most suitable for web-based architectures.</p>
<h3 id="models-views-presenters">Models, Views &amp; Presenters</h3>
<p>The P in MVP stands for presenter. It's a component which contains the user-interface business logic for the view. Unlike MVC, invocations from the view are delegated to the presenter, which are decoupled from the view and instead talk to it through an interface. This allows for all kinds of useful things such as being able to mock views in unit tests.</p>
<p>The most common implementation of MVP is one which uses a Passive View (a view which is for all intents and purposes &quot;dumb&quot;), containing little to no logic. MVP models are almost identical to MVC models and handle application data. The presenter acts as a mediator which talks to both the view and model, however both of these are isolated from each other. They effectively bind models to views, a responsibility held by Controllers in MVC. Presenters are at the heart of the MVP pattern and as you can guess, incorporate the presentation logic behind views.</p>
<p>Solicited by a view, presenters perform any work to do with user requests and pass data back to them. In this respect, they retrieve data, manipulate it and determine how the data should be displayed in the view. In some implementations, the presenter also interacts with a service layer to persist data (models). Models may trigger events but it's the presenter's role to subscribe to them so that it can update the view. In this passive architecture, we have no concept of direct data binding. Views expose setters which presenters can use to set data.</p>
<p>The benefit of this change from MVC is that it increases the testability of your application and provides a more clean separation between the view and the model. This isn't however without its costs as the lack of data binding support in the pattern can often mean having to take care of this task separately.</p>
<p>Although a common implementation of a <a href="http://martinfowler.com/eaaDev/PassiveScreen.html">Passive View</a> is for the view to implement an interface, there are variations on it, including the use of events which can decouple the View from the Presenter a little more. As we don't have the interface construct in JavaScript, we're using it more and more a protocol than an explicit interface here. It's technically still an API and it's probably fair for us to refer to it as an interface from that perspective.</p>
<p>There is also a <a href="http://martinfowler.com/eaaDev/SupervisingPresenter.html">Supervising Controller</a> variation of MVP, which is closer to the MVC and <a href="http://en.wikipedia.org/wiki/Model_View_ViewModel">MVVM</a> patterns as it provides data-binding from the Model directly from the View. Key-value observing (KVO) plugins (such as Derick Bailey's Backbone.ModelBinding plugin) introduce this idea of a Supervising Controller to Backbone.</p>
<h2 id="mvp-or-mvc">MVP or MVC?</h2>
<p>MVP is generally used most often in enterprise-level applications where it's necessary to reuse as much presentation logic as possible. Applications with very complex views and a great deal of user interaction may find that MVC doesn't quite fit the bill here as solving this problem may mean heavily relying on multiple controllers. In MVP, all of this complex logic can be encapsulated in a presenter, which can simplify maintenance greatly.</p>
<p>As MVP views are defined through an interface and the interface is technically the only point of contact between the system and the view (other than a presenter), this pattern also allows developers to write presentation logic without needing to wait for designers to produce layouts and graphics for the application.</p>
<p>Depending on the implementation, MVP may be more easy to automatically unit test than MVC. The reason often cited for this is that the presenter can be used as a complete mock of the user-interface and so it can be unit tested independent of other components. In my experience this really depends on the languages you are implementing MVP in (there's quite a difference between opting for MVP for a JavaScript project over one for say, ASP.NET).</p>
<p>At the end of the day, the underlying concerns you may have with MVC will likely hold true for MVP given that the differences between them are mainly semantic. As long as you are cleanly separating concerns into models, views and controllers (or presenters) you should be achieving most of the same benefits regardless of the pattern you opt for.</p>
<h2 id="mvc-mvp-and-backbone.js">MVC, MVP and Backbone.js</h2>
<p>There are very few, if any architectural JavaScript frameworks that claim to implement the MVC or MVP patterns in their classical form as many JavaScript developers don't view MVC and MVP as being mutually exclusive (we are actually more likely to see MVP strictly implemented when looking at web frameworks such as ASP.NET or GWT). This is because it's possible to have additional presenter/view logic in your application and yet still consider it a flavor of MVC.</p>
<p>Backbone contributor <a href="http://ireneros.com/">Irene Ros</a> subscribes to this way of thinking as when she separates Backbone views out into their own distinct components, she needs something to actually assemble them for her. This could either be a controller route (such as a <code>Backbone.Router</code>, covered later in the book) or a callback in response to data being fetched.</p>
<p>That said, some developers do however feel that Backbone.js better fits the description of MVP than it does MVC . Their view is that:</p>
<ul>
<li>The presenter in MVP better describes the <code>Backbone.View</code> (the layer between View templates and the data bound to it) than a controller does</li>
<li>The model fits <code>Backbone.Model</code> (it isn't that different from the classical MVC &quot;Model&quot;)<br /></li>
<li>The views best represent templates (e.g Handlebars/Mustache markup templates)</li>
</ul>
<p>A response to this could be that the view can also just be a View (as per MVC) because Backbone is flexible enough to let it be used for multiple purposes. The V in MVC and the P in MVP can both be accomplished by <code>Backbone.View</code> because they're able to achieve two purposes: both rendering atomic components and assembling those components rendered by other views.</p>
<p>We've also seen that in Backbone the responsibility of a controller is shared with both the Backbone.View and Backbone.Router and in the following example we can actually see that aspects of that are certainly true.</p>
<p>Here, our Backbone <code>PhotoView</code> uses the Observer pattern to 'subscribe' to changes to a View's model in the line <code>this.model.on('change',...)</code>. It also handles templating in the <code>render()</code> method, but unlike some other implementations, user interaction is also handled in the View (see <code>events</code>).</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoView = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
<span class="co">//... is a list tag.</span>
<span class="dt">tagName</span>: <span class="st">&quot;li&quot;</span>,
<span class="co">// Pass the contents of the photo template through a templating</span>
<span class="co">// function, cache it for a single photo</span>
<span class="dt">template</span>: <span class="kw">_</span>.<span class="fu">template</span>($(<span class="ch">&#39;#photo-template&#39;</span>).<span class="fu">html</span>()),
<span class="co">// The DOM events specific to an item.</span>
<span class="dt">events</span>: {
<span class="st">&quot;click img&quot;</span> : <span class="st">&quot;toggleViewed&quot;</span>
},
<span class="co">// The PhotoView listens for changes to its model, re-rendering. Since there&#39;s</span>
<span class="co">// a one-to-one correspondence between a **Photo** and a **PhotoView** in this</span>
<span class="co">// app, we set a direct reference on the model for convenience.</span>
<span class="dt">initialize</span>: <span class="kw">function</span>() {
<span class="kw">_</span>.<span class="fu">bindAll</span>(<span class="kw">this</span>, <span class="ch">&#39;render&#39;</span>);
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">on</span>(<span class="ch">&#39;change&#39;</span>, <span class="kw">this</span>.<span class="fu">render</span>);
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">on</span>(<span class="ch">&#39;destroy&#39;</span>, <span class="kw">this</span>.<span class="fu">remove</span>);
},
<span class="co">// Re-render the photo entry</span>
<span class="dt">render</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">html</span>(<span class="kw">this</span>.<span class="fu">template</span>(<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">toJSON</span>()));
<span class="kw">return</span> <span class="kw">this</span>;
},
<span class="co">// Toggle the `&quot;viewed&quot;` state of the model.</span>
<span class="dt">toggleViewed</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">viewed</span>();
}
});</code></pre>
<p>Another (quite different) opinion is that Backbone more closely resembles <a href="http://martinfowler.com/eaaDev/uiArchs.html#ModelViewController">Smalltalk-80 MVC</a>, which we went through earlier.</p>
<p>As regular Backbone user Derick Bailey has <a href="http://lostechies.com/derickbailey/2011/12/23/backbone-js-is-not-an-mvc-framework/">written</a>, it's ultimately best not to force Backbone to fit any specific design patterns. Design patterns should be considered flexible guides to how applications may be structured and in this respect, Backbone doesn't fit either MVC nor MVP perfectly. Instead, it borrows some of the best concepts from multiple architectural patterns and creates a flexible framework that just works well. Call it <strong>the Backbone way</strong>, MV* or whatever helps reference its flavor of application architecture.</p>
<p>It <em>is</em> however worth understanding where and why these concepts originated, so I hope that my explanations of MVC and MVP have been of help. Most structural JavaScript frameworks will adopt their own take on classical patterns, either intentionally or by accident, but the important thing is that they help us develop applications which are organized, clean and can be easily maintained.</p>
<h2 id="fast-facts">Fast facts</h2>
<h3 id="backbone.js">Backbone.js</h3>
<ul>
<li>Core components: Model, View, Collection, Router. Enforces its own flavor of MV*</li>
<li>Good documentation, with more improvements on the way</li>
<li>Used by large companies such as SoundCloud and Foursquare to build non-trivial applications</li>
<li>Event-driven communication between views and models. As we'll see, it's relatively straight-forward to add event listeners to any attribute in a model, giving developers fine-grained control over what changes in the view</li>
<li>Supports data bindings through manual events or a separate Key-value observing (KVO) library</li>
<li>Great support for RESTful interfaces out of the box, so models can be easily tied to a backend</li>
<li>Extensive eventing system. It's <a href="http://lostechies.com/derickbailey/2011/07/19/references-routing-and-the-event-aggregator-coordinating-views-in-backbone-js/">trivial</a> to add support for pub/sub in Backbone</li>
<li>Prototypes are instantiated with the <code>new</code> keyword, which some developers prefer</li>
<li>Agnostic about templating frameworks, however Underscore's micro-templating is available by default. Backbone works well with libraries like Handlebars</li>
<li>Doesn't support deeply nested models, though there are Backbone plugins such as <a href="https://github.com/PaulUithol/Backbone-relational">this</a> which can help<br /></li>
<li>Clear and flexible conventions for structuring applications. Backbone doesn't force usage of all of its components and can work with only those needed.</li>
</ul>
<h2 id="the-internals">##<a name="theinternals">The Internals</a></h2>
<p>In this section, you'll learn the essentials of Backbone's models, views, collections and routers, as well as about using namespacing to organize your code. This isn't meant as a replacement for the official documentation, but it will help you understand many of the core concepts behind Backbone before you start building applications with it.</p>
<ul>
<li>Models</li>
<li>Collections</li>
<li>Routers</li>
<li>Views</li>
<li>Namespacing</li>
</ul>
<h2 id="models-1"><a name="thebasics-models" id="thebasics-models">Models</a></h2>
<p>Backbone models contain interactive data for an application as well as the logic around this data. For example, we can use a model to represent the concept of a photo object including its attributes like tags, titles and a location.</p>
<p>Models can be created by extending <code>Backbone.Model</code> as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">defaults</span>: {
<span class="dt">src</span>: <span class="ch">&#39;placeholder.jpg&#39;</span>,
<span class="dt">title</span>: <span class="ch">&#39;an image placeholder&#39;</span>,
<span class="dt">coordinates</span>: [<span class="dv">0</span>,<span class="dv">0</span>]
},
<span class="dt">initialize</span>: <span class="kw">function</span>(){
<span class="kw">this</span>.<span class="fu">on</span>(<span class="st">&quot;change:src&quot;</span>, <span class="kw">function</span>(){
<span class="kw">var</span> src = <span class="kw">this</span>.<span class="fu">get</span>(<span class="st">&quot;src&quot;</span>);
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;Image source updated to &#39;</span> + src);
});
},
<span class="dt">changeSrc</span>: <span class="kw">function</span>( source ){
<span class="kw">this</span>.<span class="fu">set</span>({ <span class="dt">src</span>: source });
}
});
<span class="kw">var</span> somePhoto = <span class="kw">new</span> Photo({ <span class="dt">src</span>: <span class="st">&quot;test.jpg&quot;</span>, <span class="dt">title</span>:<span class="st">&quot;testing&quot;</span>});
<span class="kw">somePhoto</span>.<span class="fu">changeSrc</span>(<span class="st">&quot;magic.jpg&quot;</span>); <span class="co">// which triggers &quot;change:src&quot; and logs an update message to the console.</span></code></pre>
<h4 id="initialization">Initialization</h4>
<p>The <code>initialize()</code> method is called when a new instance of a model is created. Its use is optional, however you'll see why it's good practice to use it below.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">initialize</span>: <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;this model has been initialized&#39;</span>);
}
});
<span class="co">// We can then create our own instance of a photo as follows:</span>
<span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo();</code></pre>
<h4 id="getters-setters">Getters &amp; Setters</h4>
<p><strong>Model.get()</strong></p>
<p><code>Model.get()</code> provides easy access to a model's attributes. Attributes which are passed through to the model on instantiation are instantly available for retrieval.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo({ <span class="dt">title</span>: <span class="st">&quot;My awesome photo&quot;</span>,
<span class="dt">src</span>:<span class="st">&quot;boston.jpg&quot;</span>,
<span class="dt">location</span>: <span class="st">&quot;Boston&quot;</span>,
<span class="dt">tags</span>:[<span class="ch">&#39;the big game&#39;</span>, <span class="ch">&#39;vacation&#39;</span>]}),
title = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">&quot;title&quot;</span>), <span class="co">//My awesome photo</span>
location = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">&quot;location&quot;</span>), <span class="co">//Boston</span>
tags = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">&quot;tags&quot;</span>), <span class="co">// [&#39;the big game&#39;,&#39;vacation&#39;]</span>
photoSrc = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">&quot;src&quot;</span>); <span class="co">//boston.jpg</span></code></pre>
<p>Alternatively, if you wish to directly access all of the attributes in a model's instance directly, you can achieve this as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myAttributes = <span class="kw">myPhoto</span>.<span class="fu">attributes</span>;
<span class="kw">console</span>.<span class="fu">log</span>(myAttributes);</code></pre>
<p>It is best practice to use <code>Model.set()</code> or direct instantiation to set the values of a model's attributes.</p>
<p>Accessing <code>Model.attributes</code> directly is generally discouraged. Instead, should you need to read or clone data, <code>Model.toJSON()</code> is recommended for this purpose. If you would like to access or copy a model's attributes for purposes such as JSON stringification (e.g. for serialization prior to being passed to a view), this can be achieved using Model.toJSON(). Remember that this will return an object and JSON.stringify() should be used to get a string representation of the data:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myAttributes = <span class="kw">myPhoto</span>.<span class="fu">toJSON</span>();
<span class="kw">console</span>.<span class="fu">log</span>(<span class="kw">JSON</span>.<span class="fu">stringify</span>(myattributes));
<span class="co">/* this returns: </span>
<span class="co"> { title: &quot;My awesome photo&quot;, </span>
<span class="co"> src:&quot;boston.jpg&quot;, </span>
<span class="co"> location: &quot;Boston&quot;, </span>
<span class="co"> tags:[&#39;the big game&#39;, &#39;vacation&#39;]}</span>
<span class="co">*/</span></code></pre>
<h4 id="model.set">Model.set()</h4>
<p><code>Model.set()</code> allows us to pass attributes into an instance of our model. Attributes can either be set during initialization or at any time afterwards. It's important to avoid trying to set a Model's attributes directly (for example, <code>Model.caption = 'A new caption'</code>). Backbone uses Model.set() to know when to broadcast that a model's data has changed.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">initialize</span>: <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;this model has been initialized&#39;</span>);
}
});
<span class="co">// Setting the value of attributes via instantiation</span>
<span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo({ <span class="dt">title</span>: <span class="ch">&#39;My awesome photo&#39;</span>, <span class="dt">location</span>: <span class="ch">&#39;Boston&#39;</span> });
<span class="kw">var</span> myPhoto2 = <span class="kw">new</span> Photo();
<span class="co">// Setting the value of attributes through Model.set()</span>
<span class="kw">myPhoto2</span>.<span class="fu">set</span>({ <span class="dt">title</span>:<span class="ch">&#39;Vacation in Florida&#39;</span>, <span class="dt">location</span>: <span class="ch">&#39;Florida&#39;</span> });</code></pre>
<p><strong>Default values</strong></p>
<p>There are times when you want your model to have a set of default values (e.g. in a scenario where a complete set of data isn't provided by the user). This can be set using a property called <code>defaults</code> in your model.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">defaults</span>: {
<span class="dt">title</span>: <span class="ch">&#39;Another photo!&#39;</span>,
<span class="dt">tags</span>: [<span class="ch">&#39;untagged&#39;</span>],
<span class="dt">location</span>: <span class="ch">&#39;home&#39;</span>,
<span class="dt">src</span>: <span class="ch">&#39;placeholder.jpg&#39;</span>
},
<span class="dt">initialize</span>: <span class="kw">function</span>(){
}
});
<span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo({ <span class="dt">location</span>: <span class="st">&quot;Boston&quot;</span>,
<span class="dt">tags</span>:[<span class="ch">&#39;the big game&#39;</span>, <span class="ch">&#39;vacation&#39;</span>]}),
title = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">&quot;title&quot;</span>), <span class="co">//Another photo!</span>
location = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">&quot;location&quot;</span>), <span class="co">//Boston</span>
tags = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">&quot;tags&quot;</span>), <span class="co">// [&#39;the big game&#39;,&#39;vacation&#39;]</span>
photoSrc = <span class="kw">myPhoto</span>.<span class="fu">get</span>(<span class="st">&quot;src&quot;</span>); <span class="co">//placeholder.jpg</span></code></pre>
<p><strong>Listening for changes to your model</strong></p>
<p>Any and all of the attributes in a Backbone model can have listeners bound to them which detect when their values change. Listeners can be added to the <code>initialize()</code> function:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">this</span>.<span class="fu">on</span>(<span class="ch">&#39;change&#39;</span>, <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;values for this model have changed&#39;</span>);
});</code></pre>
<p>In the following example, we log a message whenever a specific attribute (the title of our Photo model) is altered.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">defaults</span>: {
<span class="dt">title</span>: <span class="ch">&#39;Another photo!&#39;</span>,
<span class="dt">tags</span>: [<span class="ch">&#39;untagged&#39;</span>],
<span class="dt">location</span>: <span class="ch">&#39;home&#39;</span>,
<span class="dt">src</span>: <span class="ch">&#39;placeholder.jpg&#39;</span>
},
<span class="dt">initialize</span>: <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;this model has been initialized&#39;</span>);
<span class="kw">this</span>.<span class="fu">on</span>(<span class="st">&quot;change:title&quot;</span>, <span class="kw">function</span>(){
<span class="kw">var</span> title = <span class="kw">this</span>.<span class="fu">get</span>(<span class="st">&quot;title&quot;</span>);
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">&quot;My title has been changed to.. &quot;</span> + title);
});
},
<span class="dt">setTitle</span>: <span class="kw">function</span>(newTitle){
<span class="kw">this</span>.<span class="fu">set</span>({ <span class="dt">title</span>: newTitle });
}
});
<span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo({ <span class="dt">title</span>:<span class="st">&quot;Fishing at the lake&quot;</span>, <span class="dt">src</span>:<span class="st">&quot;fishing.jpg&quot;</span>});
<span class="kw">myPhoto</span>.<span class="fu">setTitle</span>(<span class="ch">&#39;Fishing at sea&#39;</span>);
<span class="co">//logs &#39;My title has been changed to.. Fishing at sea&#39;</span></code></pre>
<p><strong>Validation</strong></p>
<p>Backbone supports model validation through <code>Model.validate()</code>, which allows checking the attribute values for a model prior to them being set.</p>
<p>Validation functions can be as simple or complex as necessary. If the attributes provided are valid, nothing should be returned from <code>.validate()</code>. If they are invalid, a custom error can be returned instead.</p>
<p>A basic example for validation can be seen below:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Photo = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="dt">validate</span>: <span class="kw">function</span>(attribs){
<span class="kw">if</span>(<span class="kw">attribs</span>.<span class="fu">src</span> === undefined){
<span class="kw">return</span> <span class="st">&quot;Remember to set a source for your image!&quot;</span>;
}
},
<span class="dt">initialize</span>: <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;this model has been initialized&#39;</span>);
<span class="kw">this</span>.<span class="fu">on</span>(<span class="st">&quot;error&quot;</span>, <span class="kw">function</span>(model, error){
<span class="kw">console</span>.<span class="fu">log</span>(error);
});
}
});
<span class="kw">var</span> myPhoto = <span class="kw">new</span> Photo();
<span class="kw">myPhoto</span>.<span class="fu">set</span>({ <span class="dt">title</span>: <span class="st">&quot;On the beach&quot;</span> });
<span class="co">//logs Remember to set a source for your image!</span></code></pre>
<p><strong>Note</strong>: Backbone passes the <code>attributes</code> object by shallow copy to the <code>validate</code> function using the Underscore <code>_.extend</code> method. This means that it is not possible to change any <code>Number</code>, <code>String</code> or <code>Boolean</code> attribute by reference in the way that one might expect a JavaScript object to behave. As shallow copy doesn't copy objects by implicitly copying them, but rather, by reference, one ca change the attributes on those objects.</p>
<p>An example of this (by @fivetanley) is available <a href="http://jsfiddle.net/2NdDY/7/">here</a>.</p>
<h2 id="views-1"><a name="thebasics-views" id="thebasics-views">Views</a></h2>
<p>Views in Backbone don't contain the markup for your application, but rather they are there to support models by defining the logic for how they should be represented to the user. This is usually achieved using JavaScript templating (e.g. Mustache, jQuery-tmpl, etc.). A view's <code>render()</code> function can be bound to a model's <code>change()</code> event, allowing the view to always be up to date without requiring a full page refresh.</p>
<h4 id="creating-new-views">Creating new views</h4>
<p>Similar to the previous sections, creating a new view is relatively straight-forward. To create a new View, simply extend <code>Backbone.View</code>. I'll explain this code in detail below:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoSearch = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
<span class="dt">el</span>: $(<span class="ch">&#39;#results&#39;</span>),
<span class="dt">render</span>: <span class="kw">function</span>( event ){
<span class="kw">var</span> compiled_template = <span class="kw">_</span>.<span class="fu">template</span>( $(<span class="st">&quot;#results-template&quot;</span>).<span class="fu">html</span>() );
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">html</span>( compiled_template(<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">toJSON</span>()) );
<span class="kw">return</span> <span class="kw">this</span>; <span class="co">//recommended as this enables calls to be chained.</span>
},
<span class="dt">events</span>: {
<span class="st">&quot;submit #searchForm&quot;</span>: <span class="st">&quot;search&quot;</span>,
<span class="st">&quot;click .reset&quot;</span>: <span class="st">&quot;reset&quot;</span>,
<span class="st">&quot;click .advanced&quot;</span>: <span class="st">&quot;switchContext&quot;</span>
},
<span class="dt">search</span>: <span class="kw">function</span>( event ){
<span class="co">//executed when a form &#39;#searchForm&#39; has been submitted</span>
},
<span class="dt">reset</span>: <span class="kw">function</span>( event ){
<span class="co">//executed when an element with class &quot;reset&quot; has been clicked.</span>
},
<span class="dt">switchContext</span>: <span class="kw">function</span>( event ){
<span class="co">//executed when an element with class &quot;advanced&quot; has been clicked.</span>
}
});</code></pre>
<h4 id="what-is-el">What is <code>el</code>?</h4>
<p><code>el</code> is basically a reference to a DOM element and all views must have one. It allows for all of the contents of a view to be inserted into the DOM at once, which makes for faster rendering because the browser performs the minimum required reflows and repaints.</p>
<p>There are two ways to attach a DOM element to a view: the element already exists in the page or a new element is created for the view and added manually by the developer. If the element already exists in the page, you can set <code>el</code> as either a CSS selector that matches the element or a simple reference to the DOM element.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="dt">el</span>: <span class="ch">&#39;#footer&#39;</span>,
<span class="co">// OR</span>
<span class="dt">el</span>: <span class="kw">document</span>.<span class="fu">getElementById</span>( <span class="ch">&#39;footer&#39;</span> )</code></pre>
<p>If you want to create a new element for your view, set any combination of the following view's properties: <code>tagName</code>, <code>id</code> and <code>className</code>. A new element will be created for you by the framework and a reference to it will be available at the <code>el</code> property.</p>
<pre><code>tagName: &#39;p&#39;, // required, but defaults to &#39;div&#39; if not set
className: &#39;container&#39;, // optional, you can assign multiple classes to this property like so &#39;container homepage&#39;
id: &#39;header&#39;, // optional</code></pre>
<p>The above code creates the <code>DOMElement</code> below but doesn't append it to the DOM.</p>
<pre><code>&lt;p id=&quot;header&quot; class=&quot;container&quot;&gt;&lt;/p&gt;</code></pre>
<p><strong>Understanding <code>render()</code></strong></p>
<p><code>render()</code> is an optional function that defines the logic for rendering a template. We'll use Underscore's micro-templating in these examples, but remember you can use other templating frameworks if you prefer.</p>
<p>The <code>_.template</code> method in Underscore compiles JavaScript templates into functions which can be evaluated for rendering. In the above view, I'm passing the markup from a template with id <code>results-template</code> to <code>_.template()</code> to be compiled. Next, I set the html of the <code>el</code> DOM element to the output of processing a JSON version of the model associated with the view through the compiled template.</p>
<p>Presto! This populates the template, giving you a data-complete set of markup in just a few short lines of code.</p>
<p><strong>The <code>events</code> attribute</strong></p>
<p>The Backbone <code>events</code> attribute allows us to attach event listeners to either custom selectors, or directly to <code>el</code> if no selector is provided. An event takes the form <code>{&quot;eventName selector&quot;: &quot;callbackFunction&quot;}</code> and a number of DOM event-types are supported, including <code>click</code>, <code>submit</code>, <code>mouseover</code>, <code>dblclick</code> and more.</p>
<p>What isn't instantly obvious is that under the bonnet, Backbone uses jQuery's <code>.delegate()</code> to provide instant support for event delegation but goes a little further, extending it so that <code>this</code> always refers to the current view object. The only thing to really keep in mind is that any string callback supplied to the events attribute must have a corresponding function with the same name within the scope of your view.</p>
<h2 id="collections"><a name="thebasics-collections" id="thebasics-collections">Collections</a></h2>
<p>Collections are sets of Models and are created by extending <code>Backbone.Collection</code>.</p>
<p>Normally, when creating a collection you'll also want to pass through a property specifying the model that your collection will contain, as well as any instance properties required.</p>
<p>In the following example, we create a PhotoCollection that will contain our Photo models:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoCollection = <span class="kw">Backbone.Collection</span>.<span class="fu">extend</span>({
<span class="dt">model</span>: Photo
});</code></pre>
<p><strong>Getters and Setters</strong></p>
<p>There are a few different ways to retrieve a model from a collection. The most straight-forward is to use <code>Collection.get()</code> which accepts a single id as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> skiingEpicness = <span class="kw">PhotoCollection</span>.<span class="fu">get</span>(<span class="dv">2</span>);</code></pre>
<p>Sometimes you may also want to get a model based on its client id. The client id is a property that Backbone automatically assigns models that have not yet been saved. You can get a model's client id from its <code>.cid</code> property.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> mySkiingCrash = <span class="kw">PhotoCollection</span>.<span class="fu">getByCid</span>(<span class="dv">456</span>);</code></pre>
<p>Backbone Collections don't have setters as such, but do support adding new models via <code>.add()</code> and removing models via <code>.remove()</code>.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> a = <span class="kw">new</span> <span class="kw">Backbone</span>.<span class="fu">Model</span>({ <span class="dt">title</span>: <span class="ch">&#39;my vacation&#39;</span>}),
b = <span class="kw">new</span> <span class="kw">Backbone</span>.<span class="fu">Model</span>({ <span class="dt">title</span>: <span class="ch">&#39;my holiday&#39;</span>});
<span class="kw">var</span> photoCollection = <span class="kw">new</span> PhotoCollection([a,b]);
<span class="kw">photoCollection</span>.<span class="fu">remove</span>([a,b]);</code></pre>
<p><strong>Listening for events</strong></p>
<p>As collections represent a group of items, we're also able to listen for <code>add</code> and <code>remove</code> events for when new models are added or removed from the collection. Here's an example:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoCollection = <span class="kw">new</span> <span class="kw">Backbone</span>.<span class="fu">Collection</span>();
<span class="kw">PhotoCollection</span>.<span class="fu">on</span>(<span class="st">&quot;add&quot;</span>, <span class="kw">function</span>(photo) {
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">&quot;I liked &quot;</span> + <span class="kw">photo</span>.<span class="fu">get</span>(<span class="st">&quot;title&quot;</span>) + <span class="ch">&#39; its this one, right? &#39;</span> + <span class="kw">photo</span>.<span class="fu">get</span>(<span class="st">&quot;src&quot;</span>));
});
<span class="kw">PhotoCollection</span>.<span class="fu">add</span>([
{<span class="dt">title</span>: <span class="st">&quot;My trip to Bali&quot;</span>, <span class="dt">src</span>: <span class="st">&quot;bali-trip.jpg&quot;</span>},
{<span class="dt">title</span>: <span class="st">&quot;The flight home&quot;</span>, <span class="dt">src</span>: <span class="st">&quot;long-flight-oofta.jpg&quot;</span>},
{<span class="dt">title</span>: <span class="st">&quot;Uploading pix&quot;</span>, <span class="dt">src</span>: <span class="st">&quot;too-many-pics.jpg&quot;</span>}
]);</code></pre>
<p>In addition, we're able to bind a <code>change</code> event to listen for changes to models in the collection.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">PhotoCollection</span>.<span class="fu">on</span>(<span class="st">&quot;change:title&quot;</span>, <span class="kw">function</span>(){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">&quot;there have been updates made to this collection&#39;s titles&quot;</span>);
});</code></pre>
<p><strong>Fetching models from the server</strong></p>
<p><code>Collections.fetch()</code> retrieves a default set of models from the server in the form of a JSON array. When this data returns, the current collection's contents will be replaced with the contents of the array.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> PhotoCollection = <span class="kw">new</span> <span class="kw">Backbone</span>.<span class="fu">Collection</span>;
<span class="kw">PhotoCollection</span>.<span class="fu">url</span> = <span class="ch">&#39;/photos&#39;</span>;
<span class="kw">PhotoCollection</span>.<span class="fu">fetch</span>();</code></pre>
<p>During configuration, Backbone sets a variable to denote if extended HTTP methods are supported by the server. Another setting controls if the server understands the correct MIME type for JSON:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">Backbone</span>.<span class="fu">emulateHTTP</span> = <span class="kw">false</span>;
<span class="kw">Backbone</span>.<span class="fu">emulateJSON</span> = <span class="kw">false</span>;</code></pre>
<p>The Backbone.sync method that uses these values is actually an integral part of Backbone.js. A jQuery-like ajax method is assumed, so HTTP parameters are organised based on jQuery’s API. Searching through the code for calls to the sync method show it’s used whenever a model is saved, fetched, or deleted (destroyed).</p>
<p>Under the covers, <code>Backbone.sync</code> is the function called every time Backbone tries to read or save models to the server. It uses jQuery or Zepto's ajax implementations to make these RESTful requests, however this can be overridden as per your needs. :</p>
<p>The sync function may be overriden globally as Backbone.sync, or at a finer-grained level, by adding a sync function to a Backbone collection or to an individual model.</p>
<p>There’s no fancy plugin API for adding a persistence layer – simply override Backbone.sync with the same function signature:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">Backbone</span>.<span class="fu">sync</span> = <span class="kw">function</span>(method, model, options) {
};</code></pre>
<p>The default methodMap is useful for working out what the method argument does:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> methodMap = {
<span class="ch">&#39;create&#39;</span>: <span class="ch">&#39;POST&#39;</span>,
<span class="ch">&#39;update&#39;</span>: <span class="ch">&#39;PUT&#39;</span>,
<span class="ch">&#39;delete&#39;</span>: <span class="ch">&#39;DELETE&#39;</span>,
<span class="ch">&#39;read&#39;</span>: <span class="ch">&#39;GET&#39;</span>
};</code></pre>
<p>In the above example if we wanted to log an event when <code>.sync()</code> was called, we could do this:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> id_counter = <span class="dv">1</span>;
<span class="kw">Backbone</span>.<span class="fu">sync</span> = <span class="kw">function</span>(method, model) {
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">&quot;I&#39;ve been passed &quot;</span> + method + <span class="st">&quot; with &quot;</span> + <span class="kw">JSON</span>.<span class="fu">stringify</span>(model));
<span class="kw">if</span>(method === <span class="ch">&#39;create&#39;</span>){ <span class="kw">model</span>.<span class="fu">set</span>(<span class="ch">&#39;id&#39;</span>, id_counter++); }
};</code></pre>
<p><strong>Resetting/Refreshing Collections</strong></p>
<p>Rather than adding or removing models individually, you might occasionally wish to update an entire collection at once. <code>Collection.reset()</code> allows us to replace an entire collection with new models as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">PhotoCollection</span>.<span class="fu">reset</span>([
{<span class="dt">title</span>: <span class="st">&quot;My trip to Scotland&quot;</span>, <span class="dt">src</span>: <span class="st">&quot;scotland-trip.jpg&quot;</span>},
{<span class="dt">title</span>: <span class="st">&quot;The flight from Scotland&quot;</span>, <span class="dt">src</span>: <span class="st">&quot;long-flight.jpg&quot;</span>},
{<span class="dt">title</span>: <span class="st">&quot;Latest snap of Loch Ness&quot;</span>, <span class="dt">src</span>: <span class="st">&quot;lochness.jpg&quot;</span>}]);</code></pre>
<p>Note that using <code>Collection.reset()</code> doesn't fire any <code>add</code> or <code>remove</code> events. A <code>reset</code> event is fired instead.</p>
<h3 id="underscore-utility-functions">Underscore utility functions</h3>
<p>As Backbone requires Underscore as a hard dependency, we're able to use many of the utilities it has to offer to aid with our application development. Here's an example of how Underscore's <code>sortBy()</code> method can be used to sort a collection of photos based on a particular attribute.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> sortedByAlphabet = <span class="kw">PhotoCollection</span>.<span class="fu">sortBy</span>(<span class="kw">function</span> (photo) {
<span class="kw">return</span> <span class="kw">photo</span>.<span class="fu">get</span>(<span class="st">&quot;title&quot;</span>).<span class="fu">toLowerCase</span>();
});</code></pre>
<p>The complete list of what Underscore can do is beyond the scope of this guide, but can be found in its official <a href="http://documentcloud.github.com/underscore/">docs</a>.</p>
<h2 id="events"><a name="thebasics-events" id="thebasics-events">Events</a></h2>
<p><code>Backbone.Events</code> has the ability to give any object a way to bind and trigger custom events. We can mix this module into any object easily and there isn't a requirement for events to be declared prior to them being bound.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> ourObject = {};
<span class="co">// Mixin</span>
<span class="kw">_</span>.<span class="fu">extend</span>(ourObject, <span class="kw">Backbone</span>.<span class="fu">Events</span>);
<span class="co">// Add a custom event</span>
<span class="kw">ourObject</span>.<span class="fu">on</span>(<span class="st">&quot;dance&quot;</span>, <span class="kw">function</span>(msg){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">&quot;We triggered&quot;</span> + msg);
});
<span class="co">// Trigger the custom event</span>
<span class="kw">ourObject</span>.<span class="fu">trigger</span>(<span class="st">&quot;dance&quot;</span>, <span class="st">&quot;our event&quot;</span>);</code></pre>
<p>If you're familiar with jQuery custom events or the concept of Publish/Subscribe, <code>Backbone.Events</code> provides a system that is very similar with <code>on</code> being analogous to <code>subscribe</code> and <code>trigger</code> being similar to <code>publish</code>.</p>
<p><code>on</code> basically allows us to bind a callback function to any object, as we've done with <code>dance</code> in the above example. Whenever the event is fired, our callback is invoked.</p>
<p>The official Backbone.js documentation recommends namespacing event names using colors if you end up using quite a few of these on your page. e.g:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">ourObject</span>.<span class="fu">on</span>(<span class="st">&quot;dance:tap&quot;</span>, ...);</code></pre>
<p>A special <code>all</code> event is made available in case you would like an event to be triggered when any event occurs (e.g if you would like to screen events in a single location). The <code>all</code> event can be used as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">ourObject</span>.<span class="fu">on</span>(<span class="st">&quot;all&quot;</span>, <span class="kw">function</span>(eventName){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">&quot;The name of the event passed was &quot;</span> + eventName);
});</code></pre>
<p><code>off</code> allows us to remove a callback function that has previously been bound from an object. Going back to our Publish/Subscribe comparison, think of it as an <code>unsubscribe</code> for custom events.</p>
<p>To remove the <code>dance</code> event we previously bound to <code>myObject</code>, we would simply do:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">myObject</span>.<span class="fu">off</span>(<span class="st">&quot;dance&quot;</span>);</code></pre>
<p>This will remove all callbacks for the <code>dance</code> event. If we wish to remove just a callback by a specific name, we can do:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">myObject</span>.<span class="fu">off</span>(<span class="st">&quot;dance&quot;</span>, callbackName);</code></pre>
<p>Finally, <code>trigger</code> triggers a callback for a specified event (or a space-separated listof events). e.g:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="co">// Single event</span>
<span class="kw">myObject</span>.<span class="fu">trigger</span>(<span class="st">&quot;dance&quot;</span>);
<span class="co">// Multiple events</span>
<span class="kw">myObject</span>.<span class="fu">trigger</span>(<span class="st">&quot;dance jump skip&quot;</span>);</code></pre>
<p>It is also possible to pass along additional arguments to each (or all) of these events via a second argument supported by <code>trigger</code>. e.g:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">myObject</span>.<span class="fu">trigger</span>(<span class="st">&quot;dance&quot;</span>, {<span class="dt">duration</span>: <span class="st">&quot;5 minutes&quot;</span>});</code></pre>
<h2 id="routers"><a name="thebasics-routers" id="thebasics-routers">Routers</a></h2>
<p>In Backbone, routers are used to help manage application state and for connecting URLs to application events. This is achieved using hash-tags with URL fragments, or using the browser's pushState and History API. Some examples of routes may be seen below:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="dt">http</span>:<span class="co">//unicorns.com/#whatsup</span>
<span class="dt">http</span>:<span class="co">//unicorns.com/#search/seasonal-horns/page2</span></code></pre>
<p>Note: An application will usually have at least one route mapping a URL route to a function that determines what happens when a user reaches that particular route. This relationship is defined as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="st">&quot;route&quot;</span> : <span class="st">&quot;mappedFunction&quot;</span></code></pre>
<p>Let us now define our first controller by extending <code>Backbone.Router</code>. For the purposes of this guide, we're going to continue pretending we're creating a photo gallery application that requires a GalleryRouter.</p>
<p>Note the inline comments in the code example below as they continue the rest of the lesson on routers.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> GalleryRouter = <span class="kw">Backbone.Router</span>.<span class="fu">extend</span>({
<span class="co">/* define the route and function maps for this router */</span>
<span class="dt">routes</span>: {
<span class="st">&quot;about&quot;</span> : <span class="st">&quot;showAbout&quot;</span>,
<span class="co">/*Sample usage: http://unicorns.com/#about*/</span>
<span class="st">&quot;photos/:id&quot;</span> : <span class="st">&quot;getPhoto&quot;</span>,
<span class="co">/*This is an example of using a &quot;:param&quot; variable which allows us to match </span>
<span class="co"> any of the components between two URL slashes*/</span>
<span class="co">/*Sample usage: http://unicorns.com/#photos/5*/</span>
<span class="st">&quot;search/:query&quot;</span> : <span class="st">&quot;searchPhotos&quot;</span>,
<span class="co">/*We can also define multiple routes that are bound to the same map function,</span>
<span class="co"> in this case searchPhotos(). Note below how we&#39;re optionally passing in a </span>
<span class="co"> reference to a page number if one is supplied*/</span>
<span class="co">/*Sample usage: http://unicorns.com/#search/lolcats*/</span>
<span class="st">&quot;search/:query/p:page&quot;</span> : <span class="st">&quot;searchPhotos&quot;</span>,
<span class="co">/*As we can see, URLs may contain as many &quot;:param&quot;s as we wish*/</span>
<span class="co">/*Sample usage: http://unicorns.com/#search/lolcats/p1*/</span>
<span class="st">&quot;photos/:id/download/*imagePath&quot;</span> : <span class="st">&quot;downloadPhoto&quot;</span>,
<span class="co">/*This is an example of using a *splat. splats are able to match any number of </span>
<span class="co"> URL components and can be combined with &quot;:param&quot;s*/</span>
<span class="co">/*Sample usage: http://unicorns.com/#photos/5/download/files/lolcat-car.jpg*/</span>
<span class="co">/*If you wish to use splats for anything beyond default routing, it&#39;s probably a good </span>
<span class="co"> idea to leave them at the end of a URL otherwise you may need to apply regular</span>
<span class="co"> expression parsing on your fragment*/</span>
<span class="st">&quot;*other&quot;</span> : <span class="st">&quot;defaultRoute&quot;</span>
<span class="co">/*This is a default route that also uses a *splat. Consider the</span>
<span class="co"> default route a wildcard for URLs that are either not matched or where</span>
<span class="co"> the user has incorrectly typed in a route path manually*/</span>
<span class="co">/*Sample usage: http://unicorns.com/#anything*/</span>
},
<span class="dt">showAbout</span>: <span class="kw">function</span>(){
},
<span class="dt">getPhoto</span>: <span class="kw">function</span>(id){
<span class="co">/* </span>
<span class="co"> Note that the id matched in the above route will be passed to this function</span>
<span class="co"> */</span>
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">&quot;You are trying to reach photo &quot;</span> + id);
},
<span class="dt">searchPhotos</span>: <span class="kw">function</span>(query, page){
<span class="kw">var</span> page_number = page || <span class="dv">1</span>;
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">&quot;Page number: &quot;</span> + page_number + <span class="st">&quot; of the results for &quot;</span> + query);
},
<span class="dt">downloadPhoto</span>: <span class="kw">function</span>(id, path){
},
<span class="dt">defaultRoute</span>: <span class="kw">function</span>(other){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="st">&quot;Invalid. You attempted to reach:&quot;</span> + other);
}
});
<span class="co">/* Now that we have a router setup, remember to instantiate it*/</span>
<span class="kw">var</span> myGalleryRouter = <span class="kw">new</span> GalleryRouter();</code></pre>
<p>As of Backbone 0.5+, it's possible to opt-in for HTML5 pushState support via <code>window.history.pushState</code>. This permits you to define routes such as http://www.scriptjunkie.com/just/an/example. This will be supported with automatic degradation when a user's browser doesn't support pushState. For the purposes of this tutorial, we'll use the hashtag method.</p>
<h4 id="is-there-a-limit-to-the-number-of-routers-i-should-be-using">Is there a limit to the number of routers I should be using?</h4>
<p>Andrew de Andrade has pointed out that DocumentCloud themselves usually only use a single router in most of their applications. You're very likely to not require more than one or two routers in your own projects as the majority of your application routing can be kept organized in a single controller without it getting unwieldy.</p>
<h4 id="backbone.history">Backbone.history</h4>
<p>Next, we need to initialize <code>Backbone.history</code> as it handles <code>hashchange</code> events in our application. This will automatically handle routes that have been defined and trigger callbacks when they've been accessed.</p>
<p>The <code>Backbone.history.start()</code> method will simply tell Backbone that it's OK to begin monitoring all <code>hashchange</code> events as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">Backbone.history</span>.<span class="fu">start</span>();
<span class="kw">Router</span>.<span class="fu">navigate</span>();</code></pre>
<p>As an aside, if you would like to save application state to the URL at a particular point you can use the <code>.navigate()</code> method to achieve this. It simply updates your URL fragment without the need to trigger the <code>hashchange</code> event:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="co">/*Lets imagine we would like a specific fragment for when a user zooms into a photo*/</span>
<span class="dt">zoomPhoto</span>: <span class="kw">function</span>(factor){
<span class="kw">this</span>.<span class="fu">zoom</span>(factor); <span class="co">//imagine this zooms into the image</span>
<span class="kw">this</span>.<span class="fu">navigate</span>(<span class="st">&quot;zoom/&quot;</span> + factor); <span class="co">//updates the fragment for us, but doesn&#39;t trigger the route</span>
}</code></pre>
<p>It is also possible for <code>Router.navigate()</code> to trigger the route as well as updating the URL fragment.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="dt">zoomPhoto</span>: <span class="kw">function</span>(factor){
<span class="kw">this</span>.<span class="fu">zoom</span>(factor); <span class="co">//imagine this zooms into the image</span>
<span class="kw">this</span>.<span class="fu">navigate</span>(<span class="st">&quot;zoom/&quot;</span> + factor, <span class="kw">true</span>); <span class="co">//updates the fragment for us and triggers the route</span>
}</code></pre>
<h3 id="chainable-api">Chainable API</h3>
<p>Another bit of sugar is the support for Underscore’s chain method. This works by calling the original method with the current array of models and returning the result. In case you haven’t seen it before, the chainable API looks like this:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> collection = <span class="kw">new</span> <span class="kw">Backbone</span>.<span class="fu">Collection</span>([
{ <span class="dt">name</span>: <span class="ch">&#39;Tim&#39;</span>, <span class="dt">age</span>: <span class="dv">5</span> },
{ <span class="dt">name</span>: <span class="ch">&#39;Ida&#39;</span>, <span class="dt">age</span>: <span class="dv">26</span> },
{ <span class="dt">name</span>: <span class="ch">&#39;Rob&#39;</span>, <span class="dt">age</span>: <span class="dv">55</span> }
]);
<span class="kw">collection</span>.<span class="fu">chain</span>()
.<span class="fu">filter</span>(<span class="kw">function</span>(item) { <span class="kw">return</span> <span class="kw">item</span>.<span class="fu">get</span>(<span class="ch">&#39;age&#39;</span>) &gt; <span class="dv">10</span>; })
.<span class="fu">map</span>(<span class="kw">function</span>(item) { <span class="kw">return</span> <span class="kw">item</span>.<span class="fu">get</span>(<span class="ch">&#39;name&#39;</span>); })
.<span class="fu">value</span>();
<span class="co">// Will return [&#39;Ida&#39;, &#39;Rob&#39;]</span>
Some of the Backbone-specific method will <span class="kw">return</span> <span class="kw">this</span>, which means they can be chained as <span class="dt">well</span>:
<span class="kw">var</span> collection = <span class="kw">new</span> <span class="kw">Backbone</span>.<span class="fu">Collection</span>();
collection
.<span class="fu">add</span>({ <span class="dt">name</span>: <span class="ch">&#39;John&#39;</span>, <span class="dt">age</span>: <span class="dv">23</span> })
.<span class="fu">add</span>({ <span class="dt">name</span>: <span class="ch">&#39;Harry&#39;</span>, <span class="dt">age</span>: <span class="dv">33</span> })
.<span class="fu">add</span>({ <span class="dt">name</span>: <span class="ch">&#39;Steve&#39;</span>, <span class="dt">age</span>: <span class="dv">41</span> });
<span class="kw">collection</span>.<span class="fu">pluck</span>(<span class="ch">&#39;name&#39;</span>);
<span class="co">// [&#39;John&#39;, &#39;Harry&#39;, &#39;Steve&#39;]</span></code></pre>
<h3 id="backbones-sync-api">Backbone’s Sync API</h3>
<p>The Backbone.sync method is intended to be overridden to support other backends. The built-in method is tailed to a certain breed of RESTful JSON APIs – Backbone was originally extracted from a Ruby on Rails application, which uses HTTP methods like PUT the same way.</p>
<p>The way this works is the model and collection classes have a sync method that calls Backbone.sync. Both will call this.sync internally when fetching, saving, or deleting items.</p>
<p>The sync method is called with three parameters:</p>
<ul>
<li>method: One of create, update, delete, read</li>
<li>model: The Backbone model object</li>
<li>options: May include success and error methods</li>
</ul>
<p>Implementing a new sync method can use the following pattern:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">Backbone</span>.<span class="fu">sync</span> = <span class="kw">function</span>(method, model, options) {
<span class="kw">var</span> requestContent = {}, success, error;
<span class="kw">function</span> success(result) {
<span class="co">// Handle results from MyAPI</span>
<span class="kw">if</span> (<span class="kw">options</span>.<span class="fu">success</span>) {
<span class="kw">options</span>.<span class="fu">success</span>(result);
}
}
<span class="kw">function</span> error(result) {
<span class="co">// Handle results from MyAPI</span>
<span class="kw">if</span> (<span class="kw">options</span>.<span class="fu">error</span>) {
<span class="kw">options</span>.<span class="fu">error</span>(result);
}
}
options || (options = {});
<span class="kw">switch</span> (method) {
<span class="kw">case</span> <span class="ch">&#39;create&#39;</span>:
requestContent[<span class="ch">&#39;resource&#39;</span>] = <span class="kw">model</span>.<span class="fu">toJSON</span>();
<span class="kw">return</span> <span class="kw">MyAPI</span>.<span class="fu">create</span>(model, success, error);
<span class="kw">case</span> <span class="ch">&#39;update&#39;</span>:
requestContent[<span class="ch">&#39;resource&#39;</span>] = <span class="kw">model</span>.<span class="fu">toJSON</span>();
<span class="kw">return</span> <span class="kw">MyAPI</span>.<span class="fu">update</span>(model, success, error);
<span class="kw">case</span> <span class="ch">&#39;delete&#39;</span>:
<span class="kw">return</span> <span class="kw">MyAPI</span>.<span class="fu">destroy</span>(model, success, error);
<span class="kw">case</span> <span class="ch">&#39;read&#39;</span>:
<span class="kw">if</span> (<span class="kw">model</span>.<span class="fu">attributes</span>[<span class="kw">model</span>.<span class="fu">idAttribute</span>]) {
<span class="kw">return</span> <span class="kw">MyAPI</span>.<span class="fu">find</span>(model, success, error);
} <span class="kw">else</span> {
<span class="kw">return</span> <span class="kw">MyAPI</span>.<span class="fu">findAll</span>(model, success, error);
}
}
};</code></pre>
<p>This pattern delegates API calls to a new object, which could be a Backbone-style class that supports events. This can be safely tested separately, and potentially used with libraries other than Backbone.</p>
<p>There are quite a few sync implementations out there:</p>
<ul>
<li>Backbone localStorage</li>
<li>Backbone offline</li>
<li>Backbone Redis</li>
<li>backbone-parse</li>
<li>backbone-websql</li>
<li>Backbone Caching Sync</li>
</ul>
<h3 id="conflict-management">Conflict Management</h3>
<p>Like most client-side projects, Backbone.js wraps everything in an immediately-invoked function expression:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript">(<span class="kw">function</span>(){
<span class="co">// Backbone.js</span>
}).<span class="fu">call</span>(<span class="kw">this</span>);</code></pre>
<p>Several things happen during this configuration stage. A Backbone “namespace” is created, and multiple versions of Backbone on the same page are supported through the noConflict mode:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> root = <span class="kw">this</span>;
<span class="kw">var</span> previousBackbone = <span class="kw">root</span>.<span class="fu">Backbone</span>;
<span class="kw">Backbone</span>.<span class="fu">noConflict</span> = <span class="kw">function</span>() {
<span class="kw">root</span>.<span class="fu">Backbone</span> = previousBackbone;
<span class="kw">return</span> <span class="kw">this</span>;
};</code></pre>
<p>Multiple versions of Backbone can be used on the same page by calling noConflict like this:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Backbone19 = <span class="kw">Backbone</span>.<span class="fu">noConflict</span>();
<span class="co">// Backbone19 refers to the most recently loaded version,</span>
<span class="co">// and `window.Backbone` will be restored to the previously</span>
<span class="co">// loaded version</span></code></pre>
<p>This initial configuration code also supports CommonJS modules so Backbone can be used in Node projects:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Backbone;
<span class="kw">if</span> (<span class="kw">typeof</span> exports !== <span class="ch">&#39;undefined&#39;</span>) {
Backbone = exports;
} <span class="kw">else</span> {
Backbone = <span class="kw">root</span>.<span class="fu">Backbone</span> = {};
}</code></pre>
<p>The existence of Underscore.js (also by DocumentCloud) and a jQuery-like library is checked as well.</p>
<h3 id="leverage-events">Leverage Events</h3>
<p>Backbone’s classes are designed to be inherited from. Every single one of these classes inherits from Backbone.Events:</p>
<ul>
<li>Backbone.Model</li>
<li>Backbone.Collection</li>
<li>Backbone.Router</li>
<li>Backbone.History</li>
<li>Backbone.View</li>
</ul>
<p>That means when designing applications built with Backbone, events are a key architectural component. Events are the standard way to deal with user interface actions, through the declarative event bindings on views, and also model and collection changes. However, you can easily add your own custom events.</p>
<p>When learning Backbone it’s important to get a feel for the built-in event names. Incorrectly binding a collection reset event, for example, could cause your application to render more often than it should. Mastering events is one of the quickest ways to become more productive with Backbone.</p>
<h4 id="underscore.js">Underscore.js</h4>
<p>Since Backbone depends on Underscore, it’s worth keeping this in mind when dealing with any kind of arrays or collections of data. Also, familiarity with Underscore’s methods will help work with Backbone.Collection effectively.</p>
<h4 id="views-2">Views</h4>
<p>It’s easy to slip into using <span class="math">, <em>b</em><em>u</em><em>t</em><em>a</em><em>v</em><em>o</em><em>i</em><em>d</em><em>t</em><em>h</em><em>i</em><em>s</em><em>w</em><em>h</em><em>e</em><em>r</em><em>e</em><em>p</em><em>o</em><em>s</em><em>s</em><em>i</em><em>b</em><em>l</em><em>e</em>. <em>B</em><em>a</em><em>c</em><em>k</em><em>b</em><em>o</em><em>n</em><em>e</em><em>c</em><em>a</em><em>c</em><em>h</em><em>e</em><em>s</em><em>a</em><em>v</em><em>i</em><em>e</em><em>w</em>’<em>s</em><em>e</em><em>l</em><em>e</em><em>m</em><em>e</em><em>n</em><em>t</em>, <em>s</em><em>o</em><em>u</em><em>s</em><em>e</em><em>t</em><em>h</em><em>i</em><em>s</em>. </span>el instead. Design views based on the single responsibility principle.</p>
<p>It might be tempting to let “container” view render HTML directly by using $().html, but resisting the temptation and creating a hierarchy of views will make it much easier to debug your code and write automated tests.</p>
<p>Interestingly, Backbone doesn’t have a lot of code dedicated to templates, but it can work with the template method. I use this with Require.js text file dependencies to load remote templates during development, then I use the Require.js build script to generate something suitable for deployment. This makes code easy to test and fast to load.</p>
<h2 id="inheritance-mixins"><a name="thebasics-inheritance" id="thebasics-inheritance">Inheritance &amp; Mixins</a></h2>
<p>For its inheritance, Backbone internally uses an <code>inherits</code> function inspired by <code>goog.inherits</code>, Google’s implementation from the Closure Library. It's basically a function to correctly setup the prototype chain.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"> <span class="kw">var</span> inherits = <span class="kw">function</span>(parent, protoProps, staticProps) {
...</code></pre>
<p>The only major difference here is that Backbone’s API accepts two objects containing “instance” and “static” methods.</p>
<p>Following on from this, for inheritance purposes all of Backbone's objects contain an <code>extend</code> method as follows:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">Model</span>.<span class="fu">extend</span> = <span class="kw">Collection</span>.<span class="fu">extend</span> = <span class="kw">Router</span>.<span class="fu">extend</span> = <span class="kw">View</span>.<span class="fu">extend</span> = extend;</code></pre>
<p>Most development with Backbone is based around inheriting from these objects, and they’re designed to mimic a classical object-oriented implementation.</p>
<p>If this sounds familiar, it's because <code>extend</code> is an Underscore.js utility, although Backbone itself does a lot more with this. See below for Underscore's <code>extend</code>:</p>
<pre><code>each(slice.call(arguments, 1), function(source) {
for (var prop in source) {
obj[prop] = source[prop];
}
});
return obj;</code></pre>
<p>The above isn’t quite the same as ES5’s <code>Object.create</code>, as it’s actually copying properties (methods and values) from one object to another. As this isn’t enough to support Backbone’s inheritance and class model, the following steps are performed:</p>
<ul>
<li>The instance methods are checked to see if there’s a constructor property. If so, the class’s constructor is used, otherwise the parent’s constructor is used (i.e., Backbone.Model)</li>
<li>Underscore’s extend method is called to add the parent class’s methods to the new child class</li>
<li>The <code>prototype</code> property of a blank constructor function is assigned with the parent’s prototype, and a new instance of this is set to the child’s <code>prototype</code> property Underscore’s extend method is called twice to add the static and instance methods to the child class</li>
<li>The child’s prototype’s constructor and a <code>__super__</code> property are assigned</li>
<li>This pattern is also used for classes in CoffeeScript, so Backbone classes are compatible with CoffeeScript classes.</li>
</ul>
<p><code>extend</code> can be used for a great deal more and developers who are fans of mixins will like that it can be used for this too. You can define functionality on any custom object, and then quite literally copy &amp; paste all of the methods and attributes from that object to a Backbone one:</p>
<p>For example:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"> <span class="kw">var</span> MyMixin = {
<span class="dt">foo</span>: <span class="st">&quot;bar&quot;</span>,
<span class="dt">sayFoo</span>: <span class="kw">function</span>(){alert(<span class="kw">this</span>.<span class="fu">foo</span>);}
}
<span class="kw">var</span> MyView = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
<span class="co">// ...</span>
});
<span class="kw">_</span>.<span class="fu">extend</span>(<span class="kw">MyView</span>.<span class="fu">prototype</span>, MyMixin);
myView = <span class="kw">new</span> MyView();
<span class="kw">myView</span>.<span class="fu">sayFoo</span>(); <span class="co">//=&gt; &quot;bar&quot;</span></code></pre>
<p>We can take this further and also apply it to View inheritance. The following is an example of how to extend one View using another:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Panel = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
});
<span class="kw">var</span> PanelAdvanced = <span class="kw">Panel</span>.<span class="fu">extend</span>({
});</code></pre>
<p>However, if you have an <code>initialize()</code> method in Panel, then it won't be called if you also have an <code>initialize()</code> method in PanelAdvanced, so you would have to call Panel's initialize method explicitly:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Panel = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
<span class="dt">initialize</span>: <span class="kw">function</span>(options){
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;Panel initialized&#39;</span>);
<span class="kw">this</span>.<span class="fu">foo</span> = <span class="ch">&#39;bar&#39;</span>;
}
});
<span class="kw">var</span> PanelAdvanced = <span class="kw">Panel</span>.<span class="fu">extend</span>({
<span class="dt">initialize</span>: <span class="kw">function</span>(options){
<span class="kw">this</span>.<span class="fu">constructor</span>.__<span class="fu">super</span>__.<span class="fu">initialize</span>.<span class="fu">apply</span>(<span class="kw">this</span>, [options])
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;PanelAdvanced initialized&#39;</span>);
<span class="kw">console</span>.<span class="fu">log</span>(<span class="kw">this</span>.<span class="fu">foo</span>); <span class="co">// Log: bar</span>
}
});</code></pre>
<p>This isn't the most elegant of solutions because if you have a lot of Views that inherit from Panel, then you'll have to remember to call Panel's initialize from all of them.</p>
<p>It's worth noting that if Panel doesn't have an initialize method now but you choose to add it in the future, then you'll need to go to all of the inherited classes in the future and make sure they call Panel's initialize.</p>
<p>So here's an alternative way to define Panel so that your inherited views don't need to call Panel's initialize method:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> Panel = <span class="kw">function</span> (options) {
<span class="co">// put all of Panel&#39;s initialization code here</span>
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;Panel initialized&#39;</span>);
<span class="kw">this</span>.<span class="fu">foo</span> = <span class="ch">&#39;bar&#39;</span>;
<span class="kw">Backbone.View</span>.<span class="fu">apply</span>(<span class="kw">this</span>, [options]);
};
<span class="kw">_</span>.<span class="fu">extend</span>(<span class="kw">Panel</span>.<span class="fu">prototype</span>, <span class="kw">Backbone.View</span>.<span class="fu">prototype</span>, {
<span class="co">// put all of Panel&#39;s methods here. For example:</span>
<span class="dt">sayHi</span>: <span class="kw">function</span> () {
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;hello from Panel&#39;</span>);
}
});
<span class="kw">Panel</span>.<span class="fu">extend</span> = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>;
<span class="co">// other classes then inherit from Panel like this:</span>
<span class="kw">var</span> PanelAdvanced = <span class="kw">Panel</span>.<span class="fu">extend</span>({
<span class="dt">initialize</span>: <span class="kw">function</span> (options) {
<span class="kw">console</span>.<span class="fu">log</span>(<span class="ch">&#39;PanelAdvanced initialized&#39;</span>);
<span class="kw">console</span>.<span class="fu">log</span>(<span class="kw">this</span>.<span class="fu">foo</span>);
}
});
<span class="kw">var</span> PanelAdvanced = <span class="kw">new</span> PanelAdvanced(); <span class="co">//Log: Panel initialized, PanelAdvanced initialized, bar</span>
<span class="kw">PanelAdvanced</span>.<span class="fu">sayHi</span>(); <span class="co">// Log: hello from Panel</span></code></pre>
<p>When used appropriately, Backbone's <code>extend</code> method can save a great deal of time and effort writing redundant code.</p>
<p>(Thanks to <a href="http://dailyjs.com">Alex Young</a>, <a href="http://stackoverflow.com/users/93448/derick-bailey">Derick Bailey</a> and <a href="http://stackoverflow.com/users/188740/johnnyo">JohnnyO</a> for the heads up about these tips).</p>
<h2 id="namespacing"><a name="thebasics-namespacing" id="thebasics-namespacing">Namespacing</a></h2>
<p>When learning how to use Backbone, an important and commonly overlooked area by tutorials is namespacing. If you already have experience with namespacing in JavaScript, the following section will provide some advice on how to specifically apply concepts you know to Backbone, however I will also be covering explanations for beginners to ensure everyone is on the same page.</p>
<h4 id="what-is-namespacing">What is namespacing?</h4>
<p>The basic idea around namespacing is to avoid collisions with other objects or variables in the global namespace. They're important as it's best to safeguard your code from breaking in the event of another script on the page using the same variable names as you are. As a good 'citizen' of the global namespace, it's also imperative that you do your best to similarly not prevent other developer's scripts executing due to the same issues.</p>
<p>JavaScript doesn't really have built-in support for namespaces like other languages, however it does have closures which can be used to achieve a similar effect.</p>
<p>In this section we'll be taking a look shortly at some examples of how you can namespace your models, views, routers and other components specifically. The patterns we'll be examining are:</p>
<ul>
<li>Single global variables</li>
<li>Object Literals</li>
<li>Nested namespacing</li>
</ul>
<p><strong>Single global variables</strong></p>
<p>One popular pattern for namespacing in JavaScript is opting for a single global variable as your primary object of reference. A skeleton implementation of this where we return an object with functions and properties can be found below:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myApplication = (<span class="kw">function</span>(){
<span class="kw">function</span>(){
<span class="co">// ...</span>
},
<span class="kw">return</span> {
<span class="co">// ...</span>
}
})();</code></pre>
<p>You've probably seen this technique before. A Backbone-specific example might look like this:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myViews = (<span class="kw">function</span>(){
<span class="kw">return</span> {
<span class="dt">PhotoView</span>: <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({ .. }),
<span class="dt">GalleryView</span>: <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({ .. }),
<span class="dt">AboutView</span>: <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({ .. });
<span class="co">//etc.</span>
};
})();</code></pre>
<p>Here we can return a set of views, but the same technique could return an entire collection of models, views and routers depending on how you decide to structure your application. Although this works for certain situations, the biggest challenge with the single global variable pattern is ensuring that no one else has used the same global variable name as you have in the page.</p>
<p>One solution to this problem, as mentioned by Peter Michaux, is to use prefix namespacing. It's a simple concept at heart, but the idea is you select a common prefix name (in this example, <code>myApplication_</code>) and then define any methods, variables or other objects after the prefix.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myApplication_photoView = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({}),
myApplication_galleryView = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({});</code></pre>
<p>This is effective from the perspective of trying to lower the chances of a particular variable existing in the global scope, but remember that a uniquely named object can have the same effect. This aside, the biggest issue with the pattern is that it can result in a large number of global objects once your application starts to grow.</p>
<p>For more on Peter's views about the single global variable pattern, read his <a href="http://michaux.ca/articles/javascript-namespacing">excellent post on them</a>.</p>
<p>Note: There are several other variations on the single global variable pattern out in the wild, however having reviewed quite a few, I felt the prefixing approach applied best to Backbone.</p>
<p><strong>Object Literals</strong></p>
<p>Object Literals have the advantage of not polluting the global namespace but assist in organizing code and parameters logically. They're beneficial if you wish to create easily readable structures that can be expanded to support deep nesting. Unlike simple global variables, Object Literals often also take into account tests for the existence of a variable by the same name, which helps reduce the chances of collision.</p>
<p>This example demonstrates two ways you can check to see if a namespace already exists before defining it. I commonly use Option 2.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="co">/*Doesn&#39;t check for existence of myApplication*/</span>
<span class="kw">var</span> myApplication = {};
<span class="co">/*</span>
<span class="co">Does check for existence. If already defined, we use that instance.</span>
<span class="co">Option 1: if(!myApplication) myApplication = {};</span>
<span class="co">Option 2: var myApplication = myApplication || {};</span>
<span class="co">We can then populate our object literal to support models, views and collections (or any data, really):</span>
<span class="co">*/</span>
<span class="kw">var</span> myApplication = {
<span class="dt">models </span>: {},
<span class="dt">views </span>: {
<span class="dt">pages </span>: {}
},
<span class="dt">collections </span>: {}
};</code></pre>
<p>One can also opt for adding properties directly to the namespace (such as your views, in the following example):</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myGalleryViews = myGalleryViews || {};
<span class="kw">myGalleryViews</span>.<span class="fu">photoView</span> = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({});
<span class="kw">myGalleryViews</span>.<span class="fu">galleryView</span> = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({});</code></pre>
<p>The benefit of this pattern is that you're able to easily encapsulate all of your models, views, routers etc. in a way that clearly separates them and provides a solid foundation for extending your code.</p>
<p>This pattern has a number of benefits. It's often a good idea to decouple the default configuration for your application into a single area that can be easily modified without the need to search through your entire codebase just to alter it. Here's an example of a hypothetical object literal that stores application configuration settings:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> myConfig = {
<span class="dt">language</span>: <span class="ch">&#39;english&#39;</span>,
<span class="dt">defaults</span>: {
<span class="dt">enableGeolocation</span>: <span class="kw">true</span>,
<span class="dt">enableSharing</span>: <span class="kw">false</span>,
<span class="dt">maxPhotos</span>: <span class="dv">20</span>
},
<span class="dt">theme</span>: {
<span class="dt">skin</span>: <span class="ch">&#39;a&#39;</span>,
<span class="dt">toolbars</span>: {
<span class="dt">index</span>: <span class="ch">&#39;ui-navigation-toolbar&#39;</span>,
<span class="dt">pages</span>: <span class="ch">&#39;ui-custom-toolbar&#39;</span>
}
}
}</code></pre>
<p>Note that there are really only minor syntactical differences between the Object Literal pattern and a standard JSON data set. If for any reason you wish to use JSON for storing your configurations instead (e.g. for simpler storage when sending to the back-end), feel free to.</p>
<p>For more on the Object Literal pattern, I recommend reading Rebecca Murphey's <a href="http://rmurphey.com/blog/2009/10/15/using-objects-to-organize-your-code">excellent article on the topic</a>.</p>
<p><strong>Nested namespacing</strong></p>
<p>An extension of the Object Literal pattern is nested namespacing. It's another common pattern used that offers a lower risk of collision due to the fact that even if a top-level namespace already exists, it's unlikely the same nested children do. For example, Yahoo's YUI uses the nested object namespacing pattern extensively:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">YAHOO.util.Dom</span>.<span class="fu">getElementsByClassName</span>(<span class="ch">&#39;test&#39;</span>);</code></pre>
<p>Yahoo's YUI uses the nested object namespacing pattern regularly and even DocumentCloud (the creators of Backbone) use the nested namespacing pattern in their main applications. A sample implementation of nested namespacing with Backbone may look like this:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> galleryApp = galleryApp || {};
<span class="co">// perform similar check for nested children</span>
<span class="kw">galleryApp</span>.<span class="fu">routers</span> = <span class="kw">galleryApp</span>.<span class="fu">routers</span> || {};
<span class="kw">galleryApp</span>.<span class="fu">model</span> = <span class="kw">galleryApp</span>.<span class="fu">model</span> || {};
<span class="kw">galleryApp.model</span>.<span class="fu">special</span> = <span class="kw">galleryApp.model</span>.<span class="fu">special</span> || {};
<span class="co">// routers</span>
<span class="kw">galleryApp.routers</span>.<span class="fu">Workspace</span> = <span class="kw">Backbone.Router</span>.<span class="fu">extend</span>({});
<span class="kw">galleryApp.routers</span>.<span class="fu">PhotoSearch</span> = <span class="kw">Backbone.Router</span>.<span class="fu">extend</span>({});
<span class="co">// models</span>
<span class="kw">galleryApp.model</span>.<span class="fu">Photo</span> = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({});
<span class="kw">galleryApp.model</span>.<span class="fu">Comment</span> = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({});
<span class="co">// special models</span>
<span class="kw">galleryApp.model.special</span>.<span class="fu">Admin</span> = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({});</code></pre>
<p>This is readable, clearly organized, and is a relatively safe way of namespacing your Backbone application. The only real caveat however is that it requires your browser's JavaScript engine to first locate the galleryApp object, then dig down until it gets to the function you're calling. However, developers such as Juriy Zaytsev (kangax) have tested and found the performance differences between single object namespacing vs the 'nested' approach to be quite negligible.</p>
<p><strong>Recommendation</strong></p>
<p>Reviewing the namespace patterns above, the option that I prefer when writing Backbone applications is nested object namespacing with the object literal pattern.</p>
<p>Single global variables may work fine for applications that are relatively trivial. However, larger codebases requiring both namespaces and deep sub-namespaces require a succinct solution that's both readable and scalable. I feel this pattern achieves both of these objectives and is a good choice for most Backbone development.</p>
<h1 id="practical-todos---your-first-backbone.js-app"><a name="practicaltodos">Practical: Todos - Your First Backbone.js App</a></h1>
<p>Building a Todo List application is a great way to learn about Backbone, and Backbone’s conventions. It's a simple enough app, but contains enough interesting problems to be useful, such as binding, persisting model data, routing and template rendering.</p>
<p>For this chapter, we’re going to learn how to create the Backbone.js Todo app listed on <a href="http://todomvc.com">TodoMVC.com</a>.</p>
<img src="img/todoapp.png" width="700px"/>
<p>So let's think about what we need from a high level architectural standpoint.</p>
<ul>
<li>A Todo model to describe individual todo items</li>
<li>A TodoList collection to store and persist todos</li>
<li>A way of creating todos</li>
<li>Listing todos</li>
<li>Editing existing todos</li>
<li>Completing todos</li>
<li>Deleting todos</li>
<li>A way to bookmark the items that have been completed or are remaining</li>
</ul>
<p>Basically your classic <a href="http://en.wikipedia.org/wiki/Create,_read,_update_and_delete">CRUD</a> methods. Let's get started!</p>
<h2 id="index">Index</h2>
<p>The first step is to setup the basic application dependencies, which in this case will be: <a href="http://jquery.com">jQuery</a>, <a href="http://underscorejs.org">Underscore</a>, Backbone.js and the <a href="https://github.com/jeromegn/Backbone.localStorage">Backbone LocalStorage adapter</a>. These will be loaded in our main (and only) HTML file, index.html:</p>
<pre><code>
&lt;!doctype html&gt;
&lt;html lang=&quot;en&quot;&gt;
&lt;head&gt;
&lt;meta charset=&quot;utf-8&quot;&gt;
&lt;meta http-equiv=&quot;X-UA-Compatible&quot; content=&quot;IE=edge,chrome=1&quot;&gt;
&lt;title&gt;Backbone.js • TodoMVC&lt;/title&gt;
&lt;link rel=&quot;stylesheet&quot; href=&quot;../../assets/base.css&quot;&gt;
&lt;!--[if IE]&gt;
&lt;script src=&quot;../../assets/ie.js&quot;&gt;&lt;/script&gt;
&lt;![endif]--&gt;
&lt;/head&gt;
&lt;body&gt;
&lt;script src=&quot;../../assets/base.js&quot;&gt;&lt;/script&gt;
&lt;script src=&quot;../../assets/jquery.min.js&quot;&gt;&lt;/script&gt;
&lt;script src=&quot;js/lib/underscore-min.js&quot;&gt;&lt;/script&gt;
&lt;script src=&quot;js/lib/backbone-min.js&quot;&gt;&lt;/script&gt;
&lt;script src=&quot;js/lib/backbone-localstorage.js&quot;&gt;&lt;/script&gt;
&lt;script src=&quot;js/models/todo.js&quot;&gt;&lt;/script&gt;
&lt;script src=&quot;js/collections/todos.js&quot;&gt;&lt;/script&gt;
&lt;script src=&quot;js/views/todos.js&quot;&gt;&lt;/script&gt;
&lt;script src=&quot;js/views/app.js&quot;&gt;&lt;/script&gt;
&lt;script src=&quot;js/routers/router.js&quot;&gt;&lt;/script&gt;
&lt;script src=&quot;js/app.js&quot;&gt;&lt;/script&gt;
&lt;/body&gt;
&lt;/html&gt;
</code></pre>
<p>To help demonstrate how the various parts of our application can be split up, individual concerns are cleanly organized into folders representing our models, views, collections and routers. An app.js file is used to kick everything off.</p>
<h2 id="application-html">Application HTML</h2>
<p>Now let's take a look at our application's static HTML. We're going to need an <code>&lt;input&gt;</code> for creating new todos a <code>&lt;ul id=&quot;todo-list&quot; /&gt;</code> for listing the actual todos, and a section containing some operations, such as clearing completed todos.</p>
<pre><code> &lt;section id=&quot;todoapp&quot;&gt;
&lt;header id=&quot;header&quot;&gt;
&lt;h1&gt;todos&lt;/h1&gt;
&lt;input id=&quot;new-todo&quot; placeholder=&quot;What needs to be done?&quot; autofocus&gt;
&lt;/header&gt;
&lt;section id=&quot;main&quot;&gt;
&lt;input id=&quot;toggle-all&quot; type=&quot;checkbox&quot;&gt;
&lt;label for=&quot;toggle-all&quot;&gt;Mark all as complete&lt;/label&gt;
&lt;ul id=&quot;todo-list&quot;&gt;&lt;/ul&gt;
&lt;/section&gt;
&lt;footer id=&quot;footer&quot;&gt;&lt;/footer&gt;
&lt;/section&gt;
&lt;div id=&quot;info&quot;&gt;
&lt;p&gt;Double-click to edit a todo&lt;/p&gt;
&lt;p&gt;Written by &lt;a href=&quot;https://github.com/addyosmani&quot;&gt;Addy Osmani&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;Part of &lt;a href=&quot;http://todomvc.com&quot;&gt;TodoMVC&lt;/a&gt;&lt;/p&gt;
&lt;/div&gt;</code></pre>
<p>We’ll be populating our todo-list and adding a statistics section with details about what items are left to be completed later on.</p>
<p>So far so good. Now in order to tie this into our Backbone Todo app, we're going to have to go back to the fundamentals - a Todo model.</p>
<h2 id="todo-model">Todo model</h2>
<p>The Todo model is remarkably straightforward. Firstly a todo has two attributes, a <code>title</code> and a <code>completed</code> status that indicates whether it's been completed. These attributes are passed as defaults, as you can see in the example below:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript">
<span class="kw">var</span> app = app || {};
<span class="co">// Todo Model</span>
<span class="co">// ----------</span>
<span class="co">// Our basic **Todo** model has `title`, `order`, and `completed` attributes.</span>
<span class="kw">app</span>.<span class="fu">Todo</span> = <span class="kw">Backbone.Model</span>.<span class="fu">extend</span>({
<span class="co">// Default attributes for the todo</span>
<span class="co">// and ensure that each todo created has `title` and `completed` keys.</span>
<span class="dt">defaults</span>: {
<span class="dt">title</span>: <span class="ch">&#39;&#39;</span>,
<span class="dt">completed</span>: <span class="kw">false</span>
},
<span class="co">// Toggle the `completed` state of this todo item.</span>
<span class="dt">toggle</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.<span class="fu">save</span>({
<span class="dt">completed</span>: !<span class="kw">this</span>.<span class="fu">get</span>(<span class="ch">&#39;completed&#39;</span>)
});
}
});</code></pre>
<p>We also have a <code>toggle()</code> function which allows to set whether a Todo item has been completed.</p>
<h2 id="todo-collection">Todo collection</h2>
<p>Next we have our Todo collection used to group our models. The collection is being extended by localStorage which automatically persists Todo records to HTML5 Local Storage via the Backbone LocalStorage adapter, so they're saved between page requests.</p>
<p>We've then got some static methods, <code>completed()</code> and <code>remaining()</code>, which return an array of unfinished and finished todos respectively.</p>
<p>Finally we have a <code>nextOrder()</code> function, that keeps our Todo items in sequential order as well as a <code>comparator()</code> used to sort items by their insertion order.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript">
<span class="co">// Todo Collection</span>
<span class="co">// ---------------</span>
<span class="co">// The collection of todos is backed by *localStorage* instead of a remote</span>
<span class="co">// server.</span>
<span class="kw">var</span> TodoList = <span class="kw">Backbone.Collection</span>.<span class="fu">extend</span>({
<span class="co">// Reference to this collection&#39;s model.</span>
<span class="dt">model</span>: <span class="kw">app</span>.<span class="fu">Todo</span>,
<span class="co">// Save all of the todo items under the `&quot;todos&quot;` namespace.</span>
<span class="dt">localStorage</span>: <span class="kw">new</span> Store(<span class="ch">&#39;todos-backbone&#39;</span>),
<span class="co">// Filter down the list of all todo items that are finished.</span>
<span class="dt">completed</span>: <span class="kw">function</span>() {
<span class="kw">return</span> <span class="kw">this</span>.<span class="fu">filter</span>(<span class="kw">function</span>( todo ) {
<span class="kw">return</span> <span class="kw">todo</span>.<span class="fu">get</span>(<span class="ch">&#39;completed&#39;</span>);
});
},
<span class="co">// Filter down the list to only todo items that are still not finished.</span>
<span class="dt">remaining</span>: <span class="kw">function</span>() {
<span class="kw">return</span> <span class="kw">this</span>.<span class="fu">without</span>.<span class="fu">apply</span>( <span class="kw">this</span>, <span class="kw">this</span>.<span class="fu">completed</span>() );
},
<span class="co">// We keep the Todos in sequential order, despite being saved by unordered</span>
<span class="co">// GUID in the database. This generates the next order number for new items.</span>
<span class="dt">nextOrder</span>: <span class="kw">function</span>() {
<span class="kw">if</span> ( !<span class="kw">this</span>.<span class="fu">length</span> ) {
<span class="kw">return</span> <span class="dv">1</span>;
}
<span class="kw">return</span> <span class="kw">this</span>.<span class="fu">last</span>().<span class="fu">get</span>(<span class="ch">&#39;order&#39;</span>) + <span class="dv">1</span>;
},
<span class="co">// Todos are sorted by their original insertion order.</span>
<span class="dt">comparator</span>: <span class="kw">function</span>( todo ) {
<span class="kw">return</span> <span class="kw">todo</span>.<span class="fu">get</span>(<span class="ch">&#39;order&#39;</span>);
}
});
<span class="co">// Create our global collection of **Todos**.</span>
<span class="kw">app</span>.<span class="fu">Todos</span> = <span class="kw">new</span> TodoList();</code></pre>
<h2 id="application-view">Application View</h2>
<p>So let's look at the core of the application's logic, the views. Since each todo has a fair bit of logic associated with it, such as edit in place, we're going to use the element controller pattern - a pattern which consists of two views, one that controls a collection of items, and the other deals with each individual item.</p>
<p>In other words, we're going to have one view <code>AppView</code>, which will be in charge creating new todos, and rendering the initial todo list. Then we'll have another view called TodoView instances of which will be associated with an individual Todo record. Todo instances will be in charge of editing, updating and destroying their associated todo.</p>
<p>To keep thing simple, we'll keep things 'read-only' at the moment, and won't provide any functionality for creating, editing or deleting todos:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript">
<span class="co">// The Application</span>
<span class="co">// ---------------</span>
<span class="co">// Our overall **AppView** is the top-level piece of UI.</span>
<span class="kw">app</span>.<span class="fu">AppView</span> = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
<span class="co">// Instead of generating a new element, bind to the existing skeleton of</span>
<span class="co">// the App already present in the HTML.</span>
<span class="dt">el</span>: <span class="ch">&#39;#todoapp&#39;</span>,
<span class="co">// Our template for the line of statistics at the bottom of the app.</span>
<span class="dt">statsTemplate</span>: <span class="kw">_</span>.<span class="fu">template</span>( $(<span class="ch">&#39;#stats-template&#39;</span>).<span class="fu">html</span>() ),
<span class="co">// At initialization we bind to the relevant events on the `Todos`</span>
<span class="co">// collection, when items are added or changed. Kick things off by</span>
<span class="co">// loading any preexisting todos that might be saved in *localStorage*.</span>
<span class="dt">initialize</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.<span class="fu">input</span> = <span class="kw">this</span>.$(<span class="ch">&#39;#new-todo&#39;</span>);
<span class="kw">this</span>.<span class="fu">allCheckbox</span> = <span class="kw">this</span>.$(<span class="ch">&#39;#toggle-all&#39;</span>)[<span class="dv">0</span>];
<span class="kw">this</span>.$<span class="fu">footer</span> = <span class="kw">this</span>.$(<span class="ch">&#39;#footer&#39;</span>);
<span class="kw">this</span>.$<span class="fu">main</span> = <span class="kw">this</span>.$(<span class="ch">&#39;#main&#39;</span>);
<span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">Todos</span>.<span class="fu">on</span>( <span class="ch">&#39;add&#39;</span>, <span class="kw">this</span>.<span class="fu">addAll</span>, <span class="kw">this</span> );
<span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">Todos</span>.<span class="fu">on</span>( <span class="ch">&#39;reset&#39;</span>, <span class="kw">this</span>.<span class="fu">addAll</span>, <span class="kw">this</span> );
<span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">Todos</span>.<span class="fu">on</span>( <span class="ch">&#39;all&#39;</span>, <span class="kw">this</span>.<span class="fu">render</span>, <span class="kw">this</span> );
<span class="kw">app.Todos</span>.<span class="fu">fetch</span>();
},
<span class="co">// Re-rendering the App just means refreshing the statistics -- the rest</span>
<span class="co">// of the app doesn&#39;t change.</span>
<span class="dt">render</span>: <span class="kw">function</span>() {
<span class="kw">var</span> completed = <span class="kw">app.Todos</span>.<span class="fu">completed</span>().<span class="fu">length</span>;
<span class="kw">var</span> remaining = <span class="kw">app.Todos</span>.<span class="fu">remaining</span>().<span class="fu">length</span>;
<span class="kw">if</span> ( <span class="kw">app.Todos</span>.<span class="fu">length</span> ) {
<span class="kw">this</span>.$<span class="fu">main</span>.<span class="fu">show</span>();
<span class="kw">this</span>.$<span class="fu">footer</span>.<span class="fu">show</span>();
<span class="kw">this</span>.$<span class="fu">footer</span>.<span class="fu">html</span>(<span class="kw">this</span>.<span class="fu">statsTemplate</span>({
<span class="dt">completed</span>: completed,
<span class="dt">remaining</span>: remaining
}));
} <span class="kw">else</span> {
<span class="kw">this</span>.$<span class="fu">main</span>.<span class="fu">hide</span>();
<span class="kw">this</span>.$<span class="fu">footer</span>.<span class="fu">hide</span>();
}
<span class="kw">this</span>.<span class="fu">allCheckbox</span>.<span class="fu">checked</span> = !remaining;
},
<span class="co">// Add a single todo item to the list by creating a view for it, and</span>
<span class="co">// appending its element to the `&lt;ul&gt;`.</span>
<span class="dt">addOne</span>: <span class="kw">function</span>( todo ) {
<span class="kw">var</span> view = <span class="kw">new</span> <span class="kw">app</span>.<span class="fu">TodoView</span>({ <span class="dt">model</span>: todo });
$(<span class="ch">&#39;#todo-list&#39;</span>).<span class="fu">append</span>( <span class="kw">view</span>.<span class="fu">render</span>().<span class="fu">el</span> );
},
<span class="co">// Add all items in the **Todos** collection at once.</span>
<span class="dt">addAll</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.$(<span class="ch">&#39;#todo-list&#39;</span>).<span class="fu">html</span>(<span class="ch">&#39;&#39;</span>);
<span class="kw">app.Todos</span>.<span class="fu">each</span>(<span class="kw">this</span>.<span class="fu">addOne</span>, <span class="kw">this</span>);
}
});</code></pre>
<p>You can see we've got a couple of things going on, an el (element), a <code>statsTemplate</code>, a constructor function and several view specific methods. On the left of the el: key is a DOM element selector for the element with ID <code>todoapp</code>. The value of this is just a string and Backbone will create a reference pointing to any element matching the selector #todoapp, where here it will be the <code>&lt;section id=”todoapp /&gt;</code> element, defined in the HTML section earlier.</p>
<p>In a nutshell this means we can now refer to this.el in our controller, which points to the <code>&lt;section class=&quot;todoapp&quot; /&gt;</code> element. As you can see, we're referring to el in the <code>addOne()</code> function, appending an element to the list.</p>
<p>Now let's take a look at the constructor function. It's binding to several events on the Todo model, such as add, reset and all. Since we're delegating handling of updates and deletes to the TodoView view, we don't need to to worry about that here. The two pieces of logic are:</p>
<p>When a new todo is created, the add event will be fired, calling <code>addOne()</code> which instantiates the <code>TodoView</code> view, rendering it and appending the resultant element to our todo list</p>
<p>When a reset event is called (i.e. the todos have been loaded from Local Storage), <code>addAll()</code> will be called. This function iterates over all the todos, passing them to <code>addOne()</code>.</p>
<p>We can then add in the logic for creating new todos, editing them and filtering them based on whether they are complete.</p>
<ul>
<li>events: We define an events hash containing declarative callbacks for our DOM events.</li>
<li><code>createOnEnter()</code>: When a user hits return inside the <code>&lt;input/&gt;</code> field, this creates a new Todo item and resets the main <code>&lt;input/&gt;</code> field value to prepare it for the next entry.</li>
<li><code>clearCompleted()</code>: Removes the items in the todo list that have been marked as completed</li>
<li><code>toggleAllComplete()</code>: Allows a user to set all of the items in the todo list to completed.</li>
<li><code>initialize()</code>: We bind a callback for a change:completed event, letting us know a change has been made as well to an existing todo item We also bind a callback for a filter event, which works a little similar to addOne() and addAll(). It’s responsibility is to toggle what todo items are visible based on the filter currently selected in the UI (all, completed or remaining) through filterOne() and filterAll().</li>
<li><code>render()</code>: We add some conditional CSS styling based on the filter currently selected so that the route that has been selected is highlighted</li>
<li><code>createOnEnter()</code>: Creates a new Todo model which persists in localStorage when a user hits return. This creates the model via newAttributes(), which is an object literal composed of the title, order and completed state of the new item being added.</li>
<li><code>clearCompleted()</code>: Clears all the todo items that have been marked as complete</li>
</ul>
<pre class="sourceCode javascript"><code class="sourceCode javascript">
<span class="co">// The Application</span>
<span class="co">// ---------------</span>
<span class="co">// Our overall **AppView** is the top-level piece of UI.</span>
<span class="kw">app</span>.<span class="fu">AppView</span> = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
<span class="co">// Instead of generating a new element, bind to the existing skeleton of</span>
<span class="co">// the App already present in the HTML.</span>
<span class="dt">el</span>: <span class="ch">&#39;#todoapp&#39;</span>,
<span class="co">// Our template for the line of statistics at the bottom of the app.</span>
<span class="dt">statsTemplate</span>: <span class="kw">_</span>.<span class="fu">template</span>( $(<span class="ch">&#39;#stats-template&#39;</span>).<span class="fu">html</span>() ),
<span class="co">// Delegated events for creating new items, and clearing completed ones.</span>
<span class="dt">events</span>: {
<span class="ch">&#39;keypress #new-todo&#39;</span>: <span class="ch">&#39;createOnEnter&#39;</span>,
<span class="ch">&#39;click #clear-completed&#39;</span>: <span class="ch">&#39;clearCompleted&#39;</span>,
<span class="ch">&#39;click #toggle-all&#39;</span>: <span class="ch">&#39;toggleAllComplete&#39;</span>
},
<span class="co">// At initialization we bind to the relevant events on the `Todos`</span>
<span class="co">// collection, when items are added or changed. Kick things off by</span>
<span class="co">// loading any preexisting todos that might be saved in *localStorage*.</span>
<span class="dt">initialize</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.<span class="fu">input</span> = <span class="kw">this</span>.$(<span class="ch">&#39;#new-todo&#39;</span>);
<span class="kw">this</span>.<span class="fu">allCheckbox</span> = <span class="kw">this</span>.$(<span class="ch">&#39;#toggle-all&#39;</span>)[<span class="dv">0</span>];
<span class="kw">this</span>.$<span class="fu">footer</span> = <span class="kw">this</span>.$(<span class="ch">&#39;#footer&#39;</span>);
<span class="kw">this</span>.$<span class="fu">main</span> = <span class="kw">this</span>.$(<span class="ch">&#39;#main&#39;</span>);
<span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">Todos</span>.<span class="fu">on</span>( <span class="ch">&#39;add&#39;</span>, <span class="kw">this</span>.<span class="fu">addAll</span>, <span class="kw">this</span> );
<span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">Todos</span>.<span class="fu">on</span>( <span class="ch">&#39;reset&#39;</span>, <span class="kw">this</span>.<span class="fu">addAll</span>, <span class="kw">this</span> );
<span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">Todos</span>.<span class="fu">on</span>(<span class="ch">&#39;change:completed&#39;</span>, <span class="kw">this</span>.<span class="fu">filterOne</span>, <span class="kw">this</span>);
<span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">Todos</span>.<span class="fu">on</span>(<span class="st">&quot;filter&quot;</span>, <span class="kw">this</span>.<span class="fu">filterAll</span>, <span class="kw">this</span>);
<span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">Todos</span>.<span class="fu">on</span>( <span class="ch">&#39;all&#39;</span>, <span class="kw">this</span>.<span class="fu">render</span>, <span class="kw">this</span> );
<span class="kw">app.Todos</span>.<span class="fu">fetch</span>();
},
<span class="co">// Re-rendering the App just means refreshing the statistics -- the rest</span>
<span class="co">// of the app doesn&#39;t change.</span>
<span class="dt">render</span>: <span class="kw">function</span>() {
<span class="kw">var</span> completed = <span class="kw">app.Todos</span>.<span class="fu">completed</span>().<span class="fu">length</span>;
<span class="kw">var</span> remaining = <span class="kw">app.Todos</span>.<span class="fu">remaining</span>().<span class="fu">length</span>;
<span class="kw">if</span> ( <span class="kw">app.Todos</span>.<span class="fu">length</span> ) {
<span class="kw">this</span>.$<span class="fu">main</span>.<span class="fu">show</span>();
<span class="kw">this</span>.$<span class="fu">footer</span>.<span class="fu">show</span>();
<span class="kw">this</span>.$<span class="fu">footer</span>.<span class="fu">html</span>(<span class="kw">this</span>.<span class="fu">statsTemplate</span>({
<span class="dt">completed</span>: completed,
<span class="dt">remaining</span>: remaining
}));
<span class="kw">this</span>.$(<span class="ch">&#39;#filters li a&#39;</span>)
.<span class="fu">removeClass</span>(<span class="ch">&#39;selected&#39;</span>)
.<span class="fu">filter</span>(<span class="ch">&#39;[href=&quot;#/&#39;</span> + ( <span class="kw">app</span>.<span class="fu">TodoFilter</span> || <span class="ch">&#39;&#39;</span> ) + <span class="ch">&#39;&quot;]&#39;</span>)
.<span class="fu">addClass</span>(<span class="ch">&#39;selected&#39;</span>);
} <span class="kw">else</span> {
<span class="kw">this</span>.$<span class="fu">main</span>.<span class="fu">hide</span>();
<span class="kw">this</span>.$<span class="fu">footer</span>.<span class="fu">hide</span>();
}
<span class="kw">this</span>.<span class="fu">allCheckbox</span>.<span class="fu">checked</span> = !remaining;
},
<span class="co">// Add a single todo item to the list by creating a view for it, and</span>
<span class="co">// appending its element to the `&lt;ul&gt;`.</span>
<span class="dt">addOne</span>: <span class="kw">function</span>( todo ) {
<span class="kw">var</span> view = <span class="kw">new</span> <span class="kw">app</span>.<span class="fu">TodoView</span>({ <span class="dt">model</span>: todo });
$(<span class="ch">&#39;#todo-list&#39;</span>).<span class="fu">append</span>( <span class="kw">view</span>.<span class="fu">render</span>().<span class="fu">el</span> );
},
<span class="co">// Add all items in the **Todos** collection at once.</span>
<span class="dt">addAll</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.$(<span class="ch">&#39;#todo-list&#39;</span>).<span class="fu">html</span>(<span class="ch">&#39;&#39;</span>);
<span class="kw">app.Todos</span>.<span class="fu">each</span>(<span class="kw">this</span>.<span class="fu">addOne</span>, <span class="kw">this</span>);
},
<span class="dt">filterOne </span>: <span class="kw">function</span> (todo) {
<span class="kw">todo</span>.<span class="fu">trigger</span>(<span class="st">&quot;visible&quot;</span>);
},
<span class="dt">filterAll </span>: <span class="kw">function</span> () {
<span class="kw">app.Todos</span>.<span class="fu">each</span>(<span class="kw">this</span>.<span class="fu">filterOne</span>, <span class="kw">this</span>);
},
<span class="co">// Generate the attributes for a new Todo item.</span>
<span class="dt">newAttributes</span>: <span class="kw">function</span>() {
<span class="kw">return</span> {
<span class="dt">title</span>: <span class="kw">this</span>.<span class="fu">input</span>.<span class="fu">val</span>().<span class="fu">trim</span>(),
<span class="dt">order</span>: <span class="kw">app.Todos</span>.<span class="fu">nextOrder</span>(),
<span class="dt">completed</span>: <span class="kw">false</span>
};
},
<span class="co">// If you hit return in the main input field, create new **Todo** model,</span>
<span class="co">// persisting it to *localStorage*.</span>
<span class="dt">createOnEnter</span>: <span class="kw">function</span>( e ) {
<span class="kw">if</span> ( <span class="kw">e</span>.<span class="fu">which</span> !== ENTER_KEY || !<span class="kw">this</span>.<span class="fu">input</span>.<span class="fu">val</span>().<span class="fu">trim</span>() ) {
<span class="kw">return</span>;
}
<span class="kw">app.Todos</span>.<span class="fu">create</span>( <span class="kw">this</span>.<span class="fu">newAttributes</span>() );
<span class="kw">this</span>.<span class="fu">input</span>.<span class="fu">val</span>(<span class="ch">&#39;&#39;</span>);
},
<span class="co">// Clear all completed todo items, destroying their models.</span>
<span class="dt">clearCompleted</span>: <span class="kw">function</span>() {
<span class="kw">_</span>.<span class="fu">each</span>( <span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">Todos</span>.<span class="fu">completed</span>(), <span class="kw">function</span>( todo ) {
<span class="kw">todo</span>.<span class="fu">destroy</span>();
});
<span class="kw">return</span> <span class="kw">false</span>;
},
<span class="dt">toggleAllComplete</span>: <span class="kw">function</span>() {
<span class="kw">var</span> completed = <span class="kw">this</span>.<span class="fu">allCheckbox</span>.<span class="fu">checked</span>;
<span class="kw">app.Todos</span>.<span class="fu">each</span>(<span class="kw">function</span>( todo ) {
<span class="kw">todo</span>.<span class="fu">save</span>({
<span class="ch">&#39;completed&#39;</span>: completed
});
});
}
});</code></pre>
<h2 id="setup">Setup</h2>
<p>So now we have two views: <code>AppView</code> and <code>TodoView</code>. The former needs to get instantiated when the page loads, so some code actually gets run. You can do this simply enough, by using jQuery's <code>ready()</code> utility, which will execute a function when the DOM's loaded.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript">
<span class="kw">var</span> app = app || {};
<span class="kw">var</span> ENTER_KEY = <span class="dv">13</span>;
$(<span class="kw">function</span>() {
<span class="co">// Kick things off by creating the **App**.</span>
<span class="kw">new</span> <span class="kw">app</span>.<span class="fu">AppView</span>();
});</code></pre>
<h2 id="creating-new-todos">Creating new todos</h2>
<p>It's all very good creating todos from the console, but we can hardly expect our users to do that. Let's hook up the todo creation section to provide a better interface. All the HTML is already there (in index.html); all we have to do is add some event listeners to that section, creating some todos.</p>
<img src="img/todoview.png" width="590px"/>
<p>Let’s look at the <code>TodoView</code> view. This will be in charge of individual Todo records, making sure the view updates then the todo does.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript">
<span class="co">// Todo Item View</span>
<span class="co">// --------------</span>
<span class="co">// The DOM element for a todo item...</span>
<span class="kw">app</span>.<span class="fu">TodoView</span> = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
<span class="co">//... is a list tag.</span>
<span class="dt">tagName</span>: <span class="ch">&#39;li&#39;</span>,
<span class="co">// Cache the template function for a single item.</span>
<span class="dt">template</span>: <span class="kw">_</span>.<span class="fu">template</span>( $(<span class="ch">&#39;#item-template&#39;</span>).<span class="fu">html</span>() ),
<span class="co">// The DOM events specific to an item.</span>
<span class="dt">events</span>: {
<span class="ch">&#39;dblclick label&#39;</span>: <span class="ch">&#39;edit&#39;</span>,
<span class="ch">&#39;keypress .edit&#39;</span>: <span class="ch">&#39;updateOnEnter&#39;</span>,
<span class="ch">&#39;blur .edit&#39;</span>: <span class="ch">&#39;close&#39;</span>
},
<span class="co">// The TodoView listens for changes to its model, re-rendering. Since there&#39;s</span>
<span class="co">// a one-to-one correspondence between a **Todo** and a **TodoView** in this</span>
<span class="co">// app, we set a direct reference on the model for convenience.</span>
<span class="dt">initialize</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">on</span>( <span class="ch">&#39;change&#39;</span>, <span class="kw">this</span>.<span class="fu">render</span>, <span class="kw">this</span> );
},
<span class="co">// Re-render the titles of the todo item.</span>
<span class="dt">render</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">html</span>( <span class="kw">this</span>.<span class="fu">template</span>( <span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">toJSON</span>() ) );
<span class="kw">this</span>.<span class="fu">input</span> = <span class="kw">this</span>.$(<span class="ch">&#39;.edit&#39;</span>);
<span class="kw">return</span> <span class="kw">this</span>;
},
<span class="co">// Switch this view into `&quot;editing&quot;` mode, displaying the input field.</span>
<span class="dt">edit</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">addClass</span>(<span class="ch">&#39;editing&#39;</span>);
<span class="kw">this</span>.<span class="fu">input</span>.<span class="fu">focus</span>();
},
<span class="co">// Close the `&quot;editing&quot;` mode, saving changes to the todo.</span>
<span class="dt">close</span>: <span class="kw">function</span>() {
<span class="kw">var</span> value = <span class="kw">this</span>.<span class="fu">input</span>.<span class="fu">val</span>().<span class="fu">trim</span>();
<span class="kw">if</span> ( value ) {
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">save</span>({ <span class="dt">title</span>: value });
}
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">removeClass</span>(<span class="ch">&#39;editing&#39;</span>);
},
<span class="co">// If you hit `enter`, we&#39;re through editing the item.</span>
<span class="dt">updateOnEnter</span>: <span class="kw">function</span>( e ) {
<span class="kw">if</span> ( <span class="kw">e</span>.<span class="fu">which</span> === ENTER_KEY ) {
<span class="kw">this</span>.<span class="fu">close</span>();
}
}
});</code></pre>
<p>In the <code>initialize()</code> constructor, we're setting up a listener to the todo model’s change event. In other words, when the todo updates, we want to re-render the view to reflect its changes.</p>
<p>In the <code>render()</code> method, we're rendering an Underscore.js JavaScript template, called <code>#item-template</code>, which we’ve previously compiled into this.template using Underscore’s <code>_.template()</code> method. This returns a piece of HTML that we're using to replace the view’s current element. In other words, the rendered template is now present under <code>this.el</code>, and can be appended to the todo list.</p>
<p>Our events hash includes three callbacks:</p>
<ul>
<li><code>edit()</code>: Changes the current view into editing mode when a user double-clicks on an existing item in the todo list. This allows them to change the existing value of the item’s title attribute</li>
<li><code>updateOnEnter()</code>: checks that the user has hit the return/enter key and executes the close() function.</li>
<li><code>close()</code>: This trims the value of the current text in our <code>&lt;input/&gt;</code> field, ensuring that we don’t process it further if it contains no text (e.g ‘’). If a valid value has been provided, we save the changes to the current todo model and close editing mode, by removing the corresponding CSS class.</li>
</ul>
<h2 id="in-action">In action</h2>
<p>Now we've gone far enough without checking that things work as they should. Open up index.html and, if everything's going to plan, you shouldn't see any errors in the console. The todo list will be blank (we haven't created any todos yet), and the todo-list won't work, as we haven't yet hooked it up. However, we can create a Todo from the console.</p>
<p>Type in: <code>window.app.Todos.create({ title: ‘My first Todo item});</code> and hit return.</p>
<img src="img/todoconsole.png" width="700px"/>
<p>Once you've run the above in the console, we should be looking at a brand new todo in the list of todos. Notice that if you refresh the page, the todo still persists using Local Storage.</p>
<h2 id="templates">Templates</h2>
<p>The <code>#item-template</code> used in the <code>TodoView</code> view needs defining, so let's do that. One way of including templates in the page is by using custom script tags. These don't get evaluated by the browser, which just interprets them as plain text. Underscore micro-templating can then access the templates, rendering pieces of HTML.</p>
<pre class="sourceCode html"><code class="sourceCode html"> <span class="kw">&lt;script</span><span class="ot"> type=</span><span class="st">&quot;text/template&quot;</span><span class="ot"> id=</span><span class="st">&quot;item-template&quot;</span><span class="kw">&gt;</span>
&lt;div class=<span class="st">&quot;view&quot;</span>&gt;
&lt;input class=<span class="st">&quot;toggle&quot;</span> type=<span class="st">&quot;checkbox&quot;</span> &lt;%= completed ? <span class="ch">&#39;checked&#39;</span> : <span class="ch">&#39;&#39;</span> %&gt;&gt;
&lt;label&gt;&lt;%- title %&gt;&lt;/label&gt;
&lt;button class=<span class="st">&quot;destroy&quot;</span>&gt;&lt;/button&gt;
&lt;/div&gt;
&lt;input class=<span class="st">&quot;edit&quot;</span> value=<span class="st">&quot;</span>&lt;%- <span class="st">title</span> %&gt;<span class="st">&quot;</span>&gt;
<span class="kw">&lt;/script&gt;</span></code></pre>
<p>The template tags demonstrated above, such as <code>&lt;%=</code> , are specific to Underscore.js, and documented on the Underscore site. In your own applications, you have a choice of template libraries, such as Mustache or Handlebars. Use whichever you prefer, Backbone doesn't mind.</p>
<p>Now when <code>_.template( $('#item-template').html() )</code> is called in the <code>TodoView</code> view our template will render correctly.</p>
<p>We also need to define #stats-template template we use to display how many items have been completed, as well as allowing the user to clear these items.</p>
<pre class="sourceCode html"><code class="sourceCode html"> <span class="kw">&lt;script</span><span class="ot"> type=</span><span class="st">&quot;text/template&quot;</span><span class="ot"> id=</span><span class="st">&quot;stats-template&quot;</span><span class="kw">&gt;</span>
&lt;span id=<span class="st">&quot;todo</span>-<span class="st">count&quot;</span>&gt;&lt;strong&gt;&lt;%= remaining %&gt;&lt;/strong&gt; &lt;%= remaining === <span class="dv">1</span> ? <span class="ch">&#39;item&#39;</span> : <span class="ch">&#39;items&#39;</span> %&gt; left&lt;/span&gt;
&lt;ul id=<span class="st">&quot;filters&quot;</span>&gt;
&lt;li&gt;
&lt;a class=<span class="st">&quot;selected&quot;</span> href=<span class="st">&quot;</span>#/<span class="st">&quot;</span>&gt;All&lt;/a&gt;
&lt;/li&gt;
&lt;li&gt;
&lt;a href=<span class="st">&quot;</span>#/<span class="st">active&quot;</span>&gt;Active&lt;/a&gt;
&lt;/li&gt;
&lt;li&gt;
&lt;a href=<span class="st">&quot;</span>#/<span class="st">completed&quot;</span>&gt;Completed&lt;/a&gt;
&lt;/li&gt;
&lt;/ul&gt;
&lt;% <span class="kw">if</span> (completed) { %&gt;
&lt;button id=<span class="st">&quot;clear</span>-<span class="st">completed&quot;</span>&gt;Clear completed (&lt;%= completed %&gt;)&lt;/button&gt;
&lt;% } %&gt;
<span class="kw">&lt;/script&gt;</span></code></pre>
<h2 id="in-action-1">In action</h2>
<p>Now refresh index.html to see the fruits of our labour. We should be able to type a todo name, and press return to submit the form, creating a new todo.</p>
<div class="figure">
<img src="img/todocompleted.png" /><p class="caption"></p>
</div>
<p>Excellent, we're making great progress, but how about completing and deleting todos?</p>
<h2 id="completing-deleting-todos">Completing &amp; deleting todos</h2>
<p>So the next part of our tutorial is going to cover completing and deleting todos. These two actions are specific to each Todo item, so we need to add this functionality to the TodoView view.</p>
<p>The key part of this is the two event handlers we've added, a togglecompleted event on the todo's checkbox, and a click event on the todo's <code>&lt;button class=&quot;destroy&quot; /&gt;</code> button.</p>
<p>The checkbox's togglecompleted event invokes the toggle() function, which toggles the todos's completed status, then resaving the todo - very straightforward! The button's click event invokes <code>clear()</code>, which will simply destroy the todo.</p>
<p>That's all there is to it. Since we're binding to the change event, whenever the todo changes the view will automatically be re-rendered, checking or un-checking the checkbox as appropriate. Similarly, when the todo is destroyed, the model's <code>destroy()</code> function will be called, removing the todo from the view as we’re binding to the destroy event too.</p>
<p>One more piece to mention is that we’ve also binded to a visible event to handle the visibility state of the todo item. This is used in conjunction with the filtering in our routes and collections so that we only display an item if its completed state falls in line with the current filter.</p>
<p>This tutorial is long enough as is, so we won't go into in-place editing or updating. If you want an example of that, see the <a href="https://github.com/addyosmani/todomvc/tree/master/architecture-examples/backbone/">complete source</a>.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript">
<span class="co">// Todo Item View</span>
<span class="co">// --------------</span>
<span class="co">// The DOM element for a todo item...</span>
<span class="kw">app</span>.<span class="fu">TodoView</span> = <span class="kw">Backbone.View</span>.<span class="fu">extend</span>({
<span class="co">//... is a list tag.</span>
<span class="dt">tagName</span>: <span class="ch">&#39;li&#39;</span>,
<span class="co">// Cache the template function for a single item.</span>
<span class="dt">template</span>: <span class="kw">_</span>.<span class="fu">template</span>( $(<span class="ch">&#39;#item-template&#39;</span>).<span class="fu">html</span>() ),
<span class="co">// The DOM events specific to an item.</span>
<span class="dt">events</span>: {
<span class="ch">&#39;click .toggle&#39;</span>: <span class="ch">&#39;togglecompleted&#39;</span>,
<span class="ch">&#39;dblclick label&#39;</span>: <span class="ch">&#39;edit&#39;</span>,
<span class="ch">&#39;click .destroy&#39;</span>: <span class="ch">&#39;clear&#39;</span>,
<span class="ch">&#39;keypress .edit&#39;</span>: <span class="ch">&#39;updateOnEnter&#39;</span>,
<span class="ch">&#39;blur .edit&#39;</span>: <span class="ch">&#39;close&#39;</span>
},
<span class="co">// The TodoView listens for changes to its model, re-rendering. Since there&#39;s</span>
<span class="co">// a one-to-one correspondence between a **Todo** and a **TodoView** in this</span>
<span class="co">// app, we set a direct reference on the model for convenience.</span>
<span class="dt">initialize</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">on</span>( <span class="ch">&#39;change&#39;</span>, <span class="kw">this</span>.<span class="fu">render</span>, <span class="kw">this</span> );
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">on</span>( <span class="ch">&#39;destroy&#39;</span>, <span class="kw">this</span>.<span class="fu">remove</span>, <span class="kw">this</span> );
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">on</span>( <span class="ch">&#39;visible&#39;</span>, <span class="kw">this</span>.<span class="fu">toggleVisible</span>, <span class="kw">this</span> );
},
<span class="co">// Re-render the titles of the todo item.</span>
<span class="dt">render</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">html</span>( <span class="kw">this</span>.<span class="fu">template</span>( <span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">toJSON</span>() ) );
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">toggleClass</span>( <span class="ch">&#39;completed&#39;</span>, <span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">get</span>(<span class="ch">&#39;completed&#39;</span>) );
<span class="kw">this</span>.<span class="fu">toggleVisible</span>();
<span class="kw">this</span>.<span class="fu">input</span> = <span class="kw">this</span>.$(<span class="ch">&#39;.edit&#39;</span>);
<span class="kw">return</span> <span class="kw">this</span>;
},
<span class="dt">toggleVisible </span>: <span class="kw">function</span> () {
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">toggleClass</span>( <span class="ch">&#39;hidden&#39;</span>, <span class="kw">this</span>.<span class="fu">isHidden</span>());
},
<span class="dt">isHidden </span>: <span class="kw">function</span> () {
<span class="kw">var</span> isCompleted = <span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">get</span>(<span class="ch">&#39;completed&#39;</span>);
<span class="kw">return</span> ( <span class="co">// hidden cases only</span>
(!isCompleted &amp;&amp; <span class="kw">app</span>.<span class="fu">TodoFilter</span> === <span class="ch">&#39;completed&#39;</span>)
|| (isCompleted &amp;&amp; <span class="kw">app</span>.<span class="fu">TodoFilter</span> === <span class="ch">&#39;active&#39;</span>)
);
},
<span class="co">// Toggle the `&quot;completed&quot;` state of the model.</span>
<span class="dt">togglecompleted</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">toggle</span>();
},
<span class="co">// Switch this view into `&quot;editing&quot;` mode, displaying the input field.</span>
<span class="dt">edit</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">addClass</span>(<span class="ch">&#39;editing&#39;</span>);
<span class="kw">this</span>.<span class="fu">input</span>.<span class="fu">focus</span>();
},
<span class="co">// Close the `&quot;editing&quot;` mode, saving changes to the todo.</span>
<span class="dt">close</span>: <span class="kw">function</span>() {
<span class="kw">var</span> value = <span class="kw">this</span>.<span class="fu">input</span>.<span class="fu">val</span>().<span class="fu">trim</span>();
<span class="kw">if</span> ( value ) {
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">save</span>({ <span class="dt">title</span>: value });
} <span class="kw">else</span> {
<span class="kw">this</span>.<span class="fu">clear</span>();
}
<span class="kw">this</span>.$<span class="fu">el</span>.<span class="fu">removeClass</span>(<span class="ch">&#39;editing&#39;</span>);
},
<span class="co">// If you hit `enter`, we&#39;re through editing the item.</span>
<span class="dt">updateOnEnter</span>: <span class="kw">function</span>( e ) {
<span class="kw">if</span> ( <span class="kw">e</span>.<span class="fu">which</span> === ENTER_KEY ) {
<span class="kw">this</span>.<span class="fu">close</span>();
}
},
<span class="co">// Remove the item, destroy the model from *localStorage* and delete its view.</span>
<span class="dt">clear</span>: <span class="kw">function</span>() {
<span class="kw">this</span>.<span class="fu">model</span>.<span class="fu">destroy</span>();
}
});</code></pre>
<h2 id="todo-routing">Todo routing</h2>
<p>Finally, we move on to routing, which will allow us to easily bookmark the list of items that are active as well as those which have been completed. We’ll be supporting the following routes:</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript">#/ (all - <span class="kw">default</span>)
#/active
#/completed</code></pre>
<img src="img/todorouting.png" width="700px"/>
<p>When the route changes the todo list will be filtered on a model level and the selected class on the filter links will be toggled. When an item is updated while in a filtered state, it will be updated accordingly. E.g. if the filter is active and the item is checked, it will be hidden. The active filter is persisted on reload.</p>
<pre class="sourceCode javascript"><code class="sourceCode javascript">
<span class="co">// Todo Router</span>
<span class="co">// ----------</span>
<span class="kw">var</span> Workspace = <span class="kw">Backbone.Router</span>.<span class="fu">extend</span>({
<span class="dt">routes</span>:{
<span class="ch">&#39;*filter&#39;</span>: <span class="ch">&#39;setFilter&#39;</span>
},
<span class="dt">setFilter</span>: <span class="kw">function</span>( param ) {
<span class="co">// Set the current filter to be used</span>
<span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">TodoFilter</span> = <span class="kw">param</span>.<span class="fu">trim</span>() || <span class="ch">&#39;&#39;</span>;
<span class="co">// Trigger a collection filter event, causing hiding/unhiding</span>
<span class="co">// of Todo view items</span>
<span class="kw">window</span>.<span class="fu">app</span>.<span class="fu">Todos</span>.<span class="fu">trigger</span>(<span clas