-
Notifications
You must be signed in to change notification settings - Fork 59
/
jquery-Mustache.js
222 lines (199 loc) · 7.36 KB
/
jquery-Mustache.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/**
* jQuery Mustache Plugin v0.2.3
*
* @author Jonny Reeves (http://jonnyreeves.co.uk/)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
* OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/*global jQuery, window */
(function ($, window) {
'use strict';
var templateMap = {},
instance = null,
options = {
// Should an error be thrown if an attempt is made to render a non-existent template. If false, the
// operation will fail silently.
warnOnMissingTemplates: false,
// Should an error be thrown if an attempt is made to overwrite a template which has already been added.
// If true the original template will be overwritten with the new value.
allowOverwrite: true,
// The 'type' attribute which you use to denoate a Mustache Template in the DOM; eg:
// `<script type="text/html" id="my-template"></script>`
domTemplateType: 'text/html'
};
function getMustache() {
// Lazily retrieve Mustache from the window global if it hasn't been defined by
// the User.
if (instance === null) {
instance = window.Mustache;
if (instance === void 0) {
$.error("Failed to locate Mustache instance, are you sure it has been loaded?");
}
}
return instance;
}
/**
* Returns true if the supplied templateName has been added.
*/
function has(templateName) {
return templateMap[templateName] !== void 0;
}
/**
* Registers a template so that it can be used by $.Mustache.
*
* @param templateName A name which uniquely identifies this template.
* @param templateHtml The HTML which makes us the template; this will be rendered by Mustache when render()
* is invoked.
* @throws If options.allowOverwrite is false and the templateName has already been registered.
*/
function add(templateName, templateHtml) {
if (!options.allowOverwrite && has(templateName)) {
$.error('TemplateName: ' + templateName + ' is already mapped.');
return;
}
templateMap[templateName] = $.trim(templateHtml);
}
/**
* Adds one or more tempaltes from the DOM using either the supplied templateElementIds or by retrieving all script
* tags of the 'domTemplateType'. Templates added in this fashion will be registered with their elementId value.
*
* @param templateElementId ElementId of a script block which contains the template you wish to add
*/
function addFromDom() {
var templateElementIds;
// If no args are supplied, all script blocks will be read from the document.
if (arguments.length === 0) {
templateElementIds = $('body script').filter('[type="' + options.domTemplateType + '"]').map(function () {
return this.id;
});
}
else {
templateElementIds = $.makeArray(arguments);
}
$.each(templateElementIds, function() {
var templateHtml = $('#' + this).html();
if (templateHtml === void 0) {
$.error('No such elementId: #' + this);
}
else {
add(this, templateHtml);
}
});
}
/**
* Removes a template, the contents of the removed Template will be returned.
*
* @param templateName The name of the previously registered Mustache template that you wish to remove.
* @returns String which represents the raw content of the template.
*/
function remove(templateName) {
var result = templateMap[templateName];
delete templateMap[templateName];
return result;
}
/**
* Removes all templates and tells Mustache to flush its cache.
*/
function clear() {
templateMap = {};
getMustache().clearCache();
}
/**
* Renders a previously added Mustache template using the supplied templateData object. Note if the supplied
* templateName doesn't exist an empty String will be returned.
*/
function render(templateName, templateData) {
if (!has(templateName)) {
if (options.warnOnMissingTemplates) {
$.error('No template registered for: ' + templateName);
}
return '';
}
return getMustache().to_html(templateMap[templateName], templateData, templateMap);
}
/**
* Loads the external Mustache templates located at the supplied URL and registers them for later use. This method
* returns a jQuery Promise and also support an `onComplete` callback.
*
* @param url URL of the external Mustache template file to load.
* @param onComplete Optional callback function which will be invoked when the templates from the supplied URL
* have been loaded and are ready for use.
* @returns jQuery deferred promise which will complete when the templates have been loaded and are
* ready for use.
*/
function load(url, onComplete) {
return $.get(url)
.done(function (templates) {
$(templates).filter('script').each(function () {
if (this.id) {
add(this.id, $(this).html());
}
});
if ($.isFunction(onComplete)) {
onComplete();
}
});
}
/**
* Returns an Array of templateNames which have been registered and can be retrieved via
* $.Mustache.render() or $(element).mustache().
*/
function templates() {
return $.map(templateMap, function (value, key) {
return key;
});
}
// Expose the public methods on jQuery.Mustache
$.Mustache = {
options: options,
load: load,
add: add,
addFromDom: addFromDom,
remove: remove,
clear: clear,
render: render,
templates: templates,
instance: instance
};
/**
* Renders one or more viewModels into the current jQuery element.
*
* @param templateName The name of the Mustache template you wish to render, Note that the
* Template must have been previously loaded and / or added.
* @param templateData One or more JavaScript objects which will be used to render the Mustache
* template.
* @param options.method jQuery method to use when rendering, defaults to 'append'.
*/
$.fn.mustache = function (templateName, templateData, options) {
var settings = $.extend({
method: 'append'
}, options);
var renderTemplate = function (obj, viewModel) {
$(obj)[settings.method](render(templateName, viewModel));
};
return this.each(function () {
var element = this;
// Render a collection of viewModels.
if ($.isArray(templateData)) {
$.each(templateData, function () {
renderTemplate(element, this);
});
}
// Render a single viewModel.
else {
renderTemplate(element, templateData);
}
});
};
}(jQuery, window));