Backbone.Marionette
Make your Backbone.js apps dance!
About Marionette
Backbone.Marionette is a composite application library for Backbone.js that
aims to simplify the construction of large scale JavaScript applications.
It is a collection of common design and implementation patterns found in
applications.
App Architecture On Backbone's Building Blocks
Backbone provides a great set of building blocks for our JavaScript
applications. It gives us the core constructs that are needed to build
small apps, organize jQuery DOM events, or create single page apps that
support mobile devices and large scale enterprise needs. But Backbone is
not a complete framework. It's a set of building blocks. It leaves
much of the application design, architecture and scalability to the
developer, including memory management, view management, and more.
Marionette brings an application architecture to Backbone, along with
built in view management and memory management. It's designed to be a
lightweight and flexible library of tools that sits on top of Backbone,
providing the framework for building a scalable application.
Like Backbone itself, you're not required to use all of Marionette just
because you want to use some of it. You can pick and choose which features
you want to use. This allows you to work with other Backbone
frameworks and plugins easily. It also means that you are not required
to engage in an all-or-nothing migration to begin using Marionette.
Chat with us
Find us on gitter or on IRC in the FreeNode.net #marionette channel.
We're happy to discuss design patterns and learn how you're using Marionette.
Key Benefits
- Scalable: applications are built in modules, and with event-driven architecture
- Sensible defaults: Underscore templates are used for view rendering
- Easily modifiable: make it work with your application's specific needs
- Reduce boilerplate for views, with specialized view types
- Build on a modular architecture with an
Application
and modules that attach to it - Compose your application's visuals at runtime, with the
Region
and LayoutView
objects - Nested views and layouts within visual regions
- Built-in memory management and zombie-killing in views, regions and layoutViews
- Event-driven architecture with
Backbone.Wreqr.EventAggregator
- Flexible, "as-needed" architecture allowing you to pick and choose what you need
- And much, much more
Source Code and Downloads
You can download the latest builds directly from the "lib" folder above.
For more information about the files in this folder, or to obtain an archive
containing all Marionette dependencies (including Underscore, Backbone, etc.),
please visit the downloads section on the website.
Available Packages
Marionette is unofficially available from various package
management systems, such as RubyGems, Node Package Manager,
Nuget, etc. These packages are maintained by the community
and are not part of the core Backbone.Marionette code.
Release Notes And Upgrade Guide
Changelog: For change logs and release notes, see the
changelog file.
Upgrade Guide: Be sure to read the upgrade guide
for information on upgrading to the latest version of Marionette.
Documentation
The primary documentation is split up into multiple files, due to the size
of the overall documentation. You can find these files in the
/docs folder, or use the links below to get straight to the
documentation for each piece of Marionette.
Annotated Source Code
In addition to this readme, I've commented the source code quite
heavily and run it through Docco as part of my build process.
This produces a nicely formatted, annotated source code as a documentation
file.
You can read the annotations for all the details of how Marionette works, and advice on which methods to override.
Marionette's Pieces
These are the strings that you can pull to make your puppet dance.
If you're looking for an introduction and/or
examples on how to get started, please visit the Wiki.
Views
Behaviors
- Marionette.Behavior: an encapsulated
View
interaction layer that can be mixed into any view
, helping to DRY up your view code. - Marionette.Behaviors: A helper class to glue your behaviors to your views.
View Management
Application Infrastructure
Other
Deprecated Items
- [→] Backbone.EventBinder: Deprecated w/ Backbone v0.9.9 and higher. An event binding manager for Backbone v0.9.2, to facilitate binding and unbinding of events
The Wiki: Sample Apps, Tutorials, and Much More
A wiki is an important aspect of a thriving community, as it provides
a place for the community to contribute ideas, examples, answer
frequently asked questions, and more. If you're looking for
community-driven information, examples that go beyond the
dry technical documentation, or want to contribute your own
ideas and examples to the community, please see the wiki page.
Compatibility and Requirements
MarionetteJS currently works with the following libraries:
Marionette has not been tested against any other versions of these
libraries. You may or may not have success if you use a version other
than what it listed here.
While support for Zepto and EnderJS has been added, it is not officially
tested against these libraries at this time.
How to Contribute
If you would like to contribute to Marionette's source code, please read
the guidelines for pull requests and contributions.
Following these guidelines will help make your contributions easier to
bring into the next release.
Report issues with Marionette, submit pull requests to fix problems, or to
create summarized and documented feature requests (preferably with pull
requests that implement the feature).
MIT License
Copyright (c) 2012-2014 Derick Bailey; Muted Solutions, LLC
Distributed under MIT license.