如何检测 iframe 何时已加载

IT技术 javascript jquery dom
2021-01-17 10:09:48

$('#someIframe').load(function(){...})如果在 iframe 加载完成后附加它,似乎不会触发。那是对的吗?

我真正想要的是有一个函数,它总是在 iframe 加载时或之后调用一次。为了更清楚地说明这一点,这里有两种情况:

  • iframe 尚未加载加载后运行回调函数。
  • iframe 已经加载:立即运行回调。

我怎样才能做到这一点?

6个回答

我一直用头撞墙,直到我发现这里发生了什么。

背景资料

  • .load()如果 iframe 已经加载,则无法使用(事件永远不会触发)
  • .ready()不支持在 iframe 元素上使用参考),即使 iframe 尚未加载,也会立即调用回调
  • 在 iframe 内部使用postMessage或调用容器函数load只有在控制它时才有可能
  • $(window).load()在容器上使用也会等待其他资产加载,如图像和其他 iframe。如果您只想等待特定的 iframe,这不是解决方案
  • readyState在 Chrome 中检查已触发的 onload 事件是没有意义的,因为 Chrome 使用“about:blank”空页面初始化每个 iframe。readyState此页面的可能complete,但它不是readyState你所希望的网页(的src属性)。

解决方案

以下是必要的:

  1. 如果 iframe 尚未加载,我们可以观察.load()事件
  2. 如果 iframe 已经加载,我们需要检查 readyState
  3. 如果readyStatecomplete,我们通常可以假设 iframe 已经加载。但是,由于 Chrome 的上述行为,我们还需要检查它是否readyState为空页面
  4. 如果是这样,我们需要readyState在一个时间间隔内观察以检查实际文档(与 src 属性相关)是否是complete

我已经用以下函数解决了这个问题。它已(转换为 ES5)在

  • 铬 49
  • 野生动物园 5
  • 火狐 45
  • IE 8、9、10、11
  • 边缘 24
  • iOS 8.0(“Safari 移动版”)
  • Android 4.0(“浏览器”)

取自jquery.mark 的函数

/**
 * Will wait for an iframe to be ready
 * for DOM manipulation. Just listening for
 * the load event will only work if the iframe
 * is not already loaded. If so, it is necessary
 * to observe the readyState. The issue here is
 * that Chrome will initialize iframes with
 * "about:blank" and set its readyState to complete.
 * So it is furthermore necessary to check if it's
 * the readyState of the target document property.
 * Errors that may occur when trying to access the iframe
 * (Same-Origin-Policy) will be catched and the error
 * function will be called.
 * @param {jquery} $i - The jQuery iframe element
 * @param {function} successFn - The callback on success. Will 
 * receive the jQuery contents of the iframe as a parameter
 * @param {function} errorFn - The callback on error
 */
var onIframeReady = function($i, successFn, errorFn) {
    try {
        const iCon = $i.first()[0].contentWindow,
            bl = "about:blank",
            compl = "complete";
        const callCallback = () => {
            try {
                const $con = $i.contents();
                if($con.length === 0) { // https://git.io/vV8yU
                    throw new Error("iframe inaccessible");
                }
                successFn($con);
            } catch(e) { // accessing contents failed
                errorFn();
            }
        };
        const observeOnload = () => {
            $i.on("load.jqueryMark", () => {
                try {
                    const src = $i.attr("src").trim(),
                        href = iCon.location.href;
                    if(href !== bl || src === bl || src === "") {
                        $i.off("load.jqueryMark");
                        callCallback();
                    }
                } catch(e) {
                    errorFn();
                }
            });
        };
        if(iCon.document.readyState === compl) {
            const src = $i.attr("src").trim(),
                href = iCon.location.href;
            if(href === bl && src !== bl && src !== "") {
                observeOnload();
            } else {
                callCallback();
            }
        } else {
            observeOnload();
        }
    } catch(e) { // accessing contentWindow failed
        errorFn();
    }
};

工作示例

由两个文件(index.html 和 iframe.html)组成: index.html

<!doctype html>
<html>
<head>
    <meta charset="utf-8">
    <title>Parent</title>
</head>
<body>
    <script src="https://code.jquery.com/jquery-1.12.2.min.js"></script>
    <script>
        $(function() {

            /**
             * Will wait for an iframe to be ready
             * for DOM manipulation. Just listening for
             * the load event will only work if the iframe
             * is not already loaded. If so, it is necessary
             * to observe the readyState. The issue here is
             * that Chrome will initialize iframes with
             * "about:blank" and set its readyState to complete.
             * So it is furthermore necessary to check if it's
             * the readyState of the target document property.
             * Errors that may occur when trying to access the iframe
             * (Same-Origin-Policy) will be catched and the error
             * function will be called.
             * @param {jquery} $i - The jQuery iframe element
             * @param {function} successFn - The callback on success. Will 
             * receive the jQuery contents of the iframe as a parameter
             * @param {function} errorFn - The callback on error
             */
            var onIframeReady = function($i, successFn, errorFn) {
                try {
                    const iCon = $i.first()[0].contentWindow,
                        bl = "about:blank",
                        compl = "complete";
                    const callCallback = () => {
                        try {
                            const $con = $i.contents();
                            if($con.length === 0) { // https://git.io/vV8yU
                                throw new Error("iframe inaccessible");
                            }
                            successFn($con);
                        } catch(e) { // accessing contents failed
                            errorFn();
                        }
                    };
                    const observeOnload = () => {
                        $i.on("load.jqueryMark", () => {
                            try {
                                const src = $i.attr("src").trim(),
                                    href = iCon.location.href;
                                if(href !== bl || src === bl || src === "") {
                                    $i.off("load.jqueryMark");
                                    callCallback();
                                }
                            } catch(e) {
                                errorFn();
                            }
                        });
                    };
                    if(iCon.document.readyState === compl) {
                        const src = $i.attr("src").trim(),
                            href = iCon.location.href;
                        if(href === bl && src !== bl && src !== "") {
                            observeOnload();
                        } else {
                            callCallback();
                        }
                    } else {
                        observeOnload();
                    }
                } catch(e) { // accessing contentWindow failed
                    errorFn();
                }
            };

            var $iframe = $("iframe");
            onIframeReady($iframe, function($contents) {
                console.log("Ready to got");
                console.log($contents.find("*"));
            }, function() {
                console.log("Can not access iframe");
            });
        });
    </script>
    <iframe src="iframe.html"></iframe>
</body>
</html>

iframe.html :

<!doctype html>
<html>
<head>
    <meta charset="utf-8">
    <title>Child</title>
</head>
<body>
    <p>Lorem ipsum</p>
</body>
</html>

您还可以src将里面属性更改index.html为例如“ http://example.com/ ”。只是玩弄它。

@Crashalot 我同意令人沮丧的是,没有出现更清洁的解决方案。如果您或老兄或任何人找到更好的解决方案,请在此处添加答案并链接到它。
2021-03-16 10:09:48
这是否需要依赖于markjs.io/ 的jqueryMark 插件?我试图了解在load.jqueryMark里面听的目的observeOnload什么?我可以看到,如果 iframe 内容的 src 是“about:blank”,它将调用observeOnload并等待 jqueryMark ......但为什么是 jqueryMark?
2021-03-20 10:09:48
@WesleyMusgroveobserverOnload函数和load事件是两个不同的东西。load.jqueryMark只是一个命名空间,可以在 aload被触发后取消订阅没有必要包含 mark.js,没有依赖性。但是,我建议使用存储库中的最新代码
2021-03-30 10:09:48
这仍然是 2020 年的最佳方法吗?非常令人沮丧的是 $.ready 不能正常用于 iframe。
2021-04-06 10:09:48
@HotN 除非您安装了像 CORS 这样的浏览器扩展程序,否则无法访问来自不同来源的 iframe。因此,脚本实现了回退。
2021-04-14 10:09:48

我会使用postMessageiframe 可以分配自己的 onload 事件并发布到父级。如果存在时间问题,请确保在创建 iframe 之前分配父级的 postMessage 处理程序。

为此,iframe 必须知道父级的 url,例如通过将 GET 参数传递给 iframe。

这正是我想要避免的事情,但我同意它会起作用。
2021-03-25 10:09:48

我有同样的问题。就我而言,我只是检查了该onload函数是否被触发。

var iframe = document.getElementById("someIframe");
var loadingStatus = true;
iframe.onload = function () {
    loadingStatus = false;
    //do whatever you want [in my case I wants to trigger postMessage]
};
if (loadingStatus)
    //do whatever you want [in my case I wants to trigger postMessage]
如果在加载 iframe 之后设置 onload 处理程序,我很确定这将不起作用,这是 OP 的重点。
2021-03-21 10:09:48
@BT 是对的。onload如果 iframe 已经加载处理程序将不会触发。
2021-03-28 10:09:48

如果 iFrame 已经加载,此函数将立即运行您的回调函数,或者在运行回调函数之前等待 iFrame 完全加载。只需将要在 iFrame 加载完成时运行的回调函数和元素传递给此函数:

function iframeReady(callback, iframeElement) {
    const iframeWindow = iframeElement.contentWindow;
    if ((iframeElement.src == "about:blank" || (iframeElement.src != "about:blank" && iframeWindow.location.href != "about:blank")) && iframeWindow.document.readyState == "complete") {
        callback();
    } else {
        iframeWindow.addEventListener("load", callback);
    }
}

这将解决最常见的问题,例如 chrome 使用 about:blank 初始化 iframe 和 iFrame 不支持 DOMContentLoaded 事件。请参阅此https://stackoverflow.com/a/69694808/15757382答案以获取解释。

我非常努力地想找到一个在跨浏览器中始终有效的解决方案。重要提示:我无法找到这样的解决方案。但据我所知:

// runs a function after an iframe node's content has loaded
// note, this almost certainly won't work for frames loaded from a different domain
// secondary note - this doesn't seem to work for chrome : (
// another note - doesn't seem to work for nodes created dynamically for some reason
function onReady(iframeNode, f) {
    var windowDocument = iframeNode[0].contentWindow.document;
    var iframeDocument = windowDocument?windowDocument : iframeNode[0].contentWindow.document;

    if(iframeDocument.readyState === 'complete') {
        f();
    } else {
        iframeNode.load(function() {
            var i = setInterval(function() {
                if(iframeDocument.readyState === 'complete') {
                    f();
                    clearInterval(i);
                }
            }, 10);
        });
    }
}

我是这样使用它的:

onReady($("#theIframe"), function() {
    try {
        var context = modal[0].contentWindow;
        var i = setInterval(function() {
            if(context.Utils !== undefined && context.$) { // this mess is to attempt to get it to work in firefox
                context.$(function() {
                    var modalHeight = context.someInnerJavascript();

                    clearInterval(i);
                });
            }
        }, 10);
    } catch(e) { // ignore
        console.log(e);
    }
});

请注意,即使这样也不能解决我的问题。以下是此解决方案的一些问题:

  • 在 onReady 中,对于动态添加的 iframe, iframeDocument.readyState 似乎卡在“未初始化”状态,因此回调永远不会触发
  • 由于某种原因,整个设置似乎仍然无法在 Firefox 中工作。似乎 setInterval 函数是从外部清除的。
  • 请注意,其中一些问题仅在页面上加载大量其他内容时才会发生,这使得这些事情的时间确定性较低。

因此,如果有人可以对此进行改进,将不胜感激。

@BT 看我的回答
2021-03-29 10:09:48