Knockout应用开发指南 第三章：绑定语法（3）

12   value 绑定

目的

value绑定是关联DOM元素的值到view model的属性上。主要是用在表单控件<input>，<select>和<textarea>上。

当用户编辑表单控件的时候， view model对应的属性值会自动更新。一样，当你更新view model属性的时候，相对应的元素值在页面上也会自动更新。

注：若是你在checkbox或者radio button上使用checked绑定来读取或者写入元素的 checked状态，而不是value 值的绑定。

 

例子

<p>Login name: <input data-bind="value: userName"/></p>
<p>Password: <input type="password" data-bind="value: userPassword"/></p>
 

<script type="text/javascript">
    var viewModel = {
        userName: ko.observable(""),        // Initially blank
        userPassword: ko.observable("abc"), // Prepopulate
    };
</script>

 

参数

    主参数

    KO设置此参数为元素的value值。以前的值将被覆盖。

    若是参数是监控属性observable的，那元素的value值将根据参数值的变化而更新，若是不是，那元素的value值将只设置一次而且之后不在更新。

    若是你提供的参数不是一个数字或者字符串（而是对象或者数组）的话，那显示的value值就是yourParameter.toString() 的内容（一般没用，因此最好都设置为数字或者字符串）。

    无论何时，只要你更新了元素的值，那 KO都会将view model对应的属性值自动更新。默认状况下当用户离开焦点（例如onchange事件）的时候，KO才更新这个值，可是你能够经过第2个参数valueUpdate来特别指定改变值的时机。

 

    其它参数

        valueUpdate

        若是你使用valueUpdate参数，那就是意味着KO将使用自定义的事件而不是默认的离开焦点事件。下面是一些最经常使用的选项：

            “change”（默认值） - 当失去焦点的时候更新view model的值，或者是<select> 元素被选择的时候。

            “keyup” – 当用户敲完一个字符之后当即更新view model。

            “keypress” – 当用户正在敲一个字符但没有释放键盘的时候就当即更新view model。不像 keyup，这个更新和keydown是同样的。

            “afterkeydown” – 当用户开始输入字符的时候就更新view model。主要是捕获浏览器的keydown事件或异步handle事件。

        上述这些选项，若是你想让你的view model进行实时更新，使用“afterkeydown”是最好的选择。

 

例子：

<p>Your value: <input data-bind="value: someValue, valueUpdate: 'afterkeydown'"/></p>
<p>You have typed: <span data-bind="text: someValue"></span></p> <!-- updates in real-time --> 

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

 

注1：绑定下拉菜单drop-down list（例如SELECT）

Knockout对下拉菜单drop-down list绑定有一个特殊的支持，那就是在读取和写入绑定的时候，这个值能够是任意JavaScript对象，而没必要非得是字符串。在你让你用户选择一组model对象的时候很是有用。具体例子，参考options绑定。

相似，若是你想建立一个multi-select list，参考selectedOptions绑定。

 

注2：更新observable和non-observable属性值

若是你用value绑定将你的表单元素和你的observable属性关联起来，KO设置的2-way的双向绑定，任何一方改变都会更新另一方的值。

可是，若是你的元素绑定的是一个non-observable属性（例如是一个原始的字符串或者JavaScript表达式） ,KO会这样执行：

• 若是你绑定的non-observable属性是简单对象，例如一个常见的属性值，KO会设置这个值为form表单元素的初始值，若是你改变form表单元素的值，KO会将值从新写回到view mode的这个属性。但当这个属性本身改变的时候，元素却不会再变化了（由于不是observable的），因此它仅仅是1-way绑定。
• 若是你绑定的non-observable属性是复杂对象，例如复杂的JavaScript 表达式或者子属性，KO也会设置这个值为form表单元素的初始值，可是改变form表单元素的值的时候，KO不会再写会view model属性，这种状况叫one-time-only value setter，不是真正的绑定。

 

例子：

<p>First value: <input data-bind="value: firstValue"/></p>          <!-- two-way binding -->
<p>Second value: <input data-bind="value: secondValue"/></p>        <!-- one-way binding -->
<p>Third value: <input data-bind="value: secondValue.length"/></p>  <!-- no binding --> 

<script type="text/javascript">
    var viewModel = {
        firstValue: ko.observable("hello"), // Observable
        secondValue: "hello, again"// Not observable
    };
    ko.applyBindings(viewModel);
</script>

 

依赖性

除KO核心类库外，无依赖。

 

13   checked 绑定

目的

checked绑定是关联到checkable的form表单控件到view model上 - 例如checkbox（<input type='checkbox'>）或者radio button（<input type='radio'>） 。当用户check关联的form表单控件的时候，view model对应的值也会自动更新，相反，若是view model的值改变了，那控件元素的check/uncheck状态也会跟着改变。

注：对text box，drop-down list和全部non-checkable的form表单控件，用value绑定来读取和写入是该元素的值，而不是checked绑定。

例子

<p>Send me spam: <input type="checkbox" data-bind="checked: wantsSpam"/></p> 

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

     // ... then later ...
    viewModel.wantsSpam(false); // The checkbox becomes unchecked
</script>

 

Checkbox关联到数组

<p>Send me spam: <input type="checkbox" data-bind="checked: wantsSpam"/></p>
<div data-bind="visible: wantsSpam">
    Preferred flavors of spam:
    <div><input type="checkbox" value="cherry" data-bind="checked: spamFlavors"/> Cherry</div>
    <div><input type="checkbox" value="almond" data-bind="checked: spamFlavors"/> Almond</div>
    <div><input type="checkbox" value="msg" data-bind="checked: spamFlavors"/> Monosodium Glutamate</div>
</div>

 
<script type="text/javascript">

    var viewModel = {
        wantsSpam: ko.observable(true),
        spamFlavors: ko.observableArray(["cherry", "almond"]) // Initially checks the Cherry and Almond checkboxes
    };

    // ... then later ...
    viewModel.spamFlavors.push("msg"); // Now additionally checks the Monosodium Glutamate checkbox
</script>

 

添加radio button

<p>Send me spam: <input type="checkbox" data-bind="checked: wantsSpam"/></p>

<div data-bind="visible: wantsSpam">
    Preferred flavor of spam:
    <div><input type="radio" name="flavorGroup" value="cherry" data-bind="checked: spamFlavor"/> Cherry</div>
    <div><input type="radio" name="flavorGroup" value="almond" data-bind="checked: spamFlavor"/> Almond</div>
    <div><input type="radio" name="flavorGroup" value="msg" data-bind="checked: spamFlavor"/> Monosodium Glutamate</div>
</div>

 
<script type="text/javascript">

    var viewModel = {
        wantsSpam: ko.observable(true),
        spamFlavor: ko.observable("almond") // Initially selects only the Almond radio button
    };

     // ... then later ...
    viewModel.spamFlavor("msg"); // Now only Monosodium Glutamate is checked
</script>

参数

    主参数

    KO会设置元素的checked状态匹配到你的参数上，以前的值将被覆盖。对参数的解析取决于你元素的类型：

        对于checkbox，当参数为true的时候，KO会设置元素的状态为checked，反正设置为unchecked。若是你传的参数不是布尔值，那KO将会解析成布尔值。也就是说非0值和非null对象，非空字符串将被解析成true，其它值都被解析成false。

        当用户check或者uncheck这个checkbox的时候，KO会将view model的属性值相应地设置为true或者false。

        一个特殊状况是参数是一个数组，若是元素的值存在于数组，KO就会将元素设置为checked，若是数组里不存在，就设置为unchecked。若是用户对checkbox进行check或uncheck，KO就会将元素的值添加数组或者从数组里删除。

        对于radio buttons，KO只有当参数值等于radio button value属性值的时候才设置元素为checked状态。因此参数应是字符串。在上面的例子里只有当view model 的spamFlavor 属性等于“almond”的时候，该radio button才会设置为checked。

        当用户将一个radio button选择上的时候 is selected，KO会将该元素的value属性值更新到view model属性里。上面的例子，当点击value= “cherry”的选项上， viewModel.spamFlavor的值将被设置为“cherry”。

        固然，最有用的是设置一组radio button元素对应到一个单个的view model 属性。确保一次只能选择一个radio button须要将他们的name属性名都设置成同样的值（例如上个例子的flavorGroup值）。这样的话，一次就只能选择一个了。

    若是参数是监控属性observable的，那元素的checked状态将根据参数值的变化而更新，若是不是，那元素的value值将只设置一次而且之后不在更新。

    其它参数

    无

 

依赖性

除KO核心类库外，无依赖。

 

14   options 绑定

目的

options绑定控制什么样的options在drop-down列表里（例如：<select>）或者 multi-select 列表里 （例如：<select size='6'>）显示。此绑定不能用于<select>以外的元素。关联的数据应是数组（或者是observable数组），<select>会遍历显示数组里的全部的项。

 

注：对于multi-select列表，设置或者获取选择的多项须要使用selectedOptions绑定。对于single-select列表，你也可使用value绑定读取或者设置元素的selected项。

 

例1：Drop-down list

<p>Destination country: <select data-bind="options: availableCountries"></select></p>

 
<script type="text/javascript">
    var viewModel = {
        availableCountries: ko.observableArray(['France', 'Germany', 'Spain']) // These are the initial options
    };

    // ... then later ...
    viewModel.availableCountries.push('China'); // Adds another option
</script>

 

例2：Multi-select list

<p>Choose some countries you'd like to visit: <select data-bind="options: availableCountries" size="5" multiple="true"></select></p>
 
<script type="text/javascript">
    var viewModel = {
        availableCountries: ko.observableArray(['France', 'Germany', 'Spain'])
    };
</script>

 

例3：Drop-down list展现的任意JavaScript对象，不只仅是字符串

<p>
    Your country:
    <select data-bind="options: availableCountries, 
　　　　　　　　　　　　　　optionsText: 'countryName', value: selectedCountry, optionsCaption: 'Choose...'"></select>
</p>

<div data-bind="visible: selectedCountry"> <!-- Appears when you select something -->
    You have chosen a country with population
    <span data-bind="text: selectedCountry() ? selectedCountry().countryPopulation : 'unknown'"></span>.
</div>

<script type="text/javascript">
    // Constructor for an object with two properties
var country =function (name, population) {
        this.countryName = name;
        this.countryPopulation = population;
    };

     var viewModel = {
        availableCountries: ko.observableArray([
            new country("UK", 65000000),
            new country("USA", 320000000),
            new country("Sweden", 29000000)
        ]),
        selectedCountry: ko.observable() // Nothing selected by default
    };
</script>

 

例4：Drop-down list展现的任意JavaScript对象，显示text是function的返回值

<!-- Same as example 3, except the <select> box expressed as follows: -->

<select data-bind="options: availableCountries,
                   optionsText: function(item) {
                       return item.countryName + ' (pop: ' + item.countryPopulation + ')'
                   },
                   value: selectedCountry,
                   optionsCaption: 'Choose...'"></select>

 

注意例3和例4在optionsText值定义上的不一样。

 

参数

    主参数

    该参数是一个数组（或者observable数组）。对每一个item，KO都会将它做为一个<option> 添加到<select>里，以前的options都将被删除。

    若是参数是一个string数组，那你不须要再声明任何其它参数。<select>元素会将每一个string显示为一个option。不过，若是你让用户选择的是一个JavaScript对象数组（不只仅是string），那就须要设置optionsText和optionsValue这两个参数了。

    若是参数是监控属性observable的，那元素的options项将根据参数值的变化而更新，若是不是，那元素的value值将只设置一次而且之后不在更新。

 

    其它参数

        optionsCaption

        有时候，默认状况下不想选择任何option项。可是single-select drop-down列表因为每次都要默认选择以项目，怎么避免这个问题呢？经常使用的方案是加一个“请选择的”或者“Select an item”的提示语，或者其它相似的，而后让这个项做为默认选项。

        咱们使用optionsCaption参数就能很容易实现，它的值是字符串型，做为默认项显示。例如：

        <select data-bind='options: myOptions, optionsCaption: "Select an item...", value: myChosenValue'></select>

        KO会在全部选项上加上这一个项，而且设置value值为undefined。因此，若是myChosenValue被设置为undefined（默认是observable的），那么上述的第一个项就会被选中。

 

        optionsText

        上面的例3展现的绑定JavaScript对象到option上 – 不只仅是字符串。这时候你须要设置这个对象的那个属性做为drop-down列表或multi-select列表的text来显示。例如，例3中使用的是设置额外的参数optionsText将对象的属性名countryName做为显示的文本。

        若是不想仅仅显示对象的属性值做为每一个item项的text值，那你能够设置optionsText 为JavaScript 函数，而后再函数里经过本身的逻辑返回相应的值（该函数参数为item项自己）。例4展现的就是返回item的2个属性值合并的结果。

 

        optionsValue

        和optionsText相似, 你也能够经过额外参数optionsValue来声明对象的那个属性值做为该<option>的value值。

        经典场景：如在更新options的时候想保留原来的已经选择的项。例如，当你重复屡次调用Ajax获取car列表的时候，你要确保已经选择的某个car一直都是被选择上，那你就须要设置optionsValue为“carId”或者其它的unique标示符，不然的话KO找不知道以前选择的car是新options里的哪一项。

 

        selectedOptions

        对于multi-select列表，你能够用selectedOptions读取和设置多个选择项。技术上看它是一个单独的绑定，有本身的文档，请参考： selectedOptions绑定。

 

注：已经被选择的项会再options改变的时候保留

当使用options绑定<select>元素的时候，若是options改变，KO将尽量第保留以前已经被选择的项不变（除非是你事先手工删除一个或多个已经选择的项）。这是由于options 绑定尝试依赖value值的绑定（single-select列表）和selectedOptions绑定（multi-select列表）。

 

依赖性

除KO核心类库外，无依赖。

 

15   selectedOptions 绑定

目的

selectedOptions绑定用于控制multi-select列表已经被选择的元素，用在使用options绑定的<select>元素上。

当用户在multi-select列表选择或反选一个项的时候，会将view model的数组进行相应的添加或者删除。一样，若是view model上的这个数组是observable数组的话，你添加或者删除任何item（经过push或者splice）的时候，相应的UI界面里的option项也会被选择上或者反选。这种方式是2-way绑定。

注：控制single-select下拉菜单选择项，你可使用value绑定。

 

例子

<p>
    Choose some countries you'd like to visit:
    <select data-bind="options: availableCountries, selectedOptions: chosenCountries" size="5" multiple="true"></select>
</p>

<script type="text/javascript">
    var viewModel = {
        availableCountries: ko.observableArray(['France', 'Germany', 'Spain']),
        chosenCountries: ko.observableArray(['Germany']) // Initially, only Germany is selected
    }; 

    // ... then later ...
    viewModel.chosenCountries.push('France'); // Now France is selected too
</script>

 

参数

    主参数

    该参数是数组（或observable数组）。KO设置元素的已选项为和数组里match的项，以前的已选择项将被覆盖。

    若是参数是依赖监控属性observable数组，那元素的已选择项selected options项将根据参数值的变化（经过push，pop，或其它observable数组方法）而更新，若是不是，那元素的已选择项selected options将只设置一次而且之后不在更新。

    无论该参数是否是observable数组，用户在multi-select列表里选择或者反选的时候，KO都会探测到，而且更新数组里的对象以达到同步的结果。这样你就能够获取options已选项。

    其它参数

           无

 

注：支持让用户选择任意JavaScript对象

在上面的例子里，用户能够选择数组里的字符串值，可是选择不限于字符串，若是你愿意你能够声明包含任意JavaScript对象的数组，查看options绑定如何显示JavaScript对象到列表里。

这种场景，你能够用selectedOptions来读取或设置这些对象自己，而不是页面上显示的option表示形式，这样作在大部分状况下都很是清晰。view model就能够探测到你从数组对象里选择的项了，而没必要关注每一个项和页面上展现的option项是如何map的。

 

依赖性

除KO核心类库外，无依赖。

 

16   uniqueName 绑定

目的

uniqueName绑定确保所绑定的元素有一个非空的name属性。若是该元素没有name属性，那绑定会给它设置一个unique的字符串值做为name属性。你不会常常用到它，只有在某些特殊的场景下才用到，例如：

• 在使用KO的时候，一些技术可能依赖于某些元素的name属性，尽快他们没有什么意义。例如，jQuery Validation验证当前只验证有name属性的元素。为配合Knockout UI使用，有些时候须要使用uniqueName绑定避免让jQuery Validation验证出错。

• IE 6下，若是radio button没有name属性是不容许被checked了。大部分时候都没问题，由于大部分时候radio button元素都会有name属性的做为一组互相的group。不过，若是你没声明，KO内部会在这些元素上使用uniqueName那么以确保他们能够被checked。

 

例子

<input data-bind="value: someModelProperty, uniqueName: true"/>

 

参数

    主参数

    就像上面的例子同样，传入true（或者能够转成true的值）以启用uniqueName绑定。

    其它参数

        无

 

依赖性

除KO核心类库外，无依赖。