Knockout.js 日本語ドキュメント

RequireJsを用いたAMD (非同期モジュール定義)

AMDの概要

Writing Modular JavaScript With AMD, CommonJs & ES Harmony からの抜粋:

一般的に「アプリケーションがモジュール形式である」という場合、アプリケーションが高度に分離されモジュールに格納された機能的に明確な部品によって構成されていることを言います。おそらくご存じのとおり、疎結合は可能な限り依存関係を除去することによって、アプリケーションの保守をより容易にします。これが効率的に実装されると、システムの一部への変更が他にどのように影響するのか確認することが非常に簡単になります。

しかしながら、いくつかのより伝統的なプログラミング言語とは異なり、JavaScript の現在のイテレーション(ECMA-262)はこのようなコードのモジュールをクリーンで組織的にインポートするための手段を開発者に提供していません。それは、より組織的なJavaScriptアプリケーションの必要性が明らかになったより近年に至るまで偉大な思想を必要としていない、仕様についての関心事の一つです。

代わりに現時点の開発者は、モジュールのバリエーションやオブジェクトリテラルのパターンによるフォールバックにとり残されています。 これらの多くでは、モジュールスクリプトは単一のグローバルオブジェクトとして定義された名前空間によって DOM 内に共存するため、あなたのアーキテクチャ内で名前の衝突を招く可能性があります。また、いくつかの手動作業やサードパーティのツールなしで依存関係の管理を処理するための、完全にクリーンな方法もありません。

これらの問題へのネイティブな解決策は ES Harmony によってもたらされるでしょうが、良いニュースとしてモジュール形式の JavaScript を書くことはかつてないほど簡単になっており、今からでも始めることができます。

Knockout.js と ViewModel クラスの RequireJS 経由での読み込み

HTML

<html>
    <head>
        <script type="text/javascript" data-main="scripts/init.js" src="scripts/require.js"></script>
    </head>
    <body>
        <p>First name: <input data-bind="value: firstName" /></p>
        <p>First name capitalized: <strong data-bind="text: firstNameCaps"></strong></p>
    </body>
</html>

scripts/init.js

require(['knockout-x.y.z', 'appViewModel', 'domReady!'], function(ko, appViewModel) {
    ko.applyBindings(new appViewModel());
});

scripts/appViewModel.js

// Main viewmodel class
define(['knockout-x.y.z'], function(ko) {
    return function appViewModel() {
        this.firstName = ko.observable('Bert');
        this.firstNameCaps = ko.pureComputed(function() {
            return this.firstName().toUpperCase();
        }, this);
    };
});

もちろん、x.y.zはあなたが読み込んでいるKnockoutスクリプト(例えば、Knockout-3.1.0)のバージョン番号に置き換えてください。

Knockout.js、バインディングハンドラ、ViewModel クラスの RequireJS 経由での読み込み

一般的なバインディングハンドラについてのドキュメントは、こちらを参照してください。このセクションでは、カスタムハンドラを保守する上で AMD モジュールが提供するパワーについて説明します。ここではバインディングハンドラのドキュメントからko.bindingHandlers.hasFocusを一例として取り上げます。このハンドラを自身のモジュールでラップすることにより、それを必要とするページでのみ使用されるよう制限することができます。ラップされたモジュールは次のようになります:

define(['knockout-x.y.z'], function(ko){
    ko.bindingHandlers.hasFocus = {
        init: function(element, valueAccessor) { ... },
        update: function(element, valueAccessor) { ... }
    }
});

モジュールを定義した後、上記の HTML の例から input 要素を修正します:

<p>
    First name: <input data-bind="value: firstName, hasFocus: editingName" />
    <span data-bind="visible: editingName"> You're editing the name!</span>
</p>

ViewModel を依存関係のリストをモジュールに含めます:

define(['knockout-x.y.z', 'customBindingHandlers/hasFocus'], function(ko) {
    return function appViewModel(){
        ...
        // Add an editingName observable
        this.editingName = ko.observable();
    };
});

カスタムバインディングハンドラモジュールはそれ自身は何も返しません。したがって 定義した ViewModel モジュールに何も注入せず、Knockout モジュールに追加の振る舞いを定義するだけにとどまります。

RequireJs のダウンロード

RequireJs は http://requirejs.org/docs/download.html からダウンロードできます。

原文はこちら

side menu