Template Lifecycle, DOM, and Modifiers

In most cases, the best way to think about your component's output is to assume that it will be re-executed from the top every time anything changes in your application.

For example, consider an Article component that takes @title and @body arguments.

<article>
  <header><h1>{{@title}}</h1></header>
  <section>{{@body}}</section>
</article>

Assuming an article route with a model that looks like:

{
  "title": "Hello world",
  "body": "This is the first article"
}

This component would be invoked this way:

<Article @title={{@model.title}} @body={{@model.body}}>

The first time the Article component is rendered, it would produce this output:

<article>
  <header><h1>Hello world</h1></header>
  <section>This is the first article</section>
</article>

In a way, this is like substitution: references to @title in the component's template are replaced by the value passed in from the outside.

If the model changes to:

{
  "title": "Hello world",
  "body": "This is the first article. [UPDATE] I am so excited!"
}

the output will be updated to:

<article>
  <header><h1>Hello world</h1></header>
  <section>This is the first article. [UPDATE] I am so excited!</section>
</article>

Think of this as evaluating the template from scratch, substituting in the new values, and updating the output with the new contents.

Zoey says...

In practice, Ember avoids updating parts of the DOM that haven't changed, which means that the user's selection state, cursor and scroll position, and other state won't change for no reason.

In general, before reaching for direct DOM manipulation, you should see whether you can model the changes that you want by writing a single template that applies no matter what the input is.

The same philosophy that applies to changing text also applies to changing attributes.

For example, let's say we want to enhance our Article component to include a title attribute on the <article> tag.

<article title="{{@title}}">
  <header><h1>{{@title}}</h1></header>
  <section>{{@body}}</section>
</article>

With the model:

{
  "title": "Hello world",
  "body": "This is the first article. [UPDATE] I am so excited!"
}

the output will be:

<article title="Hello world">
  <header><h1>Hello world</h1></header>
  <section>This is the first article. [UPDATE] I am so excited!</section>
</article>

Just like in previous examples, you can think of attribute changes as substitution. If the model changes to:

{
  "title": "Hello world",
  "title": "Hello world!",
  "body": "This is the first article. [UPDATE] I am so excited!"
}

the output will be updated to:

<article title="Hello world">
<article title="Hello world!">
  <header><h1>Hello world</h1></header>
  <header><h1>Hello world!</h1></header>
  <section>This is the first article. [UPDATE] I am so excited!</section>
</article>

So far, we've talked about how to populate an attribute with the value of a variable. But what if we want the value of an attribute to differ based upon whether the variable is truthy or falsy?

For example, let's say we want the class on a <div> to be superuser if the @isAdmin variable is true, but standard if the @isAdmin variable is false.

We could accomplish this requirement by using the if helper inside of an attribute:

<div class={{if @isAdmin "superuser" "standard"}}>
  Welcome to my app.
</div>

Instead of thinking about changing the class imperatively when the @isAdmin variable changes, we can think about how to build a template that produces the right output in both cases, and leave it up to Ember to figure out how to update the HTML output.

In summary, when you're trying to update a piece of text or an attribute in your component, think of the Principle of Substitution, and write a template that produces the right HTML when you substitute all of the variables in the template with the current values of the variables.

Whenever any of those variables change, Ember will automatically update the HTML efficiently without blowing away browser state unnecessarily.

The advantage to writing components this way is that there is no way to make a mistake and forget to update the output correctly in some situations. As long as the template produces the right HTML for its inputs, the output will remain up to date.

This approach works great when you're trying to produce output that can be represented in HTML. But what about aspects of your component that aren't represented in HTML, like event handlers? In those cases, Ember tries to stick to the spirit of the Principle of Substitution, and allow you to write templates as if they only ran one time, and then automatically keep the output up to date for you.

The rest of this guide describes how to enhance your templates with event handlers, custom DOM properties and other kinds of custom JavaScript.

If you want to add an event handler to an HTML element, you can use the {{on element modifier.

import Component from "@glimmer/component";
import { action } from "@ember/object";

export default class CounterComponent extends Component {
  @tracked count = 0;

  @action
  increment() {
    this.count++;
  }
}

<p>{{this.count}}</p>

<button {{on "click" this.increment}}>+</button>

Tomster says...

"Element modifiers" appear inside free-floating curly braces inside of an opening tag. Unlike attribute syntax, which works by substitution (and therefore affects the HTML output of your page), element modifiers work by passing the element to a function that can do anything with it.

Unlike attributes, element modifiers do not run on the server-side, because there is no general-purpose and complete way to serialize the results of an element modifier into HTML.

Since you're writing an HTML template, you can use dynamic substitution inside of an attribute's value; whenever the value changes, the attribute will change.

Setting properties on an HTML element, on the other hand, is a different story, because there's no way to set a property using HTML syntax.

For example, let's say you want to create an <audio> element, but pass it a blob as its srcObject.

Since srcObject is a property and not an HTML attribute, you can use the prop element modifier from ember-prop-modifier like this:

<audio {{prop srcObject=this.blob}} />

If the value changes, Ember will automatically update the element's property for you.

If you're looking at a piece of documentation written using HTML syntax, you can use the syntax as-is in your template, and use {{ to insert dynamic content.

On the other hand, if you're looking at JavaScript documentation that tells you to set a property on an element object, you can use {{prop to set the prop

If you want to set a property, you can use the prop element modifier.

So far, we've talked about web APIs that work by setting attributes as well as web APIs that work by setting properties. But what about web APIs that work by calling methods, like setting focus on an element?

For example, let's say we want to focus an <input> in a form as soon as the form is rendered. The web API for focusing an element is:

inputElement.focus();

This code needs to run after the element is rendered.

The simplest way to accomplish this is by using the did-insert modifier from @ember/render-modifiers.

<form>
  <input {{did-insert this.focus}}>
</form>

export default class EditForm {
  focus(element) {
    element.focus();
  }
}

The did-insert modifier will call a function after its element is added to the DOM. That function receives the element as a parameter.

Using the did-insert modifier works well for one-off cases, but if you want to pull this logic into reusable functionality that you can use throughout your app, you can make your own modifier.

The modifier that we're going to build will allow us to say:

<form>
  <input {{autofocus}}>
</form>

Pretty nice, right?

To accomplish that, we'll create a modifier in app/modifiers/autofocus.js. First, install ember-modifier and then generate an autofocus modifier for your app:

ember install ember-modifier
ember generate modifier autofocus

Now add the functionality to focus the element:

import { modifier } from "ember-modifier";

export default modifier(element => element.focus());

And that's it!

Now we can use our custom {{autofocus}} modifier throughout our application.

What if you want to handle an event in one part of your component by calling a DOM method on another part? For example, let's say you're creating an audio component:

<audio src={{@srcURL}} />

<button type="button">Play</button>
<button type="button">Pause</button>

How should we connect clicking the "Play" and "Pause" to calling the audio tag's play and pause methods?

While we could manage these DOM interactions in the component class (for example, by using {{did-render}}), we're better off using a modifier here. It lets us cleanly separate our concerns: the component manages the state, and the modifier manages interactions with the DOM.

There are three reasons to reach for modifiers for DOM element interactions:

1. A component, by itself, doesn't have direct access to DOM elements. We have to render the page, push an element back up into the component class, and only then can we safely refer to that element. This can sometimes require us to render the component's HTML twice in order for things to start working. Modifiers let us avoid this possible performance issue.
2. By keeping state in the component and handling DOM method calls in a modifier, we can use autotracking and stick to 1-way data flow in the component. Further, we could change the component's own design later without having to change how we interact with the DOM element.
3. The code for calling the audio element's play and pause can be reused. It isn't tied to this particular audio component. It can be tested independently, too!

Now that we see why we want to use a modifier for our audio component, let's walk through how to create one. We will start with the component (to manage the state) and then implement the modifier (the manage the DOM).

First, we add actions to handle the click events for the Play and Pause buttons:

<audio src={{@srcURL}} />

<button type="button">Play</button>
<button type="button" {{on "click" this.play}}>Play</button>
<button type="button">Pause</button>
<button type="button" {{on "click" this.pause}}>Pause</button>

import Component from "@glimmer/component";
import { action } from "@ember/object";

export default class AudioPlayerComponent extends Component {
  @action
  play() {
    // TODO
  }

  @action
  pause() {
    // TODO
  }
}

Recall that our modifier will manage the DOM (i.e. calling the audio element's play or pause method). All the component needs to do is to track whether the audio is playing:

import Component from "@glimmer/component";
import { tracked } from "@glimmer/tracking";
import { action } from "@ember/object";

export default class AudioPlayerComponent extends Component {
  @tracked isPlaying = false;

  @action
  play() {
    // TODO
    this.isPlaying = true;
  }

  @action
  pause() {
    // TODO
    this.isPlaying = false;
  }
}

That's it for the component: we're translating the user's interactions into state. Now we need to build a modifier to translate the state into the appropriate DOM method calls!

ember install ember-modifier
ember generate modifier play-when

The modifier takes 1 argument, a Boolean that specifies if we should call the element's play or pause method.

import { modifier } from "ember-modifier";

export default modifier((element, [isPlaying]) => {
  if (isPlaying) {
    element.play();
  } else {
    element.pause();
  }
});

Last but not least, we attach the modifier to the audio element:

<audio src={{@srcURL}} />
<audio src={{@srcURL}} {{play-when this.isPlaying}} />

<button type="button" {{on "click" this.play}}>Play</button>
<button type="button" {{on "click" this.pause}}>Pause</button>

With that, we can now click the buttons to play and pause the audio!

In summary, when you want to allow elements in a component to communicate, see if you can separate the concerns of managing state and managing DOM interactions. The component can manage the state, while a modifier can manage the DOM.

The modifier that we made for the audio player component can be reused on any element that implements play and pause methods. In particular, we can reuse the modifier on any HTMLMediaElement, which includes audio and video elements.

In most cases, your component should restrict its behavior to its own elements. However, there are cases where a component needs to do something outside of itself. One simple example of this would be an element that wants to handle clicks outside of its DOM, which requires registering a handler on the whole document, and then hit-testing the element.

Let's start with the DOM structure of a super-simple component that would remove its contents when a click occurs outside of the element.

<div class="modal">
  {{yield}}
</div>

We don't want to use {{on "click"}} here because we want the opposite behavior: do something whenever the user clicks outside of the <div>. To accomplish that, we'll register a click handler on the entire document and then hit-test it, looking something like this:

document.addEventListener("click", event => {
  if (!element.contains(event.target)) {
    // do something
  }
});

The most important difference between this example and the cases we've seen so far is that we need to remove the click event handler from the document when this element is destroyed.

To accomplish this, we can use ember-modifier to create a on-click-outside modifier that sets up the event listener after the element is first inserted and removes the event listener when the element is removed.

Run the following commands to install the addon and generate a new modifier:

ember install ember-modifier
ember generate modifier on-click-outside

The on-click-outside modifier adds the click handler to the document and returns another function that should be run when Ember removes the element the modifier is attached to.

import { modifier } from "ember-modifier";

export default modifier((element, [callback]) => {
  function handleClick(event) {
    if (!element.contains(event.target)) {
      callback();
    }
  }

  document.addEventListener("click", handleClick);

  return () => {
    document.removeEventListener("click", handleClick);
  };
});

Now that we've created this modifier, we can use it in our modal component, and add some logic to invoke a passed-in action whenever the user clicks outside the modal.

<div class="modal" {{on-click-outside @clickedOutside}}>
  {{yield}}
</div>

We could then use the modal component this way:

<p class="help-icon" {{on "click" this.showHelp}}>?</p>

{{#if this.showingHelp}}
  <Modal @clickedOutside={{this.hideHelp}}>
    Here's some interesting facts about the sidebar that you can learn.
  </Modal>
{{/if}}

import Component from "@glimmer/component";
import { action } from "@ember/object";

export default class SidebarComponent extends Component {
  @tracked showingHelp = false;

  @action
  showHelp() {
    this.showingHelp = true;
  }

  @action
  hideHelp() {
    this.showingHelp = false;
  }
}

Modifiers can also be applied to components, and when they are, they are also passed forward and applied to an element with ...attributes:

<Tooltip {{did-insert this.setupTooltip}}/>

<div ...attributes>
  ...
</div>

In this example, the div within the Tooltip component will get the did-insert modifier applied to it.