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

建立自定义绑定

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

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

 

注册你的绑定app

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

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元素上使用了:ide

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

注:你实际上不必把init和update这两个callbacks都定义,你能够只定义其中的任意一个。函数

 

update 回调post

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

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

 

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

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
}
};



而后你能够像这样使用你的绑定:orm

<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>
相关文章
相关标签/搜索