diff --git a/public/docs/ts/latest/guide/toh-pt1.jade b/public/docs/ts/latest/guide/toh-pt1.jade index 3d7188ef7f..61c1d5c769 100644 --- a/public/docs/ts/latest/guide/toh-pt1.jade +++ b/public/docs/ts/latest/guide/toh-pt1.jade @@ -3,87 +3,118 @@ include ../../../../_includes/_util-fns .l-main-section :markdown - # Tour of Heroes - Part 1 - We Need A Hero + # Tour of Heroes - Part 1 - ## 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 Tour of Heroes tutorial takes us through the steps of creating an Angular application. + Our grand vision is to build an app to help a staffing agency manage its stable of heroes. + Even heroes need to find work. - ### **The End Game** - Before we begin, let’s get an idea of where what we’re going to build. + Of course we'll only make a little progress in this tutorial. What we do build will + have many of the features we expect to find in a full-blown, data-driven application: acquiring and displaying + a list of heroes, editing a selected hero's detail, and navigating among different + views of heroic data. - 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. + The Tour of Heroes covers the core fundamentals of Angular. + We’ll use built-in directives to show/hide elements and display lists of hero data. + We’ll create a component to display hero details and another to show an array of heroes. + We'll use one-way data binding for read-only data. We'll add editable fields to update a model + with two-way data binding. We'll bind component method to user events like key strokes and clicks. + We’ll learn to select a hero from a master list and edit that hero in the details view. We'll + format data with pipes. And we'll use routing to navigate among different views and their components. - We’ll use built-in directives to show/hide elements and display lists of heroes data. We’ll 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 we’ll 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. + We’ll learn enough core Angular to get started and gain confidence that + Angular can do whatever we need it to do. + We'll be covering a lot of ground at an introductory level but we’ll find plenty of links + to chapters with greater depth. - We’ll cover just enough of the core fundamentals to get us started and build an app. Since we are covering a lot of ground, we’ll be able to go deeper on topics by following links as we go. + ## The End Game + + Let's get a visual idea of where we're going in this tour, beginning with the "Heroes" + view and its list of heroes: - **Selectable List of Heroes** figure.image-display img(src='/resources/images/devguide/toh/heroes-list-1.png' alt="Output of heroes list app") :markdown - **Hero Details** + Above the list are two links ("Dashboard" and "Heroes"). + We click them to navigate between a Dashboard view and this Heroes view. + + After selecting a hero, we can click the "View Details" button and be + wisked away by the router to a "Hero Details" view + where we can change the hero's name. + 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** - We’ll be building the Tour of Heroes together, step by step. Along the way we’ll 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. We’ll motivate the direction the Tour of Heroes takes, and learn how to solve common application needs with Angular 2’s fundamentals. + Links at the top take us back to either of the main views. + The "Back" button returns us to the "Heroes" view. - ## Initial App Setup - + ## How We Roll - ### **Creating Tour of Heroes** + We’ll build this Tour of Heroes together, step by step. + We'll motiviate each step with a requirement that we've + met in countless applications. Everything has a reason. - After following [Getting Started](../guide/gettingStarted.html), copy the code to a new folder and rename the folder - `angular2-tour-of-heroes` + And we’ll meet many of the core fundamentals of Angular along the way. - 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 +.l-main-section :markdown - ### **Keeping the App Running** - Let’s start the TypeScript compiler and have it watch for changes in one terminal window by typing + # Once Upon a Time + + Every story starts somewhere. Our story starts where the [Getting Started chapter]('./gettingstarted') ends. + + Follow the "Getting Started" steps. They provide the prerequisites, the folder structure, + and the core files for our Tour of Heroes. + + Copy the "Getting Started" code to a new folder and rename the folder `angular2-tour-of-heroes`. + We should have the following structure: + + code-example. + angular2-tour-of-heroes + ├── node_modules + ├── src + | ├── app + | | └── app.ts + | ├── typings + | | └── tsd.d.ts + | ├── index.html + | └── tsconfig.json + └── package.json + + :markdown + ## Keep the App Running + 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 - We’ll start the server and launch the app in the browser by typing in another terminal window + Now open another terminal window and start the server by typing 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. + This command starts the server, launches the app in a browser, + and keeps the app running while we continue to build the Tour of Heroes. - 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. + .alert.is-helpful + :markdown + These two steps watch all project files. They recompile TypeScript files and re-run + the app when any file changes. + If the watchers fail to detect renamed or new files, + stop these commands in each terminal by typing `CTRL+C` and then re-run them. .l-main-section :markdown - ## Let's Show our Hero - We want to show data in our app, so let’s start by creating a title for our Tour of Heroes. - We’ll also create a hero and display her. + # Show our Hero + We want to display Hero data in our app - ### **Displaying Data** - We need to add properties in our component to store the title and the hero’s name. Let’s create `title` and `hero` properties in the component. We’ll set the title to Tour of Heroes and set the hero to Windstorm. + Let's add two properties to our `AppComponent`, a `title` property for the application name and a `hero` property + for a hero named "Windstorm". ``` class AppComponent { @@ -93,178 +124,248 @@ include ../../../../_includes/_util-fns ``` :markdown - This defines properties on our component that we can bind and display in the HTML template. Now we need to display the properties. + Now we update the template in the `@Component` decoration with data bindings to these new properties. - Let’s change the template to show the name of our hero + code-example(format="linenums"). + template: '<h1>{{title}}</h1><h2>{{hero}} details!</h2>' + :markdown + The browser should refresh and display our title and hero. - ```javascript - @View({ - template: '

{\{titles}\}

{{hero}} details!

' - })``` + The double curly braces tell our app to read the `title` and `hero` properties from the component and render them. + This is the "interpolation" form of one-way data binding; + we can learn more about interpolation in the [Displaying Data chapter](displaying-data). - The curly braces tell our app to read the `title` and `hero` properties from the component and render them. + ## Hero Object - Learn more about one-way binding in the Data Binding chapter. + At the moment, our hero is just a name. Our hero needs more properties. + Let's convert the `hero` from a literal string to a class. - ### **Hero Object** - Our hero has a name, but we want to her to have more properties. We’ll do this in TypeScript - by creating a `Hero` class. - - Let’s create the `Hero` class with `id` and `name` properties. We’ll put this in the `app.ts` file for now. + Create a `Hero` class with `id` and `name` properties. + Keep this near the top of hte `app.ts` file for now. ``` class Hero { id: number; name: string; - }``` + } + ``` - Now that we have a `Hero` class, let’s refactor our component’s `hero` property to be of type `Hero`. Then we’ll initialize it with an id of 1 and name of Windstorm. + Now that we have a `Hero` class, let’s refactor our component’s `hero` property to be of type `Hero`. + Then initialize it with an id of `1` and the name, "Windstorm". ``` public hero: Hero = { id: 1, name: 'Windstorm' - };``` - - We just changed the hero from a string to an object. Let’s change the binding in the template to refer to the hero’s `name` property and put it in the `

`. - + }; ``` - @View({ - template: '

{{title}}

{{hero.name}} details!

' - })``` - We can now see our hero’s name, Windstorm, is displayed in the browser. + Because we changed the hero from a string to an object, + we update the binding in the template to refer to the hero’s `name` property. - ## Editing Our Hero - Displaying a name is good, but we want to see all of our hero’s properties and allow editing the name. Let’s continue by adding the rest of the hero’s properties to the template so we can see those details. + code-example(format="linenums"). + template: '<h1>{{title}}</h1><h2>{{hero.name}} details!</h2>' + :markdown + The browser refreshes and continues to display our hero’s name. - ### **Adding more HTML** + ## **Adding more HTML** + Displaying a name is good, but we want to see all of our hero’s properties. We’ll add a `
` for our hero’s `id` property and another `
` for our hero’s `name`. - ``` - @View({ - template: '

{{title}}

{{hero.name}} details!

{{hero.id}}
{{hero.name}}
' - })``` + code-example(format="linenums"). + template: '<h1>{{title}}</h1><h2>{{hero.name}} details!</h2><div><label>id: </label>{{hero.id}}</div><div><label>name: </label>{{hero.name}}</div>' + :markdown + Uh oh, our template string is getting long. We better take care of that to avoid the risk of making a typo in the template. - Uh oh, our string is getting long. We better take care of that to avoid the risk of making a typo in the template. + ### Multi-line Template Strings - ### **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, let’s solve this by taking advantage of the template strings feature in ES2015 and TypeScript to maintain some sanity. + We could make a more readable template with string concatenation + but that gets ugly fast, it is harder to read, and + it is easy to make a spelling error. Instead, + let’s take advantage of the template strings feature + in ES2015 and TypeScript to maintain our sanity. - Let’s change the quotes around the template to back-ticks + Change the quotes around the template to back-ticks and + put the `

`, `

` and `
` elements on their own lines. - ``` - @View({ - template:

{{title}}

{{hero.name}} details!

{{hero.id}}
{{hero.name}}
- })``` + code-example(format="linenums"). + 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 don’t 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 template’s string. Everything between the back-ticks is part of the template, even spanning multiple lines. + .callout.is-important + header A back-tick is not a single quote + :markdown + **Be careful!** A back-tick (`) looks a lot like a single quote ('). + It's actually a completely different character. + Back-ticks can do more than demarcate a string. + Here we use them in a limited way to spread the template over multiple lines. + Everything between the back-ticks at the beginning and end of the template + is part of a single template string. - Now let’s change the template to be more readable with the `

`, `

` and `
` elements each on their own lines. +.l-main-section - ### **Multi-line Templates** - Template strings are helpful for embedding a few lines of templates in a component. Once we exceed a few lines, we’ll move the template to an HTML file and point to it. Our small template is not at that point yet, so we’ll stick with the template string. + :markdown + # Editing Our Hero - Edit the template so it looks like the following: + We want to be able to edit the hero name in a textbox. - ``` - @View({ - template:

{{title}}

{{hero.name}} details!

{{hero.id}}
{{hero.name}}
- })``` + Replace the hero name `