cartodb-4.42/lib/assets/javascripts/builder/components/view-factory.js
2024-04-06 05:25:13 +00:00

79 lines
2.4 KiB
JavaScript
Executable File

var _ = require('underscore');
var CoreView = require('backbone/core-view');
/**
* Convenient factory to create views without having to create new files.
*/
module.exports = {
/**
* @param {String} html e.g. '<div>whatever</div>'
* @param {Object,undefined} viewOpts view options, .e.g {className: 'Whatever'}
* @return {Object} instance of CoreView, which takes two params of template and templateData
*/
createByHTML: function (html, viewOpts) {
var view = new CoreView(viewOpts);
view.render = function () {
this.$el.html(html);
return this;
};
return view;
},
/**
* @param {Function} template e.g. from a `require('-/my-template.tpl')`
* @param {Object,undefined} templatedata
* @param {Object,undefined} viewOpts view options, .e.g {className: 'Whatever'}
* @return {Object} instance of CoreView, which takes two params of template and templateData
*/
createByTemplate: function (template, templateData, viewOpts) {
var view = new CoreView(viewOpts);
view.render = function () {
this.$el.html(
template(templateData)
);
return this;
};
return view;
},
/**
* Creates an anonymous view to render a list of views as one.
* Useful when wanting to interact with other components that requires a single view as content.
*
* @example
* var createViewList = [
* function() { return new HeaderView({…}); },
* function() { return new ItemsView({…}); },
* function() { return new FooterView({…}); }
* ]
* viewFactory.createListView(createViewList, {className: 'jsdoc-example'})
*
* @param {Array} fns - list of functions, each which should return a view representing an item in the list
* @param {Object} viewOpts
* @return {Object} A view
*/
createListView: function (createViewFns, viewOpts) {
if (!(createViewFns && createViewFns.forEach)) throw new Error('createViewFns is required as an iterable list');
if (!_.all(createViewFns, _.isFunction)) throw new Error('createViewFns must only contain functions');
var listView = new CoreView(viewOpts);
listView.render = function () {
this.clearSubViews();
createViewFns.forEach(function (createItemView) {
var view = createItemView();
this.addView(view);
this.$el.append(view.render().el);
}, this);
return this;
};
return listView;
}
};