knockout内置的绑定(像 click
,value
, 等)已经几乎就可以完成我们的所有功能,但是如果你需要封装更复杂的逻辑或行为,也可以创建一个自定义的绑定。在knockout里创建自定义绑定非常容易。
如何创建自定义绑定
ko.bindingHandlers.yourBindingName = { init: function(element, valueAccessor, allBindingsAccessor, viewModel) { // 初始化方法,由ko最初处理每个声明式绑定时执行 // 一般用于初始内部状态、绑定dom元素事件 }, update: function(element, valueAccessor, allBindingsAccessor, viewModel) { // 第一次调用是在执行完init()方法后,以后每当observable属性改变时调用 } };
创建(注册)名为"yourBindingName" 的绑定
如何使用自定义绑定
<div data-bind="yourBindingName: someValue"> </div>使用上与其他内置绑定(像
click
,value
, 等)一样,二者在本质上没有任何区别。
你实际上没必要把 init
和 update
这两个方法都定义,你可以只定义其中的任意一个。init方法用于完成初始化工作,其中最典型的就是给dom元素添加事件,以便监听dom元素的动态。以我们知道的内置value绑定为例,如果value绑定的属性是observable的,默认情况下value绑定会在init方法内给dom元素添加失去焦点事件(onblur),通过该事件监听value属性的变化,如果变化了ko会触发所有update方法,以保持同步。
注:ko不直接与dom元素打交道,而是通过绑定组件完成的,有绑定组件来监听dom元素的动态。可以说绑定组件是ko与dom元素的桥梁。
方法参数:
- element — 使用这个绑定的DOM元素
- valueAccessor —JavaScript函数,通过valueAccessor()可以得到应用到这个绑定的model上的当前属性值。
- allBindingsAccessor —JavaScript函数,通过allBindingsAccessor ()得到这个元素上所有model的属性值。
- viewModel — 传递给ko.applyBindings使用的 view model参数,如果是模板内部的话,那这个参数就是传递给该模板的数据。
update方法示例演示
例如,你可能想通过 visible绑定来控制一个元素的可见性,但是你想让该元素在隐藏或者显示的时候加入动画效果。那你可以自定义自己的绑定来调用jQuery的slideUp/slideDown 函数:
该示例需要引入jQuery库
Html代码
<div data-bind="slideVisible: giftWrap, slideDuration:600">You have selected the option</div> <label><input type="checkbox" data-bind="checked: giftWrap"/> Gift wrap</label>Js代码
<script type="text/javascript"> 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 } }; </script> <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在页面第一次显示的时候设置该元素的状态(但是不使用任何动画效果),而只是让动画在以后改变的时候再执行。你可以在上面示例的基础上在添加init方法:
Js代码
<script type="text/javascript"> 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) { // 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 } }; </script> <script type="text/javascript"> var viewModel = { giftWrap: ko.observable(true) }; ko.applyBindings(viewModel); </script>这就是说giftWrap的初始值声明的是false(例如giftWrap: ko.observable(false)),然后让初始值会让关联的DIV隐藏,之后用户点击checkbox的时候会让元素显示出来。
DOM事件之后更新observable值示例演示
你已经值得了如何使用update回调,当observable值改变的时候,你可以更新相关的DOM元素。但是其它形式的事件怎么做呢?比如当用户对某个DOM元素有某些action操作的时候,你想更新相关的observable值。
你可以使用init回调来注册一个事件句柄,这样可以改变相关的observable值,例如,
该示例需要引入jQuery库
Html代码
<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>Js代码
<script type="text/javascript"> 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(); } }; </script> <script type="text/javascript"> var viewModel = { editingName: ko.observable() }; ko.applyBindings(viewModel); </script>在init方法内为文本框添加了俩个事件:focus(获得焦点)、blur(失去焦点)。当文本框获得焦点时,将viewModel的editingName属性设为true,当文本框失去焦点时,将viewModel的editingName属性设为false。