/** * Resize detection strategy that injects objects to elements in order to detect resize events. * Heavily inspired by: http://www.backalleycoder.com/2013/03/18/cross-browser-event-based-element-resize-detection/ */ "use strict"; var browserDetector = require("../browser-detector"); module.exports = function(options) { options = options || {}; var reporter = options.reporter; var batchProcessor = options.batchProcessor; var getState = options.stateHandler.getState; if(!reporter) { throw new Error("Missing required dependency: reporter."); } /** * Adds a resize event listener to the element. * @public * @param {element} element The element that should have the listener added. * @param {function} listener The listener callback to be called for each resize event of the element. The element will be given as a parameter to the listener callback. */ function addListener(element, listener) { function listenerProxy() { listener(element); } if(browserDetector.isIE(8)) { //IE 8 does not support object, but supports the resize event directly on elements. getState(element).object = { proxy: listenerProxy }; element.attachEvent("onresize", listenerProxy); } else { var object = getObject(element); if(!object) { throw new Error("Element is not detectable by this strategy."); } object.contentDocument.defaultView.addEventListener("resize", listenerProxy); } } function buildCssTextString(rules) { var seperator = options.important ? " !important; " : "; "; return (rules.join(seperator) + seperator).trim(); } /** * Makes an element detectable and ready to be listened for resize events. Will call the callback when the element is ready to be listened for resize changes. * @private * @param {object} options Optional options object. * @param {element} element The element to make detectable * @param {function} callback The callback to be called when the element is ready to be listened for resize changes. Will be called with the element as first parameter. */ function makeDetectable(options, element, callback) { if (!callback) { callback = element; element = options; options = null; } options = options || {}; var debug = options.debug; function injectObject(element, callback) { var OBJECT_STYLE = buildCssTextString(["display: block", "position: absolute", "top: 0", "left: 0", "width: 100%", "height: 100%", "border: none", "padding: 0", "margin: 0", "opacity: 0", "z-index: -1000", "pointer-events: none"]); //The target element needs to be positioned (everything except static) so the absolute positioned object will be positioned relative to the target element. // Position altering may be performed directly or on object load, depending on if style resolution is possible directly or not. var positionCheckPerformed = false; // The element may not yet be attached to the DOM, and therefore the style object may be empty in some browsers. // Since the style object is a reference, it will be updated as soon as the element is attached to the DOM. var style = window.getComputedStyle(element); var width = element.offsetWidth; var height = element.offsetHeight; getState(element).startSize = { width: width, height: height }; function mutateDom() { function alterPositionStyles() { if(style.position === "static") { element.style.setProperty("position", "relative", options.important ? "important" : ""); var removeRelativeStyles = function(reporter, element, style, property) { function getNumericalValue(value) { return value.replace(/[^-\d\.]/g, ""); } var value = style[property]; if(value !== "auto" && getNumericalValue(value) !== "0") { reporter.warn("An element that is positioned static has style." + property + "=" + value + " which is ignored due to the static positioning. The element will need to be positioned relative, so the style." + property + " will be set to 0. Element: ", element); element.style.setProperty(property, "0", options.important ? "important" : ""); } }; //Check so that there are no accidental styles that will make the element styled differently now that is is relative. //If there are any, set them to 0 (this should be okay with the user since the style properties did nothing before [since the element was positioned static] anyway). removeRelativeStyles(reporter, element, style, "top"); removeRelativeStyles(reporter, element, style, "right"); removeRelativeStyles(reporter, element, style, "bottom"); removeRelativeStyles(reporter, element, style, "left"); } } function onObjectLoad() { // The object has been loaded, which means that the element now is guaranteed to be attached to the DOM. if (!positionCheckPerformed) { alterPositionStyles(); } /*jshint validthis: true */ function getDocument(element, callback) { //Opera 12 seem to call the object.onload before the actual document has been created. //So if it is not present, poll it with an timeout until it is present. //TODO: Could maybe be handled better with object.onreadystatechange or similar. if(!element.contentDocument) { var state = getState(element); if (state.checkForObjectDocumentTimeoutId) { window.clearTimeout(state.checkForObjectDocumentTimeoutId); } state.checkForObjectDocumentTimeoutId = setTimeout(function checkForObjectDocument() { state.checkForObjectDocumentTimeoutId = 0; getDocument(element, callback); }, 100); return; } callback(element.contentDocument); } //Mutating the object element here seems to fire another load event. //Mutating the inner document of the object element is fine though. var objectElement = this; //Create the style element to be added to the object. getDocument(objectElement, function onObjectDocumentReady(objectDocument) { //Notify that the element is ready to be listened to. callback(element); }); } // The element may be detached from the DOM, and some browsers does not support style resolving of detached elements. // The alterPositionStyles needs to be delayed until we know the element has been attached to the DOM (which we are sure of when the onObjectLoad has been fired), if style resolution is not possible. if (style.position !== "") { alterPositionStyles(style); positionCheckPerformed = true; } //Add an object element as a child to the target element that will be listened to for resize events. var object = document.createElement("object"); object.style.cssText = OBJECT_STYLE; object.tabIndex = -1; object.type = "text/html"; object.setAttribute("aria-hidden", "true"); object.onload = onObjectLoad; //Safari: This must occur before adding the object to the DOM. //IE: Does not like that this happens before, even if it is also added after. if(!browserDetector.isIE()) { object.data = "about:blank"; } if (!getState(element)) { // The element has been uninstalled before the actual loading happened. return; } element.appendChild(object); getState(element).object = object; //IE: This must occur after adding the object to the DOM. if(browserDetector.isIE()) { object.data = "about:blank"; } } if(batchProcessor) { batchProcessor.add(mutateDom); } else { mutateDom(); } } if(browserDetector.isIE(8)) { //IE 8 does not support objects properly. Luckily they do support the resize event. //So do not inject the object and notify that the element is already ready to be listened to. //The event handler for the resize event is attached in the utils.addListener instead. callback(element); } else { injectObject(element, callback); } } /** * Returns the child object of the target element. * @private * @param {element} element The target element. * @returns The object element of the target. */ function getObject(element) { return getState(element).object; } function uninstall(element) { if (!getState(element)) { return; } var object = getObject(element); if (!object) { return; } if (browserDetector.isIE(8)) { element.detachEvent("onresize", object.proxy); } else { element.removeChild(object); } if (getState(element).checkForObjectDocumentTimeoutId) { window.clearTimeout(getState(element).checkForObjectDocumentTimeoutId); } delete getState(element).object; } return { makeDetectable: makeDetectable, addListener: addListener, uninstall: uninstall }; };