aboutsummaryrefslogtreecommitdiff
path: root/files/pt-br/web/api/customelementregistry/whendefined/index.html
blob: 6480557933fafa5d2aca9e862291cdac6b266c2b (plain)
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
---
title: CustomElementRegistry.whenDefined()
slug: Web/API/CustomElementRegistry/whenDefined
tags:
    - API
    - CustomElementRegistry
    - Method
    - Reference
    - Web Components
    - custom elements
    - whenDefined
browser-compat: api.CustomElementRegistry.whenDefined
---

<p>{{APIRef("CustomElementRegistry")}}</p>

<p>
    O <code><strong>whenDefined()</strong></code> é um método de {{domxref("CustomElementRegistry")}} e a interface retorna uma {{jsxref("Promise")}} que é resolvido quando o elemento nomeado é
    definido.
</p>

<h2 id="Syntax">Syntax</h2>

<pre class="brush: js">customElements.whenDefined(<em>name</em>): Promise&lt;CustomElementConstructor&gt;;</pre>

<h3 id="Parameters">Parâmetros</h3>

<dl>
    <dt>name</dt>
    <dd>Nome do elemento personalizado.</dd>
</dl>

<h3 id="Return_value">Valor de retorno</h3>

<p>
    A {{jsxref("Promise")}} que será cumprida com o <a href="/en-US/docs/Web/API/Window/customElements">elemento personalizado</a>'s construtor quando um
    <a href="/en-US/docs/Web/API/Window/customElements">custom element</a> torna-se definido com o nome fornecido. (Se o <a href="/en-US/docs/Web/API/Window/customElements">custom element</a> já foi
    definido, a promessa devolvida será imediatamente cumprida.)
</p>

<h3 id="Exceptions">Exceções</h3>

<table class="no-markdown">
    <thead>
        <tr>
            <th scope="col">Exceção</th>
            <th scope="col">Descrição</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><code>SyntaxError</code></td>
            <td>
                Se o nome fornecido não for um <a href="https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name">nome de elemento personalizado válido</a>, a promessa
                rejeita com um <code>SyntaxError</code>.
            </td>
        </tr>
    </tbody>
</table>

<h2 id="Examples">Exemplos</h2>

<p>
    Este exemplo usa <code>whenDefined()</code> para detectar quando os elementos personalizados que compõem um menu são definidos. O menu exibe o conteúdo do espaço reservado até que o conteúdo do
    menu real esteja pronto para ser exibido.
</p>

<pre class="brush: html">
&lt;nav id="menu-container"&gt;
  &lt;div class="menu-placeholder"&gt;Loading...&lt;/div&gt;
  &lt;nav-menu&gt;
    &lt;menu-item&gt;Item 1&lt;/menu-item&gt;
    &lt;menu-item&gt;Item 2&lt;/menu-item&gt;
     ...
    &lt;menu-item&gt;Item N&lt;/menu-item&gt;
  &lt;/nav-menu&gt;
&lt;/nav&gt;
</pre>

<pre class="brush: js">
const container = document.getElementById('menu-container');
const placeholder = container.querySelector('.menu-placeholder');
// Busca todos os filhos do menu que ainda não foram definidos.
const undefinedElements = container.querySelectorAll(':not(:defined)');

async function removePlaceholder(){
  const promises = [...undefinedElements].map(
    button =&gt; customElements.whenDefined(button.localName)
  );

  // Espere que todos os filhos sejam atualizados
  await Promise.all(promises);
  // em seguida, remova o espaço reservado
  container.removeChild(placeholder);
}

removePlaceholder();
</pre>

<h2 id="Specifications">Specifications</h2>

{{Specifications}}

<h2 id="Browser_compatibility">Compatibilidade com navegadores</h2>

<p>{{Compat}}</p>