Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit 693f1db

Browse files
committed
docs(toh-5): edits after doing tutorial
- Some adjustments following actually doing the tutorial. In some cases code shown (e.g. this is what file foo should look like now) didn't match what the user would have. E.g., lingering @input on the hero property. - Fixed some lingering deprecated-router prose elements on TS side (e.g., still referring to a route by the old string names like `HeroDetail`). - Added extra step to `app.component.ts` creation rather than having a critical-call-out later on. - Reorder some prose for better harmony between TS and Dart prose (also improves the flow). - Moved the `styleUrls` call-out to the point of first use.
1 parent 3a72333 commit 693f1db

23 files changed

+578
-613
lines changed
Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,51 @@
11
// #docplaster
22
// #docregion
33
import 'package:angular2/core.dart';
4+
// #docregion import-router
45
import 'package:angular2/router.dart';
6+
// #enddocregion import-router
57

6-
import 'package:angular2_tour_of_heroes/heroes_component.dart';
7-
import 'package:angular2_tour_of_heroes/hero_service.dart';
8-
import 'package:angular2_tour_of_heroes/dashboard_component.dart';
9-
// #docregion hero-detail-import
10-
import 'package:angular2_tour_of_heroes/hero_detail_component.dart';
11-
// #enddocregion hero-detail-import
8+
import 'dashboard_component.dart';
9+
import 'hero_detail_component.dart';
10+
import 'hero_service.dart';
11+
import 'heroes_component.dart';
1212

1313
@Component(
1414
selector: 'my-app',
15-
// #docregion template
15+
// #docregion template, template-v3
1616
template: '''
1717
<h1>{{title}}</h1>
1818
<nav>
1919
<a [routerLink]="['Dashboard']">Dashboard</a>
2020
<a [routerLink]="['Heroes']">Heroes</a>
2121
</nav>
2222
<router-outlet></router-outlet>''',
23-
// #enddocregion template
23+
// #enddocregion template, template-v3
2424
// #docregion styleUrls
2525
styleUrls: const ['app_component.css'],
2626
// #enddocregion styleUrls
27+
// #docregion directives-and-providers
2728
directives: const [ROUTER_DIRECTIVES],
2829
providers: const [HeroService, ROUTER_PROVIDERS])
30+
// #enddocregion directives-and-providers
31+
// #docregion heroes
2932
@RouteConfig(const [
30-
// #docregion dashboard-route
33+
// #enddocregion heroes
34+
// #docregion dashboard
3135
const Route(
3236
path: '/dashboard',
3337
name: 'Dashboard',
3438
component: DashboardComponent,
3539
useAsDefault: true),
36-
// #enddocregion dashboard-route
37-
// #docregion hero-detail-route
40+
// #enddocregion dashboard
41+
// #docregion hero-detail
3842
const Route(
3943
path: '/detail/:id', name: 'HeroDetail', component: HeroDetailComponent),
40-
// #enddocregion hero-detail-route
44+
// #enddocregion hero-detail
45+
// #docregion heroes
4146
const Route(path: '/heroes', name: 'Heroes', component: HeroesComponent)
4247
])
48+
// #enddocregion heroes
4349
class AppComponent {
4450
String title = 'Tour of Heroes';
4551
}
Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,31 @@
11
// #docplaster
2-
// #docregion
2+
// #docregion , v2
33
import 'package:angular2/core.dart';
4-
// #enddocregion
5-
import 'package:angular2/router.dart'; // for testing only
6-
// #docregion
74

85
import 'hero_service.dart';
96
import 'heroes_component.dart';
107

8+
// #enddocregion v2
119
@Component(
12-
selector: 'my-app',
13-
template: '''
10+
selector: 'my-app',
11+
template: '''
1412
<h1>{{title}}</h1>
1513
<my-heroes></my-heroes>''',
16-
directives: const [HeroesComponent],
17-
providers: const [
18-
// #enddocregion
19-
ROUTER_PROVIDERS,
20-
// #docregion
21-
HeroService
22-
])
14+
directives: const [HeroesComponent],
15+
providers: const [HeroService])
16+
// #enddocregion
17+
// #docregion v2
18+
@Component(
19+
selector: 'my-app',
20+
// #docregion template-v2
21+
template: '''
22+
<h1>{{title}}</h1>
23+
<a [routerLink]="['Heroes']">Heroes</a>
24+
<router-outlet></router-outlet>''',
25+
// #enddocregion template-v2
26+
directives: const [HeroesComponent],
27+
providers: const [HeroService])
28+
// #docregion , v2
2329
class AppComponent {
2430
String title = 'Tour of Heroes';
2531
}

public/docs/_examples/toh-5/dart/lib/app_component_2.dart

Lines changed: 0 additions & 31 deletions
This file was deleted.

public/docs/_examples/toh-5/dart/lib/dashboard_component_2.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ class DashboardComponent implements OnInit {
2222
heroes = (await _heroService.getHeroes()).skip(1).take(4).toList();
2323
}
2424

25-
gotoDetail() {/* not implemented yet */}
25+
gotoDetail(Hero hero) {/* not implemented yet */}
2626
}
Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
// #docplaster
22
// #docregion , v2
33
import 'dart:async';
4+
// #docregion goBack
45
import 'dart:html';
56

6-
// #docregion import-oninit
7+
// #enddocregion goBack
78
import 'package:angular2/core.dart';
8-
// #enddocregion import-oninit
9-
// #docregion router
9+
// #docregion added-imports
1010
import 'package:angular2/router.dart';
11-
// #enddocregion router
1211

12+
// #enddocregion added-imports
1313
import 'hero.dart';
14-
// #docregion import-hero-service
14+
// #docregion added-imports
1515
import 'hero_service.dart';
16-
// #enddocregion import-hero-service
16+
// #enddocregion added-imports
1717

1818
@Component(
1919
selector: 'my-hero-detail',
@@ -23,9 +23,9 @@ import 'hero_service.dart';
2323
styleUrls: const ['hero_detail_component.css']
2424
// #docregion v2
2525
)
26-
// #docregion implement
26+
// #docregion goBack, implement
2727
class HeroDetailComponent implements OnInit {
28-
// #enddocregion implement
28+
// #enddocregion goBack, implement
2929
Hero hero;
3030
// #docregion ctor
3131
final HeroService _heroService;
@@ -36,17 +36,14 @@ class HeroDetailComponent implements OnInit {
3636

3737
// #docregion ngOnInit
3838
Future<Null> ngOnInit() async {
39-
// #docregion get-id
4039
var idString = _routeParams.get('id');
41-
var id = int.parse(idString, onError: (_) => null);
42-
// #enddocregion get-id
40+
var id = int.parse(idString ?? '', onError: (_) => null);
4341
if (id != null) hero = await (_heroService.getHero(id));
4442
}
4543
// #enddocregion ngOnInit
46-
4744
// #docregion goBack
45+
4846
void goBack() {
4947
window.history.back();
5048
}
51-
// #enddocregion goBack
5249
}

public/docs/_examples/toh-5/dart/lib/heroes_component.dart

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,28 @@ import 'package:angular2/core.dart';
66
import 'package:angular2/router.dart';
77

88
import 'hero.dart';
9-
import 'hero_detail_component.dart';
109
import 'hero_service.dart';
1110

12-
// #docregion metadata, heroes-component-renaming
11+
// #docregion metadata, renaming
1312
@Component(
1413
selector: 'my-heroes',
15-
// #enddocregion heroes-component-renaming
14+
// #enddocregion renaming
1615
templateUrl: 'heroes_component.html',
17-
styleUrls: const ['heroes_component.css'],
18-
directives: const [HeroDetailComponent])
19-
// #docregion heroes-component-renaming
20-
// #enddocregion heroes-component-renaming, metadata
21-
// #docregion class, heroes-component-renaming
16+
styleUrls: const ['heroes_component.css']
17+
// #docregion renaming
18+
)
19+
// #enddocregion metadata
20+
// #docregion class
2221
class HeroesComponent implements OnInit {
23-
// #enddocregion heroes-component-renaming
22+
// #enddocregion renaming
2423
final Router _router;
2524
final HeroService _heroService;
2625
List<Hero> heroes;
2726
Hero selectedHero;
2827

28+
// #docregion renaming
2929
HeroesComponent(this._heroService, this._router);
30+
// #enddocregion renaming
3031

3132
Future<Null> getHeroes() async {
3233
heroes = await _heroService.getHeroes();
@@ -44,5 +45,5 @@ class HeroesComponent implements OnInit {
4445
'HeroDetail',
4546
{'id': selectedHero.id.toString()}
4647
]);
47-
// #docregion heroes-component-renaming
48+
// #docregion renaming
4849
}
Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,42 @@
11
// #docplaster
2-
// #docregion
2+
// #docregion , v2
33
import { Component } from '@angular/core';
44

5+
// #enddocregion v2
56
@Component({
67
selector: 'my-app',
78
template: `
89
<h1>{{title}}</h1>
910
<my-heroes></my-heroes>
1011
`
1112
})
13+
// #enddocregion
14+
// #docregion v2
15+
@Component({
16+
selector: 'my-app',
17+
// #docregion template-v2
18+
template: `
19+
<h1>{{title}}</h1>
20+
<a routerLink="/heroes">Heroes</a>
21+
<router-outlet></router-outlet>
22+
`
23+
// #enddocregion template-v2
24+
})
25+
// #enddocregion
26+
@Component({
27+
selector: 'my-app',
28+
// #docregion template-v3
29+
template: `
30+
<h1>{{title}}</h1>
31+
<nav>
32+
<a routerLink="/dashboard">Dashboard</a>
33+
<a routerLink="/heroes">Heroes</a>
34+
</nav>
35+
<router-outlet></router-outlet>
36+
`
37+
// #enddocregion template-v3
38+
})
39+
// #docregion , v2
1240
export class AppComponent {
1341
title = 'Tour of Heroes';
1442
}

public/docs/_examples/toh-5/ts/app/app.component.2.ts

Lines changed: 0 additions & 17 deletions
This file was deleted.

public/docs/_examples/toh-5/ts/app/app.component.3.ts

Lines changed: 0 additions & 24 deletions
This file was deleted.

public/docs/_examples/toh-5/ts/app/app.component.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
// #docplaster
21
// #docregion
32
import { Component } from '@angular/core';
43

public/docs/_examples/toh-5/ts/app/app.module.2.ts

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)