2017-02-22 13:09:39 -05:00
@title
Displaying Data
@intro
Property binding helps show app data in the UI.
@description
2017-03-27 11:08:53 -04:00
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
You can display data by binding controls in an HTML template to properties of an Angular component.
In this page, you'll create a component with a list of heroes.
You'll display the list of hero names and
conditionally show a message below the list.
The final UI looks like this:
2017-03-30 15:04:18 -04:00
2017-02-22 13:09:39 -05:00
< figure class = 'image-display' >
2017-03-31 19:57:13 -04:00
< img src = "assets/images/devguide/displaying-data/final.png" alt = "Final UI" > < / img >
2017-02-22 13:09:39 -05:00
< / figure >
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
# Contents
2017-03-11 10:36:40 -05:00
* [Showing component properties with interpolation ](guide/displaying-data#interpolation ).
2017-03-31 07:23:16 -04:00
* [Showing an array property with NgFor ](guide/displaying-data#ngFor ).
2017-03-11 10:36:40 -05:00
* [Conditional display with NgIf ](guide/displaying-data#ngIf ).
2017-02-22 13:09:39 -05:00
2017-03-27 11:08:53 -04:00
~~~ {.l-sub-section}
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
The < live-example > < / live-example > demonstrates all of the syntax and code
snippets described in this page.
2017-03-27 11:08:53 -04:00
~~~
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
## Showing component properties with interpolation
The easiest way to display a component property
is to bind the property name through interpolation.
With interpolation, you put the property name in the view template, enclosed in double curly braces: `{{myHero}}` .
2017-03-11 10:36:40 -05:00
Follow the [setup ](guide/setup ) instructions for creating a new project
2017-03-31 07:23:16 -04:00
named < code > displaying-data< / code > .
2017-02-22 13:09:39 -05:00
2017-03-31 07:23:16 -04:00
Then modify the < code > app.component.ts< / code > file by
2017-02-22 13:09:39 -05:00
changing the template and the body of the component.
When you're done, it should look like this:
2017-03-31 19:57:13 -04:00
< code-example path = "displaying-data/src/app/app.component.1.ts" title = "src/app/app.component.ts" >
2017-03-27 11:08:53 -04:00
< / code-example >
2017-02-22 13:09:39 -05:00
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
You added two properties to the formerly empty component: `title` and `myHero` .
The revised template displays the two component properties using double curly brace
interpolation:
2017-03-27 11:08:53 -04:00
< code-example path = "displaying-data/src/app/app.component.1.ts" linenums = "false" title = "src/app/app.component.ts (template)" region = "template" >
< / code-example >
2017-03-31 07:23:16 -04:00
~~~ {.l-sub-section}
2017-03-31 19:57:13 -04:00
2017-03-31 07:23:16 -04:00
The template is a multi-line string within ECMAScript 2015 backticks (< code > \`</ code > ).
The backtick (< code > \`</ code > )— which is *not* the same character as a single
quote (`'`)— allows you to compose a string over several lines, which makes the
HTML more readable.
~~~
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
Angular automatically pulls the value of the `title` and `myHero` properties from the component and
inserts those values into the browser. Angular updates the display
when these properties change.
2017-03-27 11:08:53 -04:00
~~~ {.l-sub-section}
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
More precisely, the redisplay occurs after some kind of asynchronous event related to
the view, such as a keystroke, a timer completion, or a response to an HTTP request.
2017-03-27 11:08:53 -04:00
~~~
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
Notice that you don't call **new** to create an instance of the `AppComponent` class.
Angular is creating an instance for you. How?
2017-03-31 07:23:16 -04:00
The CSS `selector` in the `@Component` decorator specifies an element named `<my-app>` .
2017-02-22 13:09:39 -05:00
That element is a placeholder in the body of your `index.html` file:
2017-03-27 11:08:53 -04:00
< code-example path = "displaying-data/src/index.html" linenums = "false" title = "src/index.html (body)" region = "body" >
< / code-example >
2017-03-31 19:57:13 -04:00
2017-03-31 07:23:16 -04:00
When you bootstrap with the `AppComponent` class (in < code > main.ts</ code > ), Angular looks for a `<my-app>`
2017-02-22 13:09:39 -05:00
in the `index.html` , finds it, instantiates an instance of `AppComponent` , and renders it
inside the `<my-app>` tag.
Now run the app. It should display the title and hero name:
2017-03-30 15:04:18 -04:00
2017-02-22 13:09:39 -05:00
< figure class = 'image-display' >
2017-03-31 19:57:13 -04:00
< img src = "assets/images/devguide/displaying-data/title-and-hero.png" alt = "Title and Hero" > < / img >
2017-02-22 13:09:39 -05:00
< / figure >
2017-03-31 19:57:13 -04:00
2017-03-31 07:23:16 -04:00
The next few sections review some of the coding choices in the app.
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
## Template inline or template file?
You can store your component's template in one of two places.
You can define it *inline* using the `template` property, or you can define
the template in a separate HTML file and link to it in
2017-03-31 07:23:16 -04:00
the component metadata using the `@Component` decorator's `templateUrl` property.
2017-02-22 13:09:39 -05:00
The choice between inline and separate HTML is a matter of taste,
circumstances, and organization policy.
Here the app uses inline HTML because the template is small and the demo
is simpler without the additional HTML file.
In either style, the template data bindings have the same access to the component's properties.
2017-03-31 19:57:13 -04:00
2017-03-31 07:23:16 -04:00
## Constructor or variable initialization?
Although this example uses variable assignment to initialize the components, you can instead declare and initialize the properties using a constructor:
2017-02-22 13:09:39 -05:00
2017-03-31 07:23:16 -04:00
< code-example path = "displaying-data/src/app/app-ctor.component.ts" linenums = "false" title = "src/app/app-ctor.component.ts (class)" region = "class" >
2017-02-22 13:09:39 -05:00
2017-03-31 07:23:16 -04:00
< / code-example >
2017-03-31 19:57:13 -04:00
2017-03-31 07:23:16 -04:00
This app uses more terse "variable assignment" style simply for brevity.
2017-03-27 11:08:53 -04:00
2017-03-31 19:57:13 -04:00
2017-03-31 07:23:16 -04:00
## Showing an array property with ***ngFor**
To display a list of heroes, begin by adding an array of hero names to the component and redefine `myHero` to be the first name in the array.
2017-03-27 11:08:53 -04:00
2017-03-30 15:04:18 -04:00
2017-03-27 11:08:53 -04:00
< code-example path = "displaying-data/src/app/app.component.2.ts" linenums = "false" title = "src/app/app.component.ts (class)" region = "class" >
< / code-example >
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
Now use the Angular `ngFor` directive in the template to display
each item in the `heroes` list.
2017-03-27 11:08:53 -04:00
< code-example path = "displaying-data/src/app/app.component.2.ts" linenums = "false" title = "src/app/app.component.ts (template)" region = "template" >
< / code-example >
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
This UI uses the HTML unordered list with `<ul>` and `<li>` tags. The `*ngFor`
in the `<li>` element is the Angular "repeater" directive.
It marks that `<li>` element (and its children) as the "repeater template":
2017-03-27 11:08:53 -04:00
< code-example path = "displaying-data/src/app/app.component.2.ts" linenums = "false" title = "src/app/app.component.ts (li)" region = "li" >
< / code-example >
2017-02-22 13:09:39 -05:00
~~~ {.alert.is-important}
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
Don't forget the leading asterisk (\*) in `*ngFor` . It is an essential part of the syntax.
2017-03-31 19:57:13 -04:00
For more information, see the [Template Syntax ](guide/template-syntax#ngFor ) page.
2017-02-22 13:09:39 -05:00
~~~
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
Notice the `hero` in the `ngFor` double-quoted instruction;
it is an example of a template input variable. Read
2017-03-31 19:57:13 -04:00
more about template input variables in the [microsyntax ](guide/template-syntax#microsyntax ) section of
2017-03-11 10:36:40 -05:00
the [Template Syntax ](guide/template-syntax ) page.
2017-02-22 13:09:39 -05:00
Angular duplicates the `<li>` for each item in the list, setting the `hero` variable
to the item (the hero) in the current iteration. Angular uses that variable as the
context for the interpolation in the double curly braces.
2017-03-27 11:08:53 -04:00
~~~ {.l-sub-section}
2017-03-31 19:57:13 -04:00
2017-03-31 07:23:16 -04:00
In this case, `ngFor` is displaying an array, but `ngFor` can
repeat items for any [iterable ](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols ) object.
2017-03-27 11:08:53 -04:00
~~~
2017-03-31 19:57:13 -04:00
2017-03-27 11:08:53 -04:00
Now the heroes appear in an unordered list.
2017-02-22 13:09:39 -05:00
2017-03-30 15:04:18 -04:00
2017-02-22 13:09:39 -05:00
< figure class = 'image-display' >
2017-03-31 19:57:13 -04:00
< img src = "assets/images/devguide/displaying-data/hero-names-list.png" alt = "After ngfor" > < / img >
2017-02-22 13:09:39 -05:00
< / figure >
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
## Creating a class for the data
The app's code defines the data directly inside the component, which isn't best practice.
In a simple demo, however, it's fine.
2017-03-31 07:23:16 -04:00
At the moment, the binding is to an array of strings.
2017-02-22 13:09:39 -05:00
In real applications, most bindings are to more specialized objects.
2017-03-31 07:23:16 -04:00
To convert this binding to use specialized objects, turn the array
of hero names into an array of `Hero` objects. For that you'll need a `Hero` class.
2017-02-22 13:09:39 -05:00
2017-03-31 07:23:16 -04:00
Create a new file in the `app` folder called `hero.ts` with the following code:
2017-03-27 11:08:53 -04:00
2017-03-30 15:04:18 -04:00
2017-03-27 11:08:53 -04:00
< code-example path = "displaying-data/src/app/hero.ts" linenums = "false" title = "src/app/hero.ts (excerpt)" >
< / code-example >
2017-03-31 19:57:13 -04:00
2017-03-27 11:08:53 -04:00
You've defined a class with a constructor and two properties: `id` and `name` .
It might not look like the class has properties, but it does.
The declaration of the constructor parameters takes advantage of a TypeScript shortcut.
Consider the first parameter:
< code-example path = "displaying-data/src/app/hero.ts" linenums = "false" title = "src/app/hero.ts (id)" region = "id" >
< / code-example >
2017-03-31 19:57:13 -04:00
2017-03-27 11:08:53 -04:00
That brief syntax does a lot:
2017-03-31 19:57:13 -04:00
2017-03-27 11:08:53 -04:00
* Declares a constructor parameter and its type.
* Declares a public property of the same name.
* Initializes that property with the corresponding argument when creating an instance of the class.
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
## Using the Hero class
2017-03-31 07:23:16 -04:00
After importing the `Hero` class, the `AppComponent.heroes` property can return a _typed_ array
2017-02-22 13:09:39 -05:00
of `Hero` objects:
2017-03-27 11:08:53 -04:00
< code-example path = "displaying-data/src/app/app.component.3.ts" linenums = "false" title = "src/app/app.component.ts (heroes)" region = "heroes" >
< / code-example >
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
Next, update the template.
At the moment it displays the hero's `id` and `name` .
Fix that to display only the hero's `name` property.
2017-03-27 11:08:53 -04:00
< code-example path = "displaying-data/src/app/app.component.3.ts" linenums = "false" title = "src/app/app.component.ts (template)" region = "template" >
< / code-example >
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
The display looks the same, but the code is clearer.
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
## Conditional display with NgIf
Sometimes an app needs to display a view or a portion of a view only under specific circumstances.
Let's change the example to display a message if there are more than three heroes.
2017-03-31 07:23:16 -04:00
The Angular `ngIf` directive inserts or removes an element based on a _truthy/falsy_ condition.
2017-02-22 13:09:39 -05:00
To see it in action, add the following paragraph at the bottom of the template:
2017-03-27 11:08:53 -04:00
< code-example path = "displaying-data/src/app/app.component.ts" linenums = "false" title = "src/app/app.component.ts (message)" region = "message" >
< / code-example >
2017-02-22 13:09:39 -05:00
~~~ {.alert.is-important}
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
Don't forget the leading asterisk (\*) in `*ngIf` . It is an essential part of the syntax.
2017-03-31 19:57:13 -04:00
Read more about `ngIf` and `*` in the [ngIf section ](guide/template-syntax#ngIf ) of the [Template Syntax ](guide/template-syntax ) page.
2017-02-22 13:09:39 -05:00
~~~
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
The template expression inside the double quotes,
2017-03-31 07:23:16 -04:00
`*ngIf="heros.length > 3"` , looks and behaves much like TypeScript.
2017-02-22 13:09:39 -05:00
When the component's list of heroes has more than three items, Angular adds the paragraph
to the DOM and the message appears. If there are three or fewer items, Angular omits the
paragraph, so no message appears. For more information,
2017-03-31 19:57:13 -04:00
see the [template expressions ](guide/template-syntax#template-expressions ) section of the
2017-03-11 10:36:40 -05:00
[Template Syntax ](guide/template-syntax ) page.
2017-02-22 13:09:39 -05:00
~~~ {.alert.is-helpful}
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
Angular isn't showing and hiding the message. It is adding and removing the paragraph element from the DOM. That improves performance, especially in larger projects when conditionally including or excluding
big chunks of HTML with many data bindings.
~~~
2017-03-31 19:57:13 -04:00
2017-03-31 07:23:16 -04:00
Try it out. Because the array has four items, the message should appear.
Go back into < code > app.component.ts"< / code > and delete or comment out one of the elements from the hero array.
2017-02-22 13:09:39 -05:00
The browser should refresh automatically and the message should disappear.
2017-03-31 19:57:13 -04:00
2017-02-22 13:09:39 -05:00
## Summary
Now you know how to use:
2017-03-31 19:57:13 -04:00
* **Interpolation** with double curly braces to display a component property.
* **ngFor** to display an array of items.
* A TypeScript class to shape the **model data** for your component and display properties of that model.
* **ngIf** to conditionally display a chunk of HTML based on a boolean expression.
2017-02-22 13:09:39 -05:00
Here's the final code:
2017-03-27 11:08:53 -04:00
< code-tabs >
< code-pane title = "src/app/app.component.ts" path = "displaying-data/src/app/app.component.ts" region = "final" >
< / code-pane >
< code-pane title = "src/app/hero.ts" path = "displaying-data/src/app/hero.ts" >
< / code-pane >
< code-pane title = "src/app/app.module.ts" path = "displaying-data/src/app/app.module.ts" >
< / code-pane >
< code-pane title = "main.ts" path = "displaying-data/src/main.ts" >
< / code-pane >
< / code-tabs >