This article needs a technical review. How you can help.
The Node.cloneNode() method returns a duplicate of the node on which this method was called.
Syntax
var dupNode = node.cloneNode(deep);
- node
- The node to be cloned.
- dupNode
- The new node that will be a clone of
node - deep Optional
trueif the children of the node should also be cloned, orfalseto clone only the specified node.
Note: In the DOM4 specification (as implemented in Gecko 13.0 (Firefox 13 / Thunderbird 13 / SeaMonkey 2.10)), deep is an optional argument. If omitted, the method acts as if the value of deep was true, defaulting to using deep cloning as the default behavior. To create a shallow clone, deep must be set to false.
This behavior has been changed in the latest spec, and if omitted, the method will act as if the value of deep was false. Though It's still optional, you should always provide the deep argument both for backward and forward compatibility. With Gecko 28.0 (Firefox 28 / Thunderbird 28 / SeaMonkey 2.25 / Firefox OS 1.3)), the console warned developers not to omit the argument. Starting with Gecko 29.0 (Firefox 29 / Thunderbird 29 / SeaMonkey 2.26)), a shallow clone is defaulted instead of a deep clone.
Example
var p = document.getElementById("para1");
var p_prime = p.cloneNode(true);
Notes
Cloning a node copies all of its attributes and their values, including intrinsic (in–line) listeners. It does not copy event listeners added using addEventListener() or those assigned to element properties. (e.g. node.onclick = fn) Moreover, for a <canvas> element, the painted image is not copied.
The duplicate node returned by cloneNode() is not part of the document until it is added to another node that is part of the document using Node.appendChild() or a similar method. It also has no parent until it is appended to another node.
If deep is set to false, child nodes are not cloned. Any text that the node contains is not cloned either, as it is contained in one or more child Text nodes.
If deep evaluates to true, the whole subtree (including text that may be in child Text nodes) is copied too. For empty nodes (e.g. <img> and <input> elements) it doesn't matter whether deep is set to true or false.
cloneNode() may lead to duplicate element IDs in a document.If the original node has an ID and the clone is to be placed in the same document, the ID of the clone should be modified to be unique. Name attributes may need to be modified also, depending on whether duplicate names are expected.
To clone a node for appending to a different document, use Document.importNode() instead.
Specifications
| Specification | Status | Comment |
|---|---|---|
| DOM The definition of 'Node.cloneNode()' in that specification. |
Living Standard | |
| Document Object Model (DOM) Level 3 Core Specification The definition of 'Node.cloneNode()' in that specification. |
Recommendation | |
| Document Object Model (DOM) Level 2 Core Specification The definition of 'Node.cloneNode()' in that specification. |
Recommendation | Initial definition |
Browser compatibility
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|
| Basic support | (Yes) | (Yes) | (Yes) | (Yes) | (Yes) |
deep as an optional parameter |
(Yes)[1] |
13.0 (13.0) | (Yes) | ? |
(Yes)[1] |
| Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | (Yes) | (Yes) | (Yes) | (Yes) | (Yes) | (Yes) |
deep as an optional parameter |
? | ? | 13.0 (13.0) | ? | ? | ? |
[1] Default value for the deep parameter is false.