angular-cn/public/docs/ts/latest/guide/toh-pt1.jade

270 lines
13 KiB
Plaintext
Raw Normal View History

include ../../../../_includes/_util-fns
.l-main-section
:markdown
# Tour of Heroes - Part 1 - We Need A Hero
## Once Upon a Time
Every story starts somewhere. Our story starts with the Getting Started chapter. Start by following the Getting Started steps and use that as a starting point for Tour of Heroes. This will give us the prerequisites, the folder structure, and the core files for the app.
### **The End Game**
Before we begin, lets get an idea of where what were going to build.
The Tour of Heroes is an application that covers the core fundamentals of Angular 2. We will build the Tour of Heroes to allow selecting a hero from a list of heroes, editing hero details, and navigating between different views.
Well use built-in directives to show/hide elements and display lists of heroes data. Well add data binding of hero details, data binding for arrays of heroes, editable fields that update their model, and handling user interaction events. We want heroes to be selectable, so well add selecting heroes from a list, navigating from heroes to hero details, and formatting data with pipes. Our Tour of Heroes will also use routing to navigate between different components.
Well cover just enough of the core fundamentals to get us started and build an app. Since we are covering a lot of ground, well be able to go deeper on topics by following links as we go.
2015-10-10 06:29:34 -04:00
**Selectable List of Heroes**
figure.image-display
img(src='/resources/images/devguide/toh/heroes-list-1.png' alt="Output of heroes list app")
:markdown
2015-10-10 06:29:34 -04:00
**Hero Details**
figure.image-display
img(src='/resources/images/devguide/toh/hero-details-1.png' alt="Details of hero in app")
:markdown
### **This is How We Roll**
Well be building the Tour of Heroes together, step by step. Along the way well learn many of the core fundamentals of Angular 2 as we construct the application. Each step is motivated by a requirement. Everything has a reason. Well motivate the direction the Tour of Heroes takes, and learn how to solve common application needs with Angular 2s fundamentals.
2015-10-10 06:29:34 -04:00
## Initial App Setup
<aside class="is-right">Find the basics of app setup in the Getting Started chapter.</aside>
### **Creating Tour of Heroes**
2015-10-10 06:29:34 -04:00
After following [Getting Started](../guide/gettingStarted.html), copy the code to a new folder and rename the folder
`angular2-tour-of-heroes`
Our starting app from Getting Started should look like the following structure:
pre.prettyprint.lang-bash
|---- node_modules
|---- src
| |---- app
| | |---- app.ts
| |---- typings
| | |---- tsd.d.ts
| |---- index.html
| |---- tsconfig.json
|---- package.json
:markdown
### **Keeping the App Running**
Lets start the TypeScript compiler and have it watch for changes in one terminal window by typing
pre.prettyprint.lang-bash
code tsc -p src -w
:markdown
Well start the server and launch the app in the browser by typing in another terminal window
pre.prettyprint.lang-bash
code live-server --open=src
:markdown
This will keep the application running while we continue to build the Tour of Heroes.
2015-10-10 06:29:34 -04:00
<!--TODO: style this with callout style and set a header-->Note: These steps will watch the
existing files and
recompile
and re-run
the app
when they
change. However, if you notice the watchers do not pick up renamed or new files, stop these commands in terminal by typing `CTRL+C` and then re-run both commands.
.l-main-section
:markdown
## Let's Show our Hero
2015-10-10 06:29:34 -04:00
We want to show data in our app, so lets start by creating a title for our Tour of Heroes.
Well also create a hero and display her.
### **Displaying Data**
We need to add properties in our component to store the title and the heros name. Lets create `title` and `hero` properties in the component. Well set the title to Tour of Heroes and set the hero to Windstorm.
```
class AppComponent {
public title = 'Tour of Heroes';
public hero = 'Windstorm';
}
```
:markdown
This defines properties on our component that we can bind and display in the HTML template. Now we need to display the properties.
Lets change the template to show the name of our hero
```javascript
@View({
template: '<h1>{\{titles}\}</h1><h2>{{hero}} details!</h2>'
})```
The curly braces tell our app to read the `title` and `hero` properties from the component and render them.
2015-10-10 06:29:34 -04:00
Learn more about one-way binding in the <!--TODO link-->Data Binding chapter.
### **Hero Object**
2015-10-10 06:29:34 -04:00
Our hero has a name, but we want to her to have more properties. Well do this in TypeScript
by creating a `Hero` class.
Lets create the `Hero` class with `id` and `name` properties. Well put this in the `app.ts` file for now.
```
class Hero {
id: number;
name: string;
}```
Now that we have a `Hero` class, lets refactor our components `hero` property to be of type `Hero`. Then well initialize it with an id of 1 and name of Windstorm.
```
public hero: Hero = {
id: 1,
name: 'Windstorm'
};```
We just changed the hero from a string to an object. Lets change the binding in the template to refer to the heros `name` property and put it in the `<h2>`.
```
@View({
template: '<h1>{{title}}</h1><h2>{{hero.name}} details!</h2>'
})```
We can now see our heros name, Windstorm, is displayed in the browser.
## Editing Our Hero
Displaying a name is good, but we want to see all of our heros properties and allow editing the name. Lets continue by adding the rest of the heros properties to the template so we can see those details.
### **Adding more HTML**
Well add a `<div>` for our heros `id` property and another `<div>` for our heros `name`.
```
@View({
template: '<h1>{{title}}</h1><h2>{{hero.name}} details!</h2><div><label>id: </label>{{hero.id}}</div><div><label>name: </label>{{hero.name}}</div>'
})```
Uh oh, our string is getting long. We better take care of that to avoid the risk of making a typo in the template.
### **Template Strings**
Adding more content to the template is making the template extend to multiple lines. We could use string concatenation, but that gets ugly fast, harder to read, and it is easy for us to make a mistake in typing. Instead, lets solve this by taking advantage of the template strings feature in ES2015 and TypeScript to maintain some sanity.
Lets change the quotes around the template to back-ticks
```
@View({
template: <h1>{{title}}</h1><h2>{{hero.name}} details!</h2><div><label>id: </label>{{hero.id}}</div><div><label>name: </label>{{hero.name}}</div>
})```
If we dont look closely, back-ticks look similar to a single quote. But they operate in an important and different way. Back-ticks permit us to use multiple lines in the templates string. Everything between the back-ticks is part of the template, even spanning multiple lines.
Now lets change the template to be more readable with the `<h1>`, `<h2>` and `<div>` elements each on their own lines.
### **Multi-line Templates**
Template strings are helpful for embedding a few lines of templates in a component. Once we exceed a few lines, well move the template to an HTML file and point to it. Our small template is not at that point yet, so well stick with the template string.
Edit the template so it looks like the following:
```
@View({
template:<h1>{{title}}</h1><h2>{{hero.name}} details!</h2><div><label>id: </label>{{hero.id}}</div><div><label> name: </label>{{hero.name}}</div>
})```
### **Adding an `<INPUT>`**
We want to be able to edit the name of our hero. For this well add an `<input>` element as shown below:
```
@View({
template:
<h1>{{title}}</h1>
<h2>{{hero.name}} details!</h2>
<div><label>id: </label>{{hero.id}}</div>
<div>
<label>name: </label>
<div><input value="{{hero.name}}" placeholder="name"></input></div>
</div>
})```
We want the heros name to appear in the `<input>`. But something doesnt feel right. When we try changing the name and we notice the heros name change is not reflected in the `<h2>`. We dont want to use one-way binding here.
### **Two-Way Binding**
We want to display the name of the hero in the `<input>`, be able to change it, and see those changes in every place bound to the heros name. In short, we want two-way binding. Lets make a change to the template to use the special **`ng-model`** built-in directive to achieve this.
Replace the `<input>` with the following HTML
```
<input [(ng-model)]="hero.name" placeholder="name"></input>
```
Lets fix that next by letting Angular know we want to use the ng-model directive.
2015-10-10 06:29:34 -04:00
<!-- TODO style with a class and add a link *Sidenote: Learn more about ng-model in the [data
binding chapter]* -->
### **FORM Directives**
We just used the `ng-model` directive, but we must tell the component which directives we will use in the template. When we know which directives we want to use, we can import them from Angular 2 and tell the components view that we want to use them.
Lets go get the `NgModel` directive by importing it from Angular as shown below:
````
import {bootstrap, Component, View, NgModel} from 'angular2/angular2';
```
Now lets tell the component that we will use the `ng-model` directive in the template by setting the `directives` property in the `@View` decorator of the component:
```
@View({
directives: [NgModel]
})```
The `directives` property accepts an array of directives that will be used in the components template.
Unfortunately when we view the app in the browser we still have an error:
> *EXCEPTION: No value accessor for ' ' in [null]*
We added `NgModel`, but thats not quite enough to support forms.
### **Declaring Form Directives**
The `ng-model` built-in directive is special as it wraps the functionality needed to bind, in our case, to the `<input>`. Weve learned from our latest error message, that we cant just import `NgModel`. We need a whole bunch of directives to enable this scenario. It would be painful and lengthy burden to remember and list all of the directives. Fortunately, there is a shortcut where we can use a bundle of directives in an array.
### Importing FORM_DIRECTIVES
The `ng-model` directive is a type of Form directive. Lets go get the Form directives by importing `FORM_DIRECTIVES` from Angular as shown below:
```
import {bootstrap, Component, View, FORM_DIRECTIVES} from 'angular2/angular2';
```
### Declaring Directives
Now lets tell the component that we will use Form directives in the template by setting the `directives` property in the `@View` decorator of the component.
```
@View({
directives: [FORM_DIRECTIVES]
})```
Now when we view the app in the browser we can edit the heros name and we see the changes are reflected in the `<h1>`.
Angular bundles all the binding directives for forms together into `FORM_DIRECTIVES`. This is all we need to remember to light up our template. Fortunately, we can bundle a collection of directives together in an array, give it a catchy name, and we can plug that array into the `directives` property.
2015-10-10 06:29:34 -04:00
<!-- TODO *Sidenote: Learn more about Angular 2 Forms in the [Forms chapter]* -->
## Recap
### **The Road Weve Travelled**
2015-10-10 06:29:34 -04:00
Lets take stock of what weve built.
* Our Tour of Heroes now includes one-way data binding to display a hero by wrapping
properties with double curly braces in our template.
* We added two-way data binding so we can change the heros name and see those changes throughout all places the heros name is bound in the template.
* We built our template in the components file using ES2015s template strings feature.
* We declared that we use the Form directives in our component and view.
* We used the special built-in `ng-model` directive with the `<input>` element to make the heros name display in the template. `ng-model` also helps us propagate any changes we make throughout all places bound to `hero.name` in the template.
<!-- TODO: Add this in when the next chapter exists ### **The Road Ahead**
Our Tour of Heroes only displays one hero and we really want to display a list of heroes. We also want to allow the user to select a hero and display their details. Well learn more about
how to retrieve lists, bind them to the
template, and
allow a user to select it in the next chapter. -->