第五章：創(chuàng)建自定義綁定

創(chuàng)建自定義綁定

你可以創(chuàng)建自己的自定義綁定 – 沒有必要非要使用內嵌的綁定（像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函數(shù)，然后傳遞以下參數(shù)：

• element?— 使用這個綁定的DOM元素
• valueAccessor?—JavaScript函數(shù)，通過valueAccessor()可以得到應用到這個綁定的model上的當前屬性值。
• allBindingsAccessor?—JavaScript函數(shù)，通過allBindingsAccessor ()得到這個元素上所有model的屬性值。
• viewModel?— 傳遞給ko.applyBindings使用的 view model參數(shù)，如果是模板內部的話，那這個參數(shù)就是傳遞給該模板的數(shù)據(jù)。

例如，你可能想通過 visible綁定來控制一個元素的可見性，但是你想讓該元素在隱藏或者顯示的時候加入動畫效果。那你可以自定義自己的綁定來調用jQuery的slideUp/slideDown 函數(shù)：

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>

當然，看來可能代碼很多，但是一旦你創(chuàng)建了自定義綁定，你就可以在很多地方重用它。

init 回調

Knockout在DOM元素使用自定義綁定的時候會調用你的init函數(shù)。init有兩個重要的用途：

• 為DOM元素設置初始值
• 注冊事件句柄，例如當用戶點擊或者編輯DOM元素的時候，你可以改變相關的observable值的狀態(tài)。

?KO會傳遞和update回調函數(shù)一樣的參數(shù)。

繼續(xù)上面的例子，你可以像讓slideVisible在頁面第一次顯示的時候設置該元素的狀態(tài)（但是不使用任何動畫效果），而只是讓動畫在以后改變的時候再執(zhí)行。你可以這樣來做：

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)），然后讓初始值會讓關聯(lián)的DIV隱藏，之后用戶點擊checkbox的時候會讓元素顯示出來。

DOM事件之后更新observable值

你已經(jīng)值得了如何使用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();
    }
};

現(xiàn)在你可以通過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>