make dart quick start prettier, truthier
This commit is contained in:
parent
46a55185a3
commit
5c6e4ecd0c
|
@ -11,11 +11,11 @@ p.
|
||||||
|
|
||||||
p.
|
p.
|
||||||
In a new directory, create a <code>pubspec.yaml</code> file.
|
In a new directory, create a <code>pubspec.yaml</code> file.
|
||||||
Add angular2 and browser as dependencies,
|
Add angular2 and browser as dependencies:
|
||||||
and add the angular2 transformer:
|
|
||||||
[PENDING: if the transformer isn't working in time,
|
// [PENDING: if the transformer isn't working in time,
|
||||||
remove it and use reflection in Dartium instead.
|
// remove it and use reflection in Dartium instead.
|
||||||
Perhaps require Dart 1.9.]
|
// Perhaps require Dart 1.9.]
|
||||||
|
|
||||||
pre.prettyprint.linenums
|
pre.prettyprint.linenums
|
||||||
code.
|
code.
|
||||||
|
@ -24,14 +24,12 @@ p.
|
||||||
dependencies:
|
dependencies:
|
||||||
angular2: ">=2.0.0-alpha.6 <3.0.0"
|
angular2: ">=2.0.0-alpha.6 <3.0.0"
|
||||||
browser: any
|
browser: any
|
||||||
transformers:
|
|
||||||
- angular2
|
|
||||||
p.
|
p.
|
||||||
In the same directory, run <code>pub get</code>
|
In the same directory, run <code>pub get</code>
|
||||||
to install the angular2 and browser packages
|
to install the angular2 and browser packages
|
||||||
(along with the packages they depend on):
|
(along with the packages they depend on):
|
||||||
|
|
||||||
pre.prettyprint.linenums
|
pre.prettyprint
|
||||||
code.
|
code.
|
||||||
> pub get
|
> pub get
|
||||||
Resolving dependencies... (7.3s)
|
Resolving dependencies... (7.3s)
|
||||||
|
@ -41,23 +39,28 @@ p.
|
||||||
+ stack_trace 1.2.3
|
+ stack_trace 1.2.3
|
||||||
Changed 4 dependencies!
|
Changed 4 dependencies!
|
||||||
|
|
||||||
p.
|
// PENDING: Create template? Link to pub/pubspec docs?
|
||||||
PENDING: Create template? Link to pub/pubspec docs?
|
// Is browser really needed?
|
||||||
Is browser really needed?
|
// TODO: make this an invisible note.
|
||||||
TODO: make this an invisible note.
|
|
||||||
|
|
||||||
// STEP 2 - Import Angular ##########################
|
// STEP 2 - Import Angular ##########################
|
||||||
.l-main-section
|
.l-main-section
|
||||||
h2#section-transpile 2. Import Angular
|
h2#section-transpile 2. Import Angular
|
||||||
|
|
||||||
p.
|
p.
|
||||||
Under the same directory, create a <code>web</code> directory.
|
Still in the same directory, create a <code>web</code> directory.
|
||||||
Create a file under <code>web</code> named <code>main.dart</code>.
|
Create a file under <code>web</code> named <code>main.dart</code>.
|
||||||
Edit <code>web/main.dart</code> to import the angular2 library:
|
Edit <code>web/main.dart</code> to import the angular2 library
|
||||||
|
and (for now) two reflection libraries:
|
||||||
|
|
||||||
pre.prettyprint.linenums
|
pre.prettyprint.linenums
|
||||||
code import 'package:angular2/angular2.dart';
|
code.
|
||||||
|
import 'package:angular2/angular2.dart';
|
||||||
|
|
||||||
|
// These imports will go away soon:
|
||||||
|
import 'package:angular2/src/reflection/reflection.dart' show reflector;
|
||||||
|
import 'package:angular2/src/reflection/reflection_capabilities.dart' show ReflectionCapabilities;
|
||||||
|
|
||||||
// STEP 3 - Define a component ##########################
|
// STEP 3 - Define a component ##########################
|
||||||
.l-main-section
|
.l-main-section
|
||||||
|
@ -71,29 +74,31 @@ p.
|
||||||
with annotations that describe the component.
|
with annotations that describe the component.
|
||||||
|
|
||||||
p.
|
p.
|
||||||
Update <code>web/main.dart</code> to contain the following code,
|
Update <code>web/main.dart</code> to add the following code,
|
||||||
which defines the app component:
|
which defines the app component:
|
||||||
|
|
||||||
pre.prettyprint.linenums
|
pre.prettyprint.linenums
|
||||||
code.
|
code.
|
||||||
import 'package:angular2/angular2.dart';
|
|
||||||
|
|
||||||
@Component(
|
@Component(
|
||||||
selector: 'app'
|
selector: 'app'
|
||||||
)
|
)
|
||||||
@Template({
|
@Template(
|
||||||
inline: '<h1>Hello {{ name }}</h1>'
|
inline: '<h1>Hello {{ name }}</h1>'
|
||||||
})
|
)
|
||||||
class AppComponent {
|
class AppComponent {
|
||||||
String name = 'Alice';
|
String name = 'Alice';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TODO: Change or omit line numbers.
|
||||||
|
|
||||||
.l-sub-section
|
.l-sub-section
|
||||||
h3 Annotations
|
h3 Annotations
|
||||||
|
|
||||||
p.
|
p.
|
||||||
The <code>@Component</code> annotation defines the HTML tag for the component. [PENDING: component controller?]
|
The <code>@Component</code> annotation defines the HTML tag for the component.
|
||||||
The <code>selector</code> property specifies the tag. The <code>selector</code> property is a CSS selector. [PENDING: huh?]
|
The <code>selector</code> property specifies the tag. The <code>selector</code> property is a CSS selector.
|
||||||
|
|
||||||
|
// [PENDING: that last paragraph needs work!]
|
||||||
|
|
||||||
p.
|
p.
|
||||||
The <code>@Template</code> annotation defines the template to apply to the
|
The <code>@Template</code> annotation defines the template to apply to the
|
||||||
|
@ -104,17 +109,17 @@ p.
|
||||||
pre.prettyprint.linenums
|
pre.prettyprint.linenums
|
||||||
code.
|
code.
|
||||||
@Component(
|
@Component(
|
||||||
selector: 'app'
|
selector: 'app'
|
||||||
)
|
)
|
||||||
@Template({
|
@Template(
|
||||||
inline: '<h1>Hello {{ name }}</h1>'
|
inline: '<h1>Hello {{ name }}</h1>'
|
||||||
})
|
)
|
||||||
|
|
||||||
p.
|
p.
|
||||||
The annotations above specify an HTML tag of <code><app></app></code>
|
The annotations above specify an HTML tag of <code><app></app></code>
|
||||||
and a template of <code><h1>Hello {{ name }}</h1></code>.
|
and a template of <code><h1>Hello {{ name }}</h1></code>.
|
||||||
|
|
||||||
p TODO: make double-mustaches work in text (they do work in listings)
|
// TODO: In the preceding paragraph, that should be rendered as {{ name }}, like in the listing.
|
||||||
|
|
||||||
.l-sub-section
|
.l-sub-section
|
||||||
h3 The template and the component controller
|
h3 The template and the component controller
|
||||||
|
@ -122,10 +127,17 @@ p.
|
||||||
p.
|
p.
|
||||||
A template has access to all the public properties and methods
|
A template has access to all the public properties and methods
|
||||||
of its component controller.
|
of its component controller.
|
||||||
[PENDING: Do we really want to use the term "component controller"?
|
The template above binds to a <code>name</code> property through
|
||||||
If so, set it up beforehand.
|
the double-mustache syntax (<code>{{ }}</code>).
|
||||||
In the original text, what does "the backing" mean, and is it
|
The body of the constructor assigns "Alice" to the name property. When the
|
||||||
important that we keep it?]
|
template renders, Alice appears instead of <code>{{ name }}</code>.
|
||||||
|
|
||||||
|
// TODO: fix double mustaches above.
|
||||||
|
|
||||||
|
// [PENDING: Do we really want to use the term "component controller"?
|
||||||
|
// If so, set it up beforehand.
|
||||||
|
// In the original text, what does "the backing" mean, and is it
|
||||||
|
// important that we keep it?]
|
||||||
|
|
||||||
pre.prettyprint.linenums
|
pre.prettyprint.linenums
|
||||||
code.
|
code.
|
||||||
|
@ -133,14 +145,6 @@ p.
|
||||||
String name = 'Alice';
|
String name = 'Alice';
|
||||||
}
|
}
|
||||||
|
|
||||||
p.
|
|
||||||
The template above binds to a <code>name</code> property through the <code>{{ }}</code>
|
|
||||||
syntax.The body of the constructor assigns "Alice" to the name property. When the
|
|
||||||
template renders, Alice appears instead of <code>{{ name }}</code>.
|
|
||||||
[TODO: fix double mustaches]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// STEP 4 - Bootstrap ##########################
|
// STEP 4 - Bootstrap ##########################
|
||||||
.l-main-section
|
.l-main-section
|
||||||
h2#section-transpile 4. Bootstrap
|
h2#section-transpile 4. Bootstrap
|
||||||
|
@ -150,15 +154,22 @@ p.
|
||||||
add a <code>main()</code> function
|
add a <code>main()</code> function
|
||||||
that calls Angular's <code>bootstrap()</code> function.
|
that calls Angular's <code>bootstrap()</code> function.
|
||||||
The argument to <code>bootstrap()</code> is the name of the app class
|
The argument to <code>bootstrap()</code> is the name of the app class
|
||||||
you defined above:
|
you defined above.
|
||||||
|
|
||||||
|
p.
|
||||||
|
For now, you also need to set the value of
|
||||||
|
<code>reflector.reflectionCapabilities</code>.
|
||||||
|
|
||||||
pre.prettyprint.linenums
|
pre.prettyprint.linenums
|
||||||
code.
|
code.
|
||||||
main() {
|
main() {
|
||||||
|
// Temporarily needed.
|
||||||
|
reflector.reflectionCapabilities = new ReflectionCapabilities();
|
||||||
|
|
||||||
bootstrap(AppComponent);
|
bootstrap(AppComponent);
|
||||||
}
|
}
|
||||||
p.
|
|
||||||
[PENDING: change/remove line numbers. They should start at 12.]
|
// [PENDING: change/remove line numbers. They should start at 12.]
|
||||||
|
|
||||||
// STEP 5 - Declare the HTML ##########################
|
// STEP 5 - Declare the HTML ##########################
|
||||||
.l-main-section
|
.l-main-section
|
||||||
|
@ -179,33 +190,36 @@ p.
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<app></app>
|
<app></app>
|
||||||
|
|
||||||
<script type="application/dart" src="main.dart"></script>
|
<script type="application/dart" src="main.dart"></script>
|
||||||
<script src="packages/browser/dart.js"></script>
|
<script src="packages/browser/dart.js"></script>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
p.
|
|
||||||
[PENDING: When I select a bunch of code, it looks like I select the line #s too, making me fear that they'll get copied. But pasting doesn't include them. Fix!]
|
|
||||||
|
|
||||||
// STEP 5 - Build and run ##########################
|
// [PENDING: When I select a bunch of code, it looks like I select the line #s too, making me fear that they'll get copied. But pasting doesn't include them. Can we fix that?]
|
||||||
|
|
||||||
|
// STEP 6 - Build and run ##########################
|
||||||
.l-main-section
|
.l-main-section
|
||||||
|
|
||||||
h2#section-angular-run-app 5. Build and run your app
|
h2#section-angular-run-app 6. Build and run your app
|
||||||
|
|
||||||
p.
|
p.
|
||||||
You have many options.
|
You have several options for running your app.
|
||||||
One is to run the <code>pub serve</code>
|
The quickest and easiest, for now,
|
||||||
command in the directory
|
is to open your project in <b>Dart Editor</b>,
|
||||||
that contains your app's <code>pubspec.yaml</code> file:
|
right-click <code>web/index.html</code>,
|
||||||
|
and choose <b>Open in Dartium</b>.
|
||||||
|
|
||||||
pre.prettyprint.linenums
|
// TODO: screenshot?
|
||||||
code.
|
|
||||||
> pub serve
|
|
||||||
Serving helloworld on http://localhost:8080
|
|
||||||
|
|
||||||
p.
|
p.
|
||||||
In the browser, go to the index file—for example,
|
Another option is to build and serve the app using <code>pub serve</code>,
|
||||||
localhost:8080/web/index.html.
|
and then to run it by visiting http://localhost:8080/index.html in a browser.
|
||||||
[PENDING: This isn't working right now. Fix!]
|
The JavaScript generated using this option is large, for now;
|
||||||
|
it'll be much better soon, when a transformer becomes available
|
||||||
|
to convert the reflection code from dynamic to static code.
|
||||||
|
|
||||||
|
// [PENDING: Update when transformer is working!]
|
||||||
|
|
||||||
// WHAT'S NEXT... ##########################
|
// WHAT'S NEXT... ##########################
|
||||||
.l-main-section
|
.l-main-section
|
||||||
|
@ -213,4 +227,5 @@ p.
|
||||||
|
|
||||||
p.
|
p.
|
||||||
Learn some template syntax for extra credit.
|
Learn some template syntax for extra credit.
|
||||||
[PENDING: really?]
|
|
||||||
|
// [PENDING: really?]
|
||||||
|
|
Loading…
Reference in New Issue