文档片段中自定义元素的初始化

Question

考虑这个 HTML template 有两个平面 x-element 和一个嵌套。

<template id="fooTemplate">
  <x-element>Enter your text node here.</x-element>
  <x-element>
    <x-element>Hello, World?</x-element>
  </x-element>
</template>

如何初始化（触发构造函数）从 fooTemplate 文档片段克隆的所有自定义元素，而不将其附加到 DOM，也不通过使用 is="x-element" 扩展内置元素；整个片段。

class XElement extends HTMLElement {
  constructor() { super(); }
  foo() { console.log( this ); }
} customElements.define( 'x-element', XElement );

const uselessf = function( temp ) {
  const frag = window[ temp ].content.cloneNode( true );

  /* Your magic code goes here:
  */ do_black_magic( frag );

  for (const e of  frag.querySelectorAll('x-element') )
    e.foo(); // This should work.

  return frag;
};

window['someNode'].appendChild( uselessf('fooTemplate') );

请注意，脚本使用 defer 属性执行。

Answer 1

我们可以用这个箭头函数初始化模板：

const initTemplate = temp =>
  document.createRange().createContextualFragment( temp.innerHTML );

const frag = initTemplate( window['someTemplate'] );

或者使用在 template 原型上定义的方法（我更喜欢这种方式）：

Object.defineProperty(HTMLTemplateElement.prototype, 'initialise', {
  enumerable: false,
  value() {
    return document.createRange().createContextualFragment( this.innerHTML );
  }
});

const frag = window['someTemplate'].initialise();

在任何情况下，这段代码都可以正常工作：

for (const elem of  frag.querySelectorAll('x-element') )
  elem.foo();

window['someNode'].appendChild( frag );

我不确定这些方法是否是在模板中初始化自定义元素的最有效方法。

另请注意，不需要克隆模板。

Answer 2

您可以通过简单地将模板克隆添加到 document 立即在处理它之前，避免上一个答案中的“createContextualFragment” hack。

假设我们定义了这两个变量...

const containerEl = document.querySelector('div.my-container')
const templateEl = document.querySelector('#fooTemplate')

...而不是这样做（其中 frag 包含未初始化的自定义元素）...

const frag = templateEl.content.cloneNode(true)
manipulateTemplateContent(frag)
containerEl.appendChild(frag)

...先将模板克隆附加到文档，然后对其进行操作。用户不会注意到任何差异 - 它们都是在同一帧内执行的所有同步代码。

const frag = templateEl.content.cloneNode(true)
containerEl.appendChild(frag)
manipulateTemplateContent(containerEl)

Answer 3

TLDR:

使用 document.importNode(template.content, true); 而不是 template.content.cloneNode(true); Read more about document.importNode() here.

解释：

因为自定义元素是在不同的 document/context（DocumentFragment of the template) it doesn't know about the custom elements definition in the root/global document. You can get the document an element belongs to by reading the Node.ownerDocument property (MDN）中创建的，在这种情况下将不同于 window.document 元素。

这就是说您需要在全局文档的上下文中创建自定义元素才能“应用”自定义元素。这可以通过调用 document.importNode(node, [true]) (MDN) 来完成，它的工作方式类似于 node.cloneNode([true])，但会在全局文档上下文中创建元素的副本。

或者，您也可以使用 document.adoptNode(node) (MDN) 首先将 DocumentFragment 应用到全局文档中，然后通过 node.cloneNode([true]) 创建它的副本。请注意，如果您在 HTML 元素上使用 adoptNode()，它将从其原始文档中删除。

示例代码：

class XElement extends HTMLElement {
  constructor() { super(); console.log("Custom Element Constructed") }
}
customElements.define( 'x-element', XElement );

const externalFragment = fooTemplate.content;

console.log(
  "Is ownerDocument equal?",
  externalFragment.ownerDocument === document
);

console.log("import start");

const importedFragment = document.importNode(externalFragment, true);

console.log("import end");

console.log(
  "Is ownerDocument equal?",
  importedFragment.ownerDocument === document
);

<template id="fooTemplate">
  <x-element>Hello, World?</x-element>
</template>

注意： 将元素从一个文档附加到另一个文档会强制 implicit adoption of the node。这就是在这种情况下将元素附加到全局 DOM 的原因。

文档片段中自定义元素的初始化

Initialisation of Custom Elements Inside Document Fragment

javascript

html

custom-element

documentfragment

html-templates