Document: importNode() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
TheimportNode() method of theDocument interface creates a copy of aNode orDocumentFragment from another document, to be inserted into the current document later.
The imported node is not yet included in the document tree. To include it, you need to call an insertion method such asappendChild() orinsertBefore() with a node thatis currently in the document tree.
Unlikedocument.adoptNode(), the original node is not removed from its original document. The imported node is a clone of the original.
TheNode.cloneNode() method also creates a copy of a node. The difference is thatimportNode() clones the node in the context of the calling document, whereascloneNode() uses the document of the node being cloned. The document context determines theCustomElementRegistry for constructing any custom elements. For this reason, to clone nodes to be used in another document, useimportNode() on the target document. TheHTMLTemplateElement.content is owned by a separate document, so it should also be cloned usingdocument.importNode() so that custom element descendants are constructed using the definitions in the current document. See theNode.cloneNode() page's examples for more details.
In this article
Syntax
importNode(externalNode)importNode(externalNode, deep)Parameters
externalNodeThe external
NodeorDocumentFragmentto import intothe current document.deepOptionalA boolean flag, whose default value is
false,which controls whether to include the entire DOM subtreeof theexternalNodein the import.- If
deepis set totrue, thenexternalNodeand all of its descendants are copied. - If
deepis set tofalse, then onlyexternalNodeis imported — the new node has no children.
- If
Return value
The copiedimportedNode in the scope of the importing document.
Note:importedNode'sNode.parentNode isnull, since it has not yet been inserted into the document tree!
Examples
>Using importNode()
const iframe = document.querySelector("iframe");const oldNode = iframe.contentWindow.document.getElementById("myNode");const newNode = document.importNode(oldNode, true);document.getElementById("container").appendChild(newNode);Notes
Before they can be inserted into the current document, nodes from external documents should either be:
- cloned using
document.importNode(); or - adopted using
document.adoptNode().
Note:Although Firefox doesn't currently enforce this rule, we encourage you to follow this rule for improved future compatibility.
For more on theNode.ownerDocument issues, see the W3C DOM FAQ.
Specifications
| Specification |
|---|
| DOM> # ref-for-dom-document-importnode①> |
Browser compatibility
See also
document.adoptNode(), which behaves very similar to this methodNode.appendChild()Node.insertBefore()