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.

In addition to the full library, each element in Toolkit is available as it's own npm module.

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

Asnyc App start - How to easily start apps asynchronously

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

Via npm

$ npm install marionette.toolkit

Via bower

$ bower install marionette.toolkit

Currently Marionette.Toolkit is available via npm and bower. If you would like add it to 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.2.0+ as it utilizes Marionette.Error and extends Marionette.Object

It's possible this library would work with earlier versions by manually adding Marionette.Error and shimming Marionette.Object = Marionette.Controller;

This library is tested with v2.2+ and a mix of underscore and lodash versions.

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, and submit pull requests to fix problems or to create summarized and documented feature requests (preferably with the feature implemented in the pull request).

===

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

Changelog

v0.4.1

• Updated underscore and backbone dependencies.
• Small refactor to defaulting empty passed in options as an object.