docs(guide/{di,ts,toh-[23]}): follow-up to #1654 (#1767)

Mainly Dart-side review, following #1654.
dependency-injection:
- Renamed components in providers_component.dart
- E2e suites passed:
  - public/docs/_examples/dependency-injection/dart
  - public/docs/_examples/dependency-injection/ts

template-syntax:
- Removed unused global variable.
- Suites passed:
  public/docs/_examples/template-syntax/dart
  public/docs/_examples/template-syntax/ts

toh-2 & 3:
- Clean-up.
This commit is contained in:
Patrice Chalin 2016-06-28 08:16:59 -07:00 committed by Kathy Walrath
parent a7435c3f8c
commit bacc4bcbac
4 changed files with 63 additions and 66 deletions

View File

@ -18,10 +18,10 @@ const template = '{{log}}';
providers: const [Logger] providers: const [Logger]
// #enddocregion providers-1, providers-logger // #enddocregion providers-1, providers-logger
) )
class ProviderComponent1 { class Provider1Component {
String log; String log;
ProviderComponent1(Logger logger) { Provider1Component(Logger logger) {
logger.log('Hello from logger provided with Logger class'); logger.log('Hello from logger provided with Logger class');
log = logger.logs[0]; log = logger.logs[0];
} }
@ -31,15 +31,15 @@ class ProviderComponent1 {
@Component( @Component(
selector: 'provider-3', selector: 'provider-3',
template: '{{log}}', template: '{{log}}',
providers: providers:
// #docregion providers-3 // #docregion providers-3
const [const Provider(Logger, useClass: Logger)] const [const Provider(Logger, useClass: Logger)]
// #enddocregion providers-3 // #enddocregion providers-3
) )
class ProviderComponent3 { class Provider3Component {
String log; String log;
ProviderComponent3(Logger logger) { Provider3Component(Logger logger) {
logger.log('Hello from logger provided with useClass:Logger'); logger.log('Hello from logger provided with useClass:Logger');
log = logger.logs[0]; log = logger.logs[0];
} }
@ -56,10 +56,10 @@ class BetterLogger extends Logger {}
const [const Provider(Logger, useClass: BetterLogger)] const [const Provider(Logger, useClass: BetterLogger)]
// #enddocregion providers-4 // #enddocregion providers-4
) )
class ProviderComponent4 { class Provider4Component {
String log; String log;
ProviderComponent4(Logger logger) { Provider4Component(Logger logger) {
logger.log('Hello from logger provided with useClass:BetterLogger'); logger.log('Hello from logger provided with useClass:BetterLogger');
log = logger.logs[0]; log = logger.logs[0];
} }
@ -87,10 +87,10 @@ class EvenBetterLogger extends Logger {
const [UserService, const Provider(Logger, useClass: EvenBetterLogger)] const [UserService, const Provider(Logger, useClass: EvenBetterLogger)]
// #enddocregion providers-5 // #enddocregion providers-5
) )
class ProviderComponent5 { class Provider5Component {
String log; String log;
ProviderComponent5(Logger logger) { Provider5Component(Logger logger) {
logger.log('Hello from EvenBetterlogger'); logger.log('Hello from EvenBetterlogger');
log = logger.logs[0]; log = logger.logs[0];
} }
@ -116,10 +116,10 @@ class OldLogger extends Logger {
const Provider(OldLogger, useClass: NewLogger)] const Provider(OldLogger, useClass: NewLogger)]
// #enddocregion providers-6a // #enddocregion providers-6a
) )
class ProviderComponent6a { class Provider6aComponent {
String log; String log;
ProviderComponent6a(NewLogger newLogger, OldLogger oldLogger) { Provider6aComponent(NewLogger newLogger, OldLogger oldLogger) {
if (newLogger == oldLogger) { if (newLogger == oldLogger) {
throw new Exception('expected the two loggers to be different instances'); throw new Exception('expected the two loggers to be different instances');
} }
@ -140,10 +140,10 @@ class ProviderComponent6a {
const Provider(OldLogger, useExisting: NewLogger)] const Provider(OldLogger, useExisting: NewLogger)]
// #enddocregion providers-6b // #enddocregion providers-6b
) )
class ProviderComponent6b { class Provider6bComponent {
String log; String log;
ProviderComponent6b(NewLogger newLogger, OldLogger oldLogger) { Provider6bComponent(NewLogger newLogger, OldLogger oldLogger) {
if (newLogger != oldLogger) { if (newLogger != oldLogger) {
throw new Exception('expected the two loggers to be the same instance'); throw new Exception('expected the two loggers to be the same instance');
} }
@ -178,10 +178,10 @@ const silentLogger = const SilentLogger();
const [const Provider(Logger, useValue: silentLogger)] const [const Provider(Logger, useValue: silentLogger)]
// #enddocregion providers-7 // #enddocregion providers-7
) )
class ProviderComponent7 { class Provider7Component {
String log; String log;
ProviderComponent7(Logger logger) { Provider7Component(Logger logger) {
logger.log('Hello from logger provided with useValue'); logger.log('Hello from logger provided with useValue');
log = logger.logs[0]; log = logger.logs[0];
} }
@ -191,13 +191,13 @@ class ProviderComponent7 {
selector: 'provider-8', selector: 'provider-8',
template: '{{log}}', template: '{{log}}',
providers: const [heroServiceProvider, Logger, UserService]) providers: const [heroServiceProvider, Logger, UserService])
class ProviderComponent8 { class Provider8Component {
// #docregion provider-8-ctor
ProviderComponent8(HeroService heroService);
// #enddocregion provider-8-ctor
// must be true else this component would have blown up at runtime // must be true else this component would have blown up at runtime
var log = 'Hero service injected successfully via heroServiceProvider'; var log = 'Hero service injected successfully via heroServiceProvider';
// #docregion provider-8-ctor
Provider8Component(HeroService heroService);
// #enddocregion provider-8-ctor
} }
@Component( @Component(
@ -208,12 +208,12 @@ class ProviderComponent8 {
const Provider(APP_CONFIG, useValue: heroDiConfig)] const Provider(APP_CONFIG, useValue: heroDiConfig)]
// #enddocregion providers-9 // #enddocregion providers-9
) )
class ProviderComponent9 implements OnInit { class Provider9Component implements OnInit {
Map _config; Map _config;
String log; String log;
// #docregion provider-9-ctor // #docregion provider-9-ctor
ProviderComponent9(@Inject(APP_CONFIG) this._config); Provider9Component(@Inject(APP_CONFIG) this._config);
// #enddocregion provider-9-ctor // #enddocregion provider-9-ctor
@override @override
@ -225,7 +225,7 @@ class ProviderComponent9 implements OnInit {
// Sample providers 1 to 7 illustrate a required logger dependency. // Sample providers 1 to 7 illustrate a required logger dependency.
// Optional logger, can be null. // Optional logger, can be null.
@Component(selector: 'provider-10', template: '{{log}}') @Component(selector: 'provider-10', template: '{{log}}')
class ProviderComponent10 implements OnInit { class Provider10Component implements OnInit {
final Logger _logger; final Logger _logger;
String log; String log;
@ -234,11 +234,10 @@ class ProviderComponent10 implements OnInit {
HeroService(@Optional() this._logger) { HeroService(@Optional() this._logger) {
// #enddocregion provider-10-ctor // #enddocregion provider-10-ctor
*/ */
ProviderComponent10(@Optional() this._logger) { Provider10Component(@Optional() this._logger) {
const someMessage = 'Hello from the injected logger'; const someMessage = 'Hello from the injected logger';
// #docregion provider-10-ctor // #docregion provider-10-ctor
if (_logger != null) _logger?.log(someMessage);
_logger.log(someMessage);
} }
// #enddocregion provider-10-ctor // #enddocregion provider-10-ctor
@ -263,15 +262,15 @@ class ProviderComponent10 implements OnInit {
<div id="p9"><provider-9></provider-9></div> <div id="p9"><provider-9></provider-9></div>
<div id="p10"><provider-10></provider-10></div>''', <div id="p10"><provider-10></provider-10></div>''',
directives: const [ directives: const [
ProviderComponent1, Provider1Component,
ProviderComponent3, Provider3Component,
ProviderComponent4, Provider4Component,
ProviderComponent5, Provider5Component,
ProviderComponent6a, Provider6aComponent,
ProviderComponent6b, Provider6bComponent,
ProviderComponent7, Provider7Component,
ProviderComponent8, Provider8Component,
ProviderComponent9, Provider9Component,
ProviderComponent10 Provider10Component
]) ])
class ProvidersComponent {} class ProvidersComponent {}

View File

@ -4,8 +4,6 @@ import 'package:angular2/core.dart';
import 'hero.dart'; import 'hero.dart';
var nextHeroDetailId = 1;
// #docregion input-output-2 // #docregion input-output-2
@Component( @Component(
// #enddocregion input-output-2 // #enddocregion input-output-2

View File

@ -8,6 +8,21 @@ class Hero {
Hero(this.id, this.name); Hero(this.id, this.name);
} }
// #docregion hero-array
final List<Hero> mockHeroes = [
new Hero(11, 'Mr. Nice'),
new Hero(12, 'Narco'),
new Hero(13, 'Bombasto'),
new Hero(14, 'Celeritas'),
new Hero(15, 'Magneta'),
new Hero(16, 'RubberMan'),
new Hero(17, 'Dynama'),
new Hero(18, 'Dr IQ'),
new Hero(19, 'Magma'),
new Hero(20, 'Tornado')
];
// #enddocregion hero-array
@Component( @Component(
selector: 'my-app', selector: 'my-app',
template: ''' template: '''
@ -94,18 +109,3 @@ class AppComponent {
} }
// #enddocregion on-select // #enddocregion on-select
} }
// #enddocregion
// #docregion hero-array
final List<Hero> mockHeroes = [
new Hero(11, 'Mr. Nice'),
new Hero(12, 'Narco'),
new Hero(13, 'Bombasto'),
new Hero(14, 'Celeritas'),
new Hero(15, 'Magneta'),
new Hero(16, 'RubberMan'),
new Hero(17, 'Dynama'),
new Hero(18, 'Dr IQ'),
new Hero(19, 'Magma'),
new Hero(20, 'Tornado')
];

View File

@ -8,6 +8,19 @@ import 'hero.dart';
import 'hero_detail_component.dart'; import 'hero_detail_component.dart';
// #enddocregion hero-detail-import // #enddocregion hero-detail-import
final List<Hero> mockHeroes = [
new Hero(11, 'Mr. Nice'),
new Hero(12, 'Narco'),
new Hero(13, 'Bombasto'),
new Hero(14, 'Celeritas'),
new Hero(15, 'Magneta'),
new Hero(16, 'RubberMan'),
new Hero(17, 'Dynama'),
new Hero(18, 'Dr IQ'),
new Hero(19, 'Magma'),
new Hero(20, 'Tornado')
];
@Component( @Component(
selector: 'my-app', selector: 'my-app',
// #docregion hero-detail-template // #docregion hero-detail-template
@ -87,16 +100,3 @@ class AppComponent {
selectedHero = hero; selectedHero = hero;
} }
} }
final List<Hero> mockHeroes = [
new Hero(11, 'Mr. Nice'),
new Hero(12, 'Narco'),
new Hero(13, 'Bombasto'),
new Hero(14, 'Celeritas'),
new Hero(15, 'Magneta'),
new Hero(16, 'RubberMan'),
new Hero(17, 'Dynama'),
new Hero(18, 'Dr IQ'),
new Hero(19, 'Magma'),
new Hero(20, 'Tornado')
];