Extra regions for marionette.
npm install --save regions-extras
and now register in Handlebars
import 'regions-extras';Allow you specify region as placeholder to replace with real view dom element.
For example we have this template:
<body>
<div id="region"></div>
</body>and this script:
var ReplaceRegion = require('regions-extras/lib/ReplaceRegion');
var region = new ReplaceRegion({
el: '#region'
});
region.show(new SomeList({
tagName: 'ul'
});the result wil be:
<body>
<ul>
<!-- some code that generate view -->
</ul>
</body>It is register in region manager as replace.
This region work like replace region, but it delay view render. Region expect implemented promise method in view, which
return promise (jQuery.Deferred or Promise for example). View will be rendered when promise fulfilled.
var AsyncReplaceRegion = require('regions-extras/lib/AsyncReplaceRegion');
var AsyncView = Backbone.View.extend({
promise: function () {
return this.model.fetch();
}
});
var region = new AsyncReplaceRegion({
el: '#region'
});
region.show(new SomeList({
model: new User({id: 12})
});It is registered in region manager as async_replace.
Another way of working with the AsyncReplaceRegion is providing a custom promise to it.
After resolving a promise the AsyncReplaceRegion starts working the same as the ReplaceRegion.
var AsyncReplaceRegion = require('regions-extras/lib/AsyncReplaceRegion');
var region = new AsyncReplaceRegion({
el: '#region',
promise: function() {
return this.model.fetch();
}
});
region.show(MyCustomView);Handlebars helper, which mark place for region and inject it to Marionette.Layout that use it.
For example:
and Layout:
require('region-extras');
var Layout = Marionette.View.extend({
template: require('./tpl/template.hbs'),
onRender: function () {
this.test.show(new SomeView()); // region 'test' will be appeared here automatic
}
});It is use replace region by default for now.
Additionally, region helper allow you override some useful options:
You can specify class of region to create
It is like regionClass option, but use region manager to create region
in js
var manager = require('regions-extras/lib/RegionManager').defaultManager;
manager.addRegion('my_region', SomeRegionClass);and in template
If you require builtin regions (ReplaceRegion or AsyncReplaceRegion) we register it for you
This option is sugar for regionType option. It is append async_ prefix to regionType
This option is optional and is used for resolving async region to start showing views in it.
If not provided, the view.promise() method will be invoked instead every time you call the
region.show() method.
- Marionette 3
- Async regions use native
Promiseinternally instead ofjQuery.Deferred
- Add
_parentlink to every view which attach to region, to unify method of parent search
- All regions now have link to parent in
_parentView - Use
$elinstead ofelwhen possible - More strong replacement in replace region
- BC: API change. Helper register now looks like:
require('regions-extras').register({
Handlebars: require('injectify/runtime'),
Marionette: require('backbone.marionette')
});- BC: remove handlebars and marionette registry. Pass instances to register function
- BC: remove replace-region file from root, use
require('regions-extras/region/ReplaceRegion')instead
- BC: Async regions expect
View.promisemethod. Early wasthenmethod.
- Auto load replace region to avoid BC
- Add region manager
- Add
async,regionTypeoptions - Add
AsyncReplaceRegion
- Add regionClass option
- #4 Can't use region for second time
- Karma + jasmine specs
- Pass
viewoption through helper
tagandtagNameoption to setup tagName
- Marionette 2.0