Class Renderer

renderSettled Promise<void> public

Defined in packages/@ember/renderer/index.ts:11

returns

Promise<void>

a promise which fulfills when rendering has completed

Returns a promise which will resolve when rendering has completed. In this context, rendering is completed when all auto-tracked state that is consumed in the template (including any tracked state in models, services, etc. that are then used in a template) has been updated in the DOM.

For example, in a test you might want to update some tracked state and then run some assertions after rendering has completed. You could use await settled() in that location, but in some contexts you don't want to wait for full settledness (which includes test waiters, pending AJAX/fetch, run loops, etc) but instead only want to know when that updated value has been rendered in the DOM. THAT is what await renderSettled() is perfect for.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

import { renderSettled } from '@ember/renderer';
import { render } from '@ember/test-helpers';
import { tracked } from '@glimmer/tracking';
import { hbs } from 'ember-cli-htmlbars';
import { setupRenderingTest } from 'my-app/tests/helpers';
import { module, test } from 'qunit';

module('Integration | Component | profile-card', function (hooks) {
  setupRenderingTest(hooks);

  test("it renders the person's name", async function (assert) {
    class Person {
      @tracked name = '';
    }

    this.person = new Person();
    this.person.name = 'John';

    await render(hbs`
      <ProfileCard @name={{this.person.name}} />
    `);

    assert.dom(this.element).hasText('John');

    this.person.name = 'Jane';

    await renderSettled(); // Wait until rendering has completed.

    assert.dom(this.element).hasText('Jane');
  });
});