Knockout应用开发指南 第五章:创建自定义绑定

原文:Knockout应用开发指南 第五章:创建自定义绑定

创建自定义绑定

你可以创建自己的自定义绑定 – 没有必要非要使用内嵌的绑定(像click,value等)。你可以你封装复杂的逻辑或行为,自定义很容易使用和重用的绑定。例如,你可以在form表单里自定义像grid,tabset等这样的绑定。

重要:以下文档只应用在Knockout 1.1.1和更高版本,Knockout 1.1.0和以前的版本在注册API上是不同的。

 

注册你的绑定

添加子属性到ko.bindingHandlers来注册你的绑定:

ko.bindingHandlers.yourBindingName = {    init: function(element, valueAccessor, allBindingsAccessor, viewModel) {// This will be called when the binding is first applied to an element        // Set up any initial state, event handlers, etc. here    },

update: function(element, valueAccessor, allBindingsAccessor, viewModel) {// This will be called once when the binding is first applied to an element,        // and again whenever the associated observable changes value.        // Update the DOM element based on the supplied values here.    }};

… 然后就可以在任何DOM元素上使用了:

<div data-bind="yourBindingName: someValue"> </div>

注:你实际上没必要把init和update这两个callbacks都定义,你可以只定义其中的任意一个。

 

update 回调

当管理的observable改变的时候,KO会调用你的update callback函数,然后传递以下参数:

  • element — 使用这个绑定的DOM元素
  • valueAccessor —JavaScript函数,通过valueAccessor()可以得到应用到这个绑定的model上的当前属性值。
  • allBindingsAccessor —JavaScript函数,通过allBindingsAccessor ()得到这个元素上所有model的属性值。
  • viewModel — 传递给ko.applyBindings使用的 view model参数,如果是模板内部的话,那这个参数就是传递给该模板的数据。

 

例如,你可能想通过 visible绑定来控制一个元素的可见性,但是你想让该元素在隐藏或者显示的时候加入动画效果。那你可以自定义自己的绑定来调用jQuery的slideUp/slideDown 函数:

ko.bindingHandlers.slideVisible = {    update: function(element, valueAccessor, allBindingsAccessor) {// First get the latest data that we're bound to        var value = valueAccessor(), allBindings = allBindingsAccessor();        

// Next, whether or not the supplied model property is observable, get its current value        var valueUnwrapped = ko.utils.unwrapObservable(value);

// Grab some more data from another binding property        var duration = allBindings.slideDuration || 400;

// 400ms is default duration unless otherwise specified

// Now manipulate the DOM element

if (valueUnwrapped == true)            $(element).slideDown(duration); // Make the element visible        else            $(element).slideUp(duration);   // Make the element invisible    }};

然后你可以像这样使用你的绑定:

<div data-bind="slideVisible: giftWrap, slideDuration:600">You have selected the option</div><label><input type="checkbox" data-bind="checked: giftWrap"/> Gift wrap</label> 

<script type="text/javascript">var viewModel = {        giftWrap: ko.observable(true)    };    ko.applyBindings(viewModel);</script>

当然,看来可能代码很多,但是一旦你创建了自定义绑定,你就可以在很多地方重用它。

 

init 回调

Knockout在DOM元素使用自定义绑定的时候会调用你的init函数。init有两个重要的用途:

  • 为DOM元素设置初始值
  • 注册事件句柄,例如当用户点击或者编辑DOM元素的时候,你可以改变相关的observable值的状态。

 KO会传递和update回调函数一样的参数。

继续上面的例子,你可以像让slideVisible在页面第一次显示的时候设置该元素的状态(但是不使用任何动画效果),而只是让动画在以后改变的时候再执行。你可以这样来做:

ko.bindingHandlers.slideVisible = {    init: function(element, valueAccessor) {var value = ko.utils.unwrapObservable(valueAccessor());// Get the current value of the current property we're bound to        $(element).toggle(value);// jQuery will hide/show the element depending on whether "value" or true or false    },

update: function(element, valueAccessor, allBindingsAccessor) {// Leave as before    }};

这就是说giftWrap的初始值声明的是false(例如giftWrap: ko.observable(false)),然后让初始值会让关联的DIV隐藏,之后用户点击checkbox的时候会让元素显示出来。

 

DOM事件之后更新observable值

你已经值得了如何使用update回调,当observable值改变的时候,你可以更新相关的DOM元素。但是其它形式的事件怎么做呢?比如当用户对某个DOM元素有某些action操作的时候,你想更新相关的observable值。

你可以使用init回调来注册一个事件句柄,这样可以改变相关的observable值,例如,

ko.bindingHandlers.hasFocus = {

init: function (element, valueAccessor) {        $(element).focus(function () {var value = valueAccessor();            value(true);        });

$(element).blur(function () {var value = valueAccessor();            value(false);        });    },

update: function (element, valueAccessor) {var value = valueAccessor();if (ko.utils.unwrapObservable(value))            element.focus();else            element.blur();    }};

现在你可以通过hasFocus绑定来读取或者写入这个observable值了:

<p>Name: <input data-bind="hasFocus: editingName"/></p><!-- Showing that we can both read and write the focus state --><div data-bind="visible: editingName">You're editing the name</div><button data-bind="enable: !editingName(), click:function() { editingName(true) }">Edit name</button>

<script type="text/javascript">var viewModel = {        editingName: ko.observable()    };    ko.applyBindings(viewModel);</script>

 

时间: 2024-10-25 22:25:36

Knockout应用开发指南 第五章:创建自定义绑定的相关文章

Knockout应用开发指南 第四章:模板绑定

原文:Knockout应用开发指南 第四章:模板绑定 模板绑定The template binding 目的 template绑定通过模板将数据render到页面.模板绑定对于构建嵌套结构的页面非常方便.默认情况, Knockout用的是流行的jquery.tmpl模板引擎.使用它的话,需要在安装页面下载和引用jquery.tmpl和jQuery框架.或者你也可以集成其它的模板引擎(虽然需要了解Knockout 内部知识才行).   例子 <div data-bind='template: &quo

Knockout应用开发指南 第三章:绑定语法(3)

原文:Knockout应用开发指南 第三章:绑定语法(3) 12   value 绑定 目的 value绑定是关联DOM元素的值到view model的属性上.主要是用在表单控件<input>,<select>和<textarea>上. 当用户编辑表单控件的时候, view model对应的属性值会自动更新.同样,当你更新view model属性的时候,相对应的元素值在页面上也会自动更新. 注:如果你在checkbox或者radio button上使用checked绑定

Knockout应用开发指南 第七章:Mapping插件

原文:Knockout应用开发指南 第七章:Mapping插件 Mapping插件 Knockout设计成允许你使用任何JavaScript对象作为view model.必须view model的一些属性是observable的,你可以使用KO绑定他们到你的UI元素上,当这些observable值改变的时候,这些UI元素就会自动更新. 绝大多数程序都需要从服务器端获取数据,但是由于服务器不知道observable的概念是什么,它只支持简单的JavaScript对象(通常是序列化以后的JSON),

Knockout应用开发指南 第三章:绑定语法(1)

原文:Knockout应用开发指南 第三章:绑定语法(1) 第三章所有代码都需要启用KO的ko.applyBindings(viewModel);功能,才能使代码生效,为了节约篇幅,所有例子均省略了此行代码. 1   visible 绑定 目的 visible绑定到DOM元素上,使得该元素的hidden或visible状态取决于绑定的值. 例子 <div data-bind="visible: shouldShowMessage"> You will see this me

Knockout应用开发指南 第三章:绑定语法(2)

原文:Knockout应用开发指南 第三章:绑定语法(2) 7   click 绑定 目的 click绑定在DOM元素上添加事件句柄以便元素被点击的时候执行定义的JavaScript 函数.大部分是用在button,input和连接a上,但是可以在任意元素上使用. 例子 <div> You've clicked <span data-bind="text: numberOfClicks"></span> times<button data-bi

Knockout应用开发指南 第六章:加载或保存JSON数据

原文:Knockout应用开发指南 第六章:加载或保存JSON数据 加载或保存JSON数据 Knockout可以实现很复杂的客户端交互,但是几乎所有的web应用程序都要和服务器端交换数据(至少为了本地存储需要序列化数据),交换数据最方便的就是使用JSON格式 – 大多数的Ajax应用程序也是使用这种格式.   加载或保存数据 Knockout不限制你用任何技术加载和保存数据.你可以使用任何技术和服务器来交互.用的最多的是使用jQuery的Ajax帮助,例如:getJSON,post和ajax.你

Knockout应用开发指南 第一章:入门

原文:Knockout应用开发指南 第一章:入门 1    Knockout简介 (Introduction) Knockout是一个轻量级的UI类库,通过应用MVVM模式使JavaScript前端UI简单化. Knockout有如下4大重要概念: 声明式绑定 (Declarative Bindings):使用简明易读的语法很容易地将模型(model)数据关联到DOM元素上. UI界面自动刷新 (Automatic UI Refresh):当您的模型状态(model state)改变时,您的UI

Knockout应用开发指南 第九章:高级应用举例

原文:Knockout应用开发指南 第九章:高级应用举例 1   Contacts editor 这个例子和微软为演示jQuery Data Linking Proposal例子提供的例子一样的提供的,我们可以看看Knockout实现是难了还是容易了. 代码量的多少不重要(尽快Knockout 的实现很简洁),重要的看起来是否容易理解且可读.查看HTML源代码,看看如何实现的view model以及绑定的.     代码: View View Code <h2>Contacts</h2&

Knockout应用开发指南 第二章:监控属性(Observables)

原文:Knockout应用开发指南 第二章:监控属性(Observables) 关于Knockout的3个重要概念(Observables,DependentObservables,ObservableArray),本人无法准确表达它的准确含义,所以暂定翻译为(监控属性.依赖监控属性和监控数组),如果有好的建议请指正,多谢. 1     创建带有监控属性的view model Observables Knockout是在下面三个核心功能是建立起来的: 监控属性(Observables)和依赖跟踪