The Backbone Framework
#TODO# Update documentation
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.
All of the documentation for Marionette can be found at
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.
Find us on gitter.
We're happy to discuss design patterns and learn how you're using Marionette.
- Scalable: applications built in modules with event-driven architecture
- Sensible defaults: Underscore templates are used for view rendering
- Easily modifiable: works with the specific needs of your application
- Reduce boilerplate: for all views, including specialized types
- Create: application visuals at runtime with
RegionandViewobjects - Nested:
Views andCollectionViews within visual regions - Built-in: memory management and zombie-killing for
Views,CollectionViewsa andRegions - Event-driven architecture: utilizing
Radio - Flexible: "as-needed" architecture allowing you to pick and choose what you need
- And much, much more
You can download the latest builds directly or visit the downloads section on the Marionette website for more downloading options.
Marionette is available via npm:
# NPM
npm install marionetteChangelog: 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.
The source code for Marionette is heavily documented. You can read the annotations for all the details of how Marionette works and advice on which methods to override.
MarionetteJS currently works with the following libraries:
- jQuery v3.5.1+
- Underscore v1.11.0+
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 is listed here.
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).