Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

support shadow-root #475

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

support shadow-root #475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81970f1
Update dom-to-image.js
Osiris-Team Apr 8, 2024
48dfd5b
Update README.md
Osiris-Team Apr 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Changes in this fork

- Support shadow-root elements.

# DOM to Image

[![Build Status](https://travis-ci.org/tsayen/dom-to-image.svg?branch=master)](https://travis-ci.org/tsayen/dom-to-image)
Expand Down
74 changes: 63 additions & 11 deletions src/dom-to-image.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,13 +136,13 @@

function copyOptions(options) {
// Copy options to impl options for use in impl
if(typeof(options.imagePlaceholder) === 'undefined') {
if (typeof (options.imagePlaceholder) === 'undefined') {
domtoimage.impl.options.imagePlaceholder = defaultOptions.imagePlaceholder;
} else {
domtoimage.impl.options.imagePlaceholder = options.imagePlaceholder;
}

if(typeof(options.cacheBust) === 'undefined') {
if (typeof (options.cacheBust) === 'undefined') {
domtoimage.impl.options.cacheBust = defaultOptions.cacheBust;
} else {
domtoimage.impl.options.cacheBust = options.cacheBust;
Expand Down Expand Up @@ -175,39 +175,82 @@
}

function cloneNode(node, filter, root) {
if (!root && filter && !filter(node)) return Promise.resolve();
console.log("==> Entering cloneNode function for node="+node);

if (!root && filter && !filter(node)) {
console.log("Filter condition met. Returning Promise.resolve()");
return Promise.resolve();
}

console.log("Creating promise to clone node");
return Promise.resolve(node)
.then(makeNodeCopy)
.then(function (clone) {
console.log("Cloning children");
return cloneChildren(node, clone, filter);
})
.then(function (clone) {
console.log("Processing clone");
return processClone(node, clone);
});

function makeNodeCopy(node) {
if (node instanceof HTMLCanvasElement) return util.makeImage(node.toDataURL());
console.log("Making node copy");
if (node instanceof HTMLCanvasElement) {
console.log("Node is an instance of HTMLCanvasElement. Making image.");
return util.makeImage(node.toDataURL());
}
console.log("Node is not an instance of HTMLCanvasElement. Cloning node.");
return node.cloneNode(false);
}

function loopThroughShadowRootContent(element, func) {
// Check if the element has a shadow root
if (element.shadowRoot) {
// If it does, apply the function to each element within the shadow root
element.shadowRoot.childNodes.forEach(func);
// Recursively apply the function to each child of the shadow root
element.shadowRoot.childNodes.forEach(child => {
loopThroughShadowRootContent(child, func);
});
}
}

function cloneChildren(original, clone, filter) {
console.log("Cloning children of node");
var children = original.childNodes;
if (children.length === 0) return Promise.resolve(clone);

// Check if the element has a shadow root
if (original.shadowRoot) {
console.log("Element has shadow root");
var shadowChildren = original.shadowRoot.childNodes;
children = Array.from(children).concat(Array.from(shadowChildren));
} else {
console.log("Element does not have shadow root");
}

if (children.length === 0) {
console.log("No children. Resolving with clone.");
return Promise.resolve(clone);
}

return cloneChildrenInOrder(clone, util.asArray(children), filter)
.then(function () {
console.log("All children cloned. Resolving with clone.");
return clone;
});

function cloneChildrenInOrder(parent, children, filter) {
console.log("Cloning children in order");
var done = Promise.resolve();
children.forEach(function (child) {
done = done
.then(function () {
console.log("Cloning child node="+child);
return cloneNode(child, filter);
})
.then(function (childClone) {
console.log("Appending cloned child to parent");
if (childClone) parent.appendChild(childClone);
});
});
Expand All @@ -216,18 +259,24 @@
}

function processClone(original, clone) {
if (!(clone instanceof Element)) return clone;
console.log("Processing clone");
if (!(clone instanceof Element)) {
console.log("Clone is not an instance of Element. Returning clone.");
return clone;
}

return Promise.resolve()
.then(cloneStyle)
.then(clonePseudoElements)
.then(copyUserInput)
.then(fixSvg)
.then(function () {
console.log("All processing done. Resolving with clone.");
return clone;
});

function cloneStyle() {
console.log("Cloning style");
copyStyle(window.getComputedStyle(original), clone.style);

function copyStyle(source, target) {
Expand All @@ -247,6 +296,7 @@
}

function clonePseudoElements() {
console.log("Cloning pseudo elements");
[':before', ':after'].forEach(function (element) {
clonePseudoElement(element);
});
Expand Down Expand Up @@ -290,11 +340,13 @@
}

function copyUserInput() {
console.log("Copying user input");
if (original instanceof HTMLTextAreaElement) clone.innerHTML = original.value;
if (original instanceof HTMLInputElement) clone.setAttribute("value", original.value);
}

function fixSvg() {
console.log("Fixing SVG");
if (!(clone instanceof SVGElement)) return;
clone.setAttribute('xmlns', 'http://www.w3.org/2000/svg');

Expand Down Expand Up @@ -462,7 +514,7 @@

function getAndEncode(url) {
var TIMEOUT = 30000;
if(domtoimage.impl.options.cacheBust) {
if (domtoimage.impl.options.cacheBust) {
// Cache bypass so we dont have CORS issues with cached images
// Source: https://developer.mozilla.org/en/docs/Web/API/XMLHttpRequest/Using_XMLHttpRequest#Bypassing_the_cache
url += ((/\?/).test(url) ? "&" : "?") + (new Date()).getTime();
Expand All @@ -479,9 +531,9 @@
request.send();

var placeholder;
if(domtoimage.impl.options.imagePlaceholder) {
if (domtoimage.impl.options.imagePlaceholder) {
var split = domtoimage.impl.options.imagePlaceholder.split(/,/);
if(split && split[1]) {
if (split && split[1]) {
placeholder = split[1];
}
}
Expand All @@ -490,7 +542,7 @@
if (request.readyState !== 4) return;

if (request.status !== 200) {
if(placeholder) {
if (placeholder) {
resolve(placeholder);
} else {
fail('cannot fetch resource: ' + url + ', status: ' + request.status);
Expand All @@ -508,7 +560,7 @@
}

function timeout() {
if(placeholder) {
if (placeholder) {
resolve(placeholder);
} else {
fail('timeout of ' + TIMEOUT + 'ms occured while fetching resource: ' + url);
Expand Down