Questions tagged [marionette]

Backbone.Marionette is a collection of common design and implementation patterns found in the applications that we have been building with Backbone, and includes pieces inspired by composite application architectures, event-driven architectures, messaging architectures, and more.

Important to note that Marionette introduced some breaking changes in their API when moving from 1.X to 2.X below is a quick summary of the main breaking changes that can cause errors in your app, a full report on the changes can be found on google docs.

General

• All instances of the word type in the API have been replaced with the word class. For instance:
  • regionType => regionClass
  • ChildViewType => ChildViewClass

Applications and Modules

• Application’s initialize triggerMethods have been renamed to start, which is more descriptive of what is actually happening. More specifically, initialize:before and initialize:after are now before:start and start, respectively. Note that no functionality has been lost with this change; it is merely a changing of names.

Controllers

• close has been renamed to destroy to emphasize the fact that an instance should not be reused, or ‘opened,’ after it is destroyed

Regions

• Regions now expose region.el and region.$el, just like View’s. Due to this change if you were depending on region.el to be a string selector you must update your code to use region.$el.selector.

• The open method has been renamed to attachHtml

Views

• Layout is now called LayoutView
• Renamed close to destroy for views. Close was a confusing verb for users who thought that they could be reopened. The verb destroy makes it more clear that once a view is destroyed you can not reuse it.
• Returning false from onBeforeClose no longer prevents the view from closing
• appendHtml has been renamed to attachHtml.
• appendBuffer has been renamed to attachBuffer
• Removes duplicate and inconsistent itemView events. No functionality was lost with this change; simply use the unprefixed version instead. For instance, use before:render instead of item:before:render
• childEvents callbacks no longer receives the event name as the first argument
• itemView within a collectionView is now known as childView. This removes confusion for new users as to the fact that you can show any type of view in your collectionView.
• All CollectionView methods that referenced itemView now use the same childView as well. For instance, getItemView is now getChildView. Do note that CompositeViews extend from CollectionView, so these API changes affect that Class as well.

References

• Backbone.Marionette Changelog
• Marionette.js 3.0 Documentation
• Marionette.js 2.0 Documentation
• Marionette.js 1.0 Documentation
• Backbone.Marionette Releases
• Upgrade Guide - Marionette.js Documentation
• marionettejs/Marionette.Upgrade: Helps you upgrade your marionette apps from 1.x 2.x