event-binding.md

Event binding

We want our application to react to the user's actions. We want to update the title of the todo item whenever the user changes it, or to add a new item when the user presses the Save button or the Enter key.

We still don't have a whole list to show, but at the moment we will use another way to test the action. We will change it to the right functionality later on.

The input-button-unit component should look like this:

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

import { Component, OnInit } from '@angular/core';

@Component({
  selector: 'app-input-button-unit',
  template: `
    <p>
      input-button-unit works!
      The title is: {{ title }}
    </p>

    <input [value]="title">
    <button>Save</button>
  `,  
  styleUrls: ['./input-button-unit.component.css']  
})    
export class InputButtonUnitComponent implements OnInit {
  title = 'Hello World';           

  constructor() { }                     

  ngOnInit() {
  }
}

{% endcode-tabs-item %} {% endcode-tabs %}

The Action

First, let's implement changeTitle. It will receive the new title as its argument. The best practice is to have our custom methods written after the lifecycle methods (ngOnInit in this case):

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

changeTitle(newTitle: string) {
  this.title = newTitle;
}

{% endcode-tabs-item %} {% endcode-tabs %}

Binding to Events

Just like binding to element properties, we can bind to events that are emitted by the elements. Again, Angular gives us an easy way to do this. You just wrap the name of the event with parenthesis, and pass it the method that should be executed when the event is emitted.

Let's try a simple example, where the title is changed when the user clicks on the button. Notice the parenthesis around click. (We also change the binding of the input's value back to title.)

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

template: `
  <p>
    input-button-unit works!
    The title is: {{ title }}
  </p>

  <input [value]="title">
  <button (click)="changeTitle('Button Clicked!')">
    Save
  </button>
`,

{% endcode-tabs-item %} {% endcode-tabs %}

The event is called click and not onClick - in Angular you remove the on prefix from the events in the elements.

Go to the browser and see the result - click on the Save button.

Event Data

We pass a static string to the method call: Button Clicked!' But we want to pass the value that the user typed in the input box!

In the next chapter we will learn how to use properties of one element in another element in the same template. Then we'll be able to complete the implementation of the click event of the Save button.
But now we'll bind a method to an event on the input element: when the user clicks Enter, the method changeTitle will be called.

'keyup' event

When the user types, keyboard events are emitted. For example keydown and keyup. We will catch the keyup event (when the pressed key is released) and change the title:

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

<input [value]="title" (keyup)="changeTitle('Button Clicked!')">

{% endcode-tabs-item %} {% endcode-tabs %}

Now when the user types in the input box, the title is changed to "Button Clicked!". But it's still a static string.

Tip: When an element becomes long due to its attributes, you should make it easier on the eye by splitting it into several lines:

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

<input [value]="title" 
       (keyup)="changeTitle('Button Clicked!')">

{% endcode-tabs-item %} {% endcode-tabs %}

The $event object

Now we just react when the keyup event occurs. Angular allows us to get the event object itself. It is passed to the event binding as $event - so we can use it when we call changeTitle().

The event object emitted on keyup events has a reference to the element that emitted the event - the input element. The reference is kept in the event's property target. As we've seen before, the input element has a property value which holds the current string that's in the input box. We can pass $event.target.value to the method:

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

<input [value]="title" 
       (keyup)="changeTitle($event.target.value)">

{% endcode-tabs-item %} {% endcode-tabs %}

Check it out in the browser. Now with every key stroke, you can see the title changes and reflects the input value.

Pressing the Enter key

You can limit the change to only a special key stroke, in our case it's the Enter key. Angular makes it really easy for us. The keyup event has properties which are more specific events. So just add the name of the key you'd like to listen to - keyup.enter:

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

<input [value]="title" 
       (keyup.enter)="changeTitle($event.target.value)">

{% endcode-tabs-item %} {% endcode-tabs %}

Now the title will change only when the user hits the Enter key while typing in the input.

Explore the $event

Playground: You can change the changeTitle method to log the $event object in the console. This way you can explore it and see what properties it has.

Change the method changeTitle:

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

changeTitle(event): void {
  console.log(event);
  this.title = event.target.value; // the original functionality still works
}

{% endcode-tabs-item %} {% endcode-tabs %}

Now change the argument you're passing in the template, to pass the whole $event:

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

<input [value]="title" 
       (keyup.enter)="changeTitle($event)">

{% endcode-tabs-item %} {% endcode-tabs %}

Try it out!

You can do the same with the button element:

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

  <button (click)="changeTitle($event)">
    Save
  </button>

{% endcode-tabs-item %} {% endcode-tabs %}

Don't forget to change back the code before we go on!

{% code-tabs %} {% code-tabs-item title="src/app/input-button-unit/input-button-unit.component.ts" %}

import { Component, OnInit } from '@angular/core';

@Component({
  selector: 'app-input-button-unit',
  template: `
    <p>
      input-button-unit works!
      The title is: {{ title }}
    </p>

    <input [value]="title" 
           (keyup.enter)="changeTitle($event.target.value)">

    <button (click)="changeTitle('Button Clicked!')">
      Save
    </button>
  `,  
  styleUrls: ['./input-button-unit.component.css']  
})    
export class InputButtonUnitComponent implements OnInit {
  title = 'Hello World';           

  constructor() { }                     

  ngOnInit() {
  }

  changeTitle(newTitle: string) {
    this.title = newTitle;
  }
}

{% endcode-tabs-item %} {% endcode-tabs %}