jQuery .tmpl(), .template()学习资料小结_jquery

昨晚无意中发现一个有趣的jQuery插件.tmpl()，其文档在 这里 。官方解释对该插件的说明：将匹配的第一个元素作为模板，render指定的数据，签名如下:

.tmpl([data,][options]) 其中参数data的用途很明显：用于render的数据，可以是任意js类型，包括数组和对象。options一般情况下都是选项了，官方指出，此处的options是一个用户自定义的键值对的map，继承自tmplItem数据结构，适用于模板render动作期间。

在 这里 可以下载到最新的tmpl插件，值的一提的是，官方同时也说明了，tmpl目前是beta版，使用需谨慎..

好吧，先来一个最直观的例子：

复制代码 代码如下:

jquery template demo ${ID} ${Name} $(function () { var users = [{ ID: 'think8848', Name: 'Joseph Chan' }, { ID: 'aCloud', Name: 'Mary Cheung'}]; $('#myTemplate').tmpl(users).appendTo('#rows'); }); body { padding: 10px; } table { border-collapse: collapse; }

例子虽然很小也很简单，但我觉得这个已经很有用了。

当然，.tmpl()还可以使用来自 远端的数据 ，比如说服务:

复制代码 代码如下: public ActionResult SampleData() { var json = new JsonResult(); json.Data = new[] { new { ID = "remote1", Name = "abcd" }, new { ID = "remote2", Name = "efg" } }; json.JsonRequestBehavior = JsonRequestBehavior.AllowGet; return json; } 这是一个MVC的Action，我把它当做是一个提供数据的服务，然后js代码如下: 复制代码 代码如下: $('#btnAjax').click(function () { $.getJSON('@Url.Action("SampleData", "Home")', function (json) { $('#rows').empty(); $('#myTemplate').tmpl(json).appendTo('#rows'); }); }); 效果:

定义模板 时，推荐的方式为定义使用

'templateName' type= 'text/x-jquery-tmpl' > 做为模板的包装器，但定义方式并不只有这一种，你可以使用

div id = "template" style = "display: none;" > div > 的方式来定义，但是官方文档中说，这种方法可能会产生浏览器无法解析的HTML，因此不推荐使用，不过我试了下，倒没有出什么意外：

HTML:

复制代码 代码如下: ${ID} ${Name}

Javascript: 复制代码 代码如下: var users = [{ ID: 'think8848', Name: 'Joseph Chan' }, { ID: 'aCloud', Name: 'Mary Cheung'}]; $('#inline').tmpl(users).appendTo('#container'); 效果:

编译缓存模板 ，在jQuery .tmpl()中，还可以将模板事先编译并缓存起来，然后在合适的时侯再使用，这对于一些数据嵌套是很有用的，如: Html

复制代码 代码如下: Javascript 复制代码 代码如下: {{tmpl 'cached'}} ${ID} ${Name} ${Group} $(function () { var groupUsers = [{ ID: 'think8848', Name: 'Joseph Chan', Group: 'Administrators' }, { ID: 'aCloud', Name: 'Mary Cheung', Group: 'Users'}]; $('#compile2').template('cached'); $('#compile1').tmpl(groupUsers).appendTo('#compileRows'); }); 效果:

$.template()方法， 将一段Html编译为模板，示例:

Javascript

复制代码 代码如下: var markup = ' ${ID} ${Name} '; $.template('template', markup); $.tmpl('template', users).appendTo('#templateRows'); 这样就可以将markup中定义的模板应用于templateRows对象。 jQuery .tmpl()的标签，表达式，属性： ${}:从前面的例子来看，这个标签的作用很明显了，相当于是占位符，但是它还有另一种写法{{= field}}如: 复制代码 代码如下: {{= ID}} {{= Name}} 必须要注意的是，"="号后必须跟一个空格，不然是没有效果的。 另外，${}中还可以放表达式，这个牛x吧，如: Html 复制代码 代码如下: Javascript 复制代码 代码如下: $(function () { var userLangs = [{ ID: 'think8848', Name: 'Joseph Chan', Langs: ['Chinese', 'English'] }, { ID: 'aCloud', Name: 'Mary Cheung', Langs: ['Chinese', 'French']}]; $('#expression').tmpl(userLangs).appendTo('#expressionRows'); }); 效果：

jQuery .tmpl()有两个比较有用的属性: $item 、 $data :

$item代表当前的模板；$data代表当前的数据。

Html

复制代码 代码如下: Javascript 复制代码 代码如下: ${ID} ${$data.Name} ${$item.getLangs('; ')} $(function () { var userLangs = [{ ID: 'think8848', Name: 'Joseph Chan', Langs: ['Chinese', 'English'] }, { ID: 'aCloud', Name: 'Mary Cheung', Langs: ['Chinese', 'French']}]; $('#property').tmpl(userLangs, { getLangs: function (separator) { return this.data.Langs.join(separator); } }) .appendTo('#propertyRows'); }); 效果:

{{each}} 这个标签一看就知道是做循环用的了，用法如下：

Html

复制代码 代码如下: Javascript 复制代码 代码如下: ID: ${ID}; Name: ${Name}; Langs: {{each Langs}} ${$index + 1}: ${$value}. {{/each}} $(function () { var userLangs = [{ ID: 'think8848', Name: 'Joseph Chan', Langs: ['Chinese', 'English'] }, { ID: 'aCloud', Name: 'Mary Cheung', Langs: ['Chinese', 'French']}]; $('#each').tmpl(userLangs).appendTo('#eachList'); }); 效果:

{{each}}还有另一种写法:

Javascript

"each2" type= "text/x-jquery-tmpl" > ID: ${ID}; Name: ${Name}; Langs: {{each(i,lang) Langs}} ${i + 1}: ${lang}. {{/each}} 作用和前一种是一样的。

{{if}}和{{else}} ，这两个标签应该一看就知道作用了，直接上示例:

Javascript

"ifelse" type= "text/x-jquery-tmpl" > ${ID} ${Name} {{ if Langs.length > 1}}${Langs.join( '; ' )}{{ else }}${Langs}{{/ if }} 如果Langs数组元素超过1个，则用'; '连接起来，否则就直接显示Langs，效果:

{{html}} ，直接将对象属性值作为HTML代码替换占位符：

Javascript

"html" type= "text/x-jquery-tmpl" > ${ID} ${Name} {{html Ctrl}} "text/javascript" > $( function () { var ctrls = [{ ID: 'think8848' , Name: 'Joseph Chan' , Ctrl: ' ' }, { ID: 'aCloud' , Name: 'Mary Cheung' , Ctrl: ' ' }]; $( '#html' ).tmpl(ctrls).appendTo( '#htmlRows' ); }); 效果:

{{tmpl}} ，前面已经提过该标签了，这里再给一个使用参数的例子:

Javascript

"tmpl1" type= "text/x-jquery-tmpl" > ${ID} ${Name} {{tmpl($data) '#tmpl2' }} "tmpl2" type= "type/x-jquery-tmpl" > {{each Langs}}${$value} {{/each}} "text/javascript" > $( function () { var userLangs = [{ ID: 'think8848' , Name: 'Joseph Chan' , Langs: [ 'Chinese' , 'English' ] }, { ID: 'aCloud' , Name: 'Mary Cheung' , Langs: [ 'Chinese' , 'French' ]}]; $( '#tmpl1' ).tmpl(userLangs).appendTo( '#tmplRows' ); }); 效果:

{{wrap}} ,包装器，这回不需要指定对哪一个元素使用模板了，直接生成模板的包装器，示例:

Html

div id = "wrapDemo" > div > Javascript

"myTmpl" type= "text/x-jquery-tmpl" > The following wraps and reorders some HTML content: {{wrap "#tableWrapper" }} One First content Two And more content ... {{/wrap}} "tableWrapper" type= "text/x-jquery-tmpl" > "0" cellpadding= "3" border= "1" > {{each $item.html( "h3" , true )}} ${$value} {{/each}} {{each $item.html( "div" )}} {{html $value}} {{/each}} "text/javascript" > $( function () { $( '#myTmpl' ).tmpl().appendTo( '#wrapDemo' ); }); 效果:

$.tmplItem() 方法，使用这个方法，可以获取从render出来的元素上重新获取$item，示例:

$( 'tbody' ).delegate( 'tr' , 'click' , function () { var item = $.tmplItem( this ); alert(item.data.Name); }); 效果:

至此，官方的API中介绍的内容就完了，我的E文水平不高，对于某些细节难免理解不周，如有谬误之处，敬请指正，谢谢。 源代码下载

jQuery .tmpl(), .template()学习资料小结_jquery

相关文章