/
getting_started_dependent_library_basics.html
214 lines (198 loc) · 11.7 KB
/
getting_started_dependent_library_basics.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Getting Started: Dependent Library Basics</title>
<link rel="stylesheet" href="./vendor/css/normalize.css">
<link rel="stylesheet" href="./vendor/bootstrap/css/bootstrap.min.css">
<link rel="stylesheet" href="./vendor/bootstrap/css/bootstrap-responsive.min.css">
<link rel="stylesheet" href="./vendor/google-code-prettify/prettify.css">
<link rel="stylesheet" href="./css/layout.css">
<link rel="stylesheet" href="./css/layout_components.css">
<link rel="icon" type="image/x-icon" href="./img/favicon.ico">
<script type="application/javascript" src="./vendor/js/jquery-1.9.1.js"></script>
<link rel="stylesheet" href="css/tutorial.css">
<script type="application/javascript" src="vendor/globalize/globalize.js"></script>
<script type="application/javascript" src="vendor/globalize/globalize.culture.en-GB.js"></script>
<script type="application/javascript" src="vendor/globalize/globalize.culture.fr-FR.js"></script>
<script type="application/javascript" src="vendor/js/knockback-full-stack-1.0.0.js"></script>
<script type="application/javascript" src="./vendor/bootstrap/js/bootstrap.min.js"></script>
<script type="application/javascript" src="./vendor/google-code-prettify/prettify.js"></script>
<script type="application/javascript" src="./js/stylecode.js"></script>
<script type="application/javascript" src="./js/interface.js"></script>
</head>
<body>
<div class="page navbar">
<div class="navbar navbar-inverse navbar-fixed-top">
<div class="navbar-inner">
<div class="container"><a data-toggle="collapse" data-target=".nav-collapse" class="btn btn-navbar"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a href="https://github.com/kmalakoff/knockback" class="brand kb">Knockback.js</a>
<div class="nav-collapse">
<ul class="nav">
<li><a href="index.html">Home</a></li>
<li><a href="doc/index.html">API</a></li>
<li class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle">Getting Started<b class="caret"></b></a>
<ul role="menu" class="dropdown-menu">
<li><a href="getting_started_introduction.html">Overview</a><a href="getting_started_dependent_library_basics.html">Dependent Library Basics</a><a href="getting_started_knockback_basics.html">Knockback Basics</a><a href="getting_started_views_view_models_models.html">Models, Views, and ViewModels</a><a href="getting_started_memory_lifecycle_management.html">Memory and Lifecycle Management</a><a href="getting_started_knockback_important_details.html">Knockback Important Details</a>
</li>
</ul>
</li>
<li class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle">Components<b class="caret"></b></a>
<ul role="menu" class="dropdown-menu">
<li><a href="components_backbone_relational.html">Backbone Relational</a><a href="components_backbone_modelref.html">Backbone ModelRef</a><a href="components_knockback_inspector.html">Knockback Inspector</a><a href="components_knockback_navigators.html">Knockback Navigators</a>
</li>
</ul>
</li>
<li class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle">Applications<b class="caret"></b></a>
<ul role="menu" class="dropdown-menu">
<li><a href="app_knockback_reference.html">Knockback Reference App</a><a href="app_todos.html">Todos App</a>
</li>
</ul>
</li>
<li class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle">Tutorials<b class="caret"></b></a>
<ul role="menu" class="dropdown-menu">
<li><a href="tutorials_introduction.html">Introduction</a><a href="tutorial_kb_observable.html">kb.Observable</a><a href="tutorial_kb_view_model.html">kb.ViewModel</a><a href="tutorial_kb_collection_observable.html">kb.CollectionObservable</a><a href="tutorial_nested_models.html">Nested Models</a><a href="tutorial_relational_models.html">Relational Models</a><a href="tutorial_kb_localized_observable.html">kb.LocalizedObservable</a><a href="tutorial_locale_manager.html">Custom Locale Manager</a><a href="tutorial_inject.html">ViewModel Injection</a><a href="tutorial_knockback_inspector.html">Knockback Inspector (Advanced)</a>
</li>
</ul>
</li>
<li><a href="https://github.com/kmalakoff/knockback/blob/master/RELEASE_NOTES.md">Release Notes</a></li>
</ul>
<div id="script_language">
<div class="separator">
<div class="selection codestyle">
<div class="option">
<input id="cs-cs" type="radio" name="codestyle" value="cs" class="auto"/>
<label for="cs-cs">CS</label>
</div>
<div class="option">
<input id="cs-js" type="radio" name="codestyle" value="js"/>
<label for="cs-js">JS</label>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="container">
<header class="page">
</header>
<content class="page">
<section>
<h1>Getting Started with Knockback.js: Dependent Library Basics</h1>
<p></p>
<h2>Backbone.js</h2>
<p><span>Backbone is an amazing</span><a href="http://en.wikipedia.org/wiki/Model_view_controller"> Model_View_Controller (MVC)</a><span>-</span><a href="http://documentcloud.github.com/backbone/#FAQ-mvc">inspired</a><span> library that handles data (Model/Collection) synchronization with a RESTful server for</span><a href="http://en.wikipedia.org/wiki/Object-relational_mapping "> Object_Relational_Mapping (ORM)</a><span>, page routing, etc. Unfortunately, their Views become complex to maintain when dynamic Model and View synchronization is required (which is why Knockback exists).</span></p>
<div>These are the basic Model components from Backbone used by Knockback:</div>
<pre data-for="cs">// Model
earth = new Backbone.Model({first_name: 'Planet', last_name: 'Earth'})
mars = new Backbone.Model({first_name: 'Planet', last_name: 'Mars'})
// Collection
planets = new Backbone.Collection([earth, mars])
</pre>
<pre data-for="js">// Model
var earth = new Backbone.Model({first_name: 'Planet', last_name: 'Earth'});
var mars = new Backbone.Model({first_name: 'Planet', last_name: 'Mars'});
// Collection
var planets = new Backbone.Collection([earth, mars]);
</pre>
<div>This is a Backbone router that can be used by your app:</div>
<p>Router:</p>
<pre data-for="cs">class PageRouter extends Backbone.Router
routes:
"earth": "switchToEarth" // #earth
"mars": "switchToMars" // #mars
switchToEarth: -> # do something
switchToMars: -> # do something
# instantiate the router and start listening for URL changes
page_router = new PageRouter()
Backbone.history.start()
</pre>
<pre data-for="js">var PageRouter = Backbone.Router.extend({
routes: {
"earth": "switchToEarth", // #earth
"mars": "switchToMars" // #mars
},
switchToEarth: function() { /* do something */ },
switchToMars: function() { /* do something */ }
});
// instantiate the router and start listening for URL changes
var page_router = new PageRouter()
Backbone.history.start()
</pre>
<h2>Knockout.js</h2>
<p><span>Knockout follows the</span><a href="http://en.wikipedia.org/wiki/Model_View_ViewModel"> Model_View_ViewModel (MVVM)</a><span> design pattern meaning you specify a ViewModel (Controller) in addition to your data (Model) which encapsulates specific data and logic for your HTML/Template (View).</span></p>
<div class="row-fluid">
<div class="span8">
<ul class="nav nav-tabs">
<li class="active"><a href="#ko_basic_view" data-toggle="tab">View (HTML)</a></li>
<li><a href="#ko_basic_view_model" data-toggle="tab">ViewModel (CS/JS)</a></li>
</ul>
<div class="tab-content">
<div id="ko_basic_view" class="tab-pane active">
<pre><div id='ko_basic'>
<p>First name: <input class='input-small pull-right' data-bind="value: first_name, valueUpdate: 'keyup'" /></p>
<p>Last name: <input class='input-small pull-right' data-bind="value: last_name, valueUpdate: 'keyup'" /></p>
<p>Hello, <span data-bind="text: full_name"> </span>!</p>
</div>
</pre>
</div>
<div id="ko_basic_view_model" class="tab-pane">
<pre data-for="cs">model = {first_name: "Planet", last_name: "Earth"}
ViewModel = (model) ->
@first_name = ko.observable(model.first_name)
@last_name = ko.observable(model.last_name)
@full_name = ko.computed((->return "#{@first_name()} #{@last_name()}"), @)
return
view_model = new ViewModel(model)
ko.applyBindings(view_model, $('#ko_basic')[0])</pre>
<pre data-for="js">var model = {first_name: "Planet", last_name: "Earth"};
var ViewModel = function(model) {
this.first_name = ko.observable(model.first_name);
this.last_name = ko.observable(model.last_name);
this.full_name = ko.computed((function() {return "" + (this.first_name()) + " " + (this.last_name());}), this);
};
var view_model = new ViewModel(model);
ko.applyBindings(view_model, $('#ko_basic')[0]);</pre>
</div>
</div>
</div>
<div class="span4">
<h4>Live Result</h4>
<div class="demos_result_box"><div id='ko_basic'>
<p>First name: <input class='input-small pull-right' data-bind="value: first_name, valueUpdate: 'keyup'" /></p>
<p>Last name: <input class='input-small pull-right' data-bind="value: last_name, valueUpdate: 'keyup'" /></p>
<p>Hello, <span data-bind="text: full_name"> </span>!</p>
</div>
<script type="application/javascript" src="getting_started/dependent_library_basics/ko_basic.js"></script>
</div>
</div>
</div>
<h4>Knockout.js ViewModel Injectionstances</h4>
<p>In Knockout.js, ViewModels need to be unique instances so often you use a simple function with 'new' to create an instance to bind. Here are some equivalents:</p>
<pre data-for="cs"># Form 1: Simple function-based class
ViewModel = (model) ->
@first_name = ko.observable(model.first_name)
return
view_model = new ViewModel({first_name: "Hello"})
# Form 2: CoffeeScript class (allows for inheritance)
class ViewModel
constructor: (model) ->
@first_name = ko.observable(model.first_name)
view_model = new ViewModel({first_name: "Hello"})
</pre>
<pre data-for="js">// Simple function-based class
var ViewModel = function(model) {
this.first_name = ko.observable(model.first_name);
};
var view_model = new ViewModel({first_name: "Hello"});</pre>
</section>
</content>
<footer class="page">
</footer>
</div>
</body>
</html>