marionette.toolkit

Marionette.Toolkit

About Marionette.Toolkit

Marionette.Toolkit is a collection of opinionated extensions for Marionette Each element helps to reduce boilerplate for complex large scale application problems. This toolkit was built from scripts open sourced from RoundingWell.com.

Documentation

StateClass - Marionette.Object with a Backbone.Model for keeping state.

Component - Reusable StateClass with View management boilerplate

AbstractApp - Object including a start/stop lifecycle and running event registry.

App - AbstractApp with mixed in "App Manager" for adding and removing child Apps

Getting Help

If you have questions or concerns please feel free to open an issue. Additionally join us on the Marionette Gitter to have a chat. Everyone there is happy to discuss design patterns.

Project Details

Library Downloads

You can download the latest builds directly from the dist folder above.

Available Packages

Marionette.Toolkit is not yet available via package manager, but will soon be released via npm. If you would like another channel, please open an issue.

Changelog

For change logs and release notes, see the changelog file.

Compatibility and Requirements

Marionette.Toolkit currently requires Marionette 2.1.0+ as it extends Marionette.Object

It's possible this library would work with earlier versions by shiming Marionette.Object = Marionette.Controller;

This library is currently only tested with the latest version of Marionette.

Marionette.Toolkit supports IE8+ and modern browsers.

How to Contribute

If you would like to contribute to Marionette.Toolkit'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.

You can also join us in the Marionette Toolkit Gitter to think up new features, report bugs, ask questions, and talk design patterns within Toolkit.

Github Issues

Report issues with Marionette.Toolkit, submit pull requests to fix problems, or to create summarized and documented feature requests (preferably with pull requests that implement the feature).

===

This library is © 2015 RoundingWell. Distributed under MIT license.

Changelog

v0.2.0

• 100% Code Coverage @brentli1!!
• Component now mixes in the StateModel instance as stateModel instead of model
• stateDefaults are now on StateClass and defaults was removed from `Component
• Added Toolkit.noConflict
• App now has a triggerStart method that can be overridden to introduce async app starts
• App buildApp is now easier to override
• Component buildView is now easier to override
• You can now pass options to the Component's view via showIn show and renderView
• Component now attaches its view as currentView instead of view
• bugfixes