Ghost/ghost/admin/app/components/gh-site-iframe.js
Kevin Ansfield b8e6107c6a Fixed portal previews flashing background (#1975)
refs https://github.com/TryGhost/Team/issues/701
requires Portal@1.4.2 or later

- changed `<GhSiteIframe @invisibleUntilLoaded>` to accept a string in place of a `true/false` value
    - if a string is passed then we'll set up a message event listener than listens for a `postMessage` from the iframe with data that matches the supplied string
- updated `<GhSiteIframe>` usage for portal previews to use `@invisibleUntilLoaded="portal-ready"` so they listen for a message event rather than displaying as soon as we get a load event
2021-05-24 14:03:08 +01:00

78 lines
2.5 KiB
JavaScript

import Component from '@glimmer/component';
import {action} from '@ember/object';
import {inject as service} from '@ember/service';
import {task} from 'ember-concurrency-decorators';
import {timeout} from 'ember-concurrency';
import {tracked} from '@glimmer/tracking';
export default class GhSiteIframeComponent extends Component {
@service config;
@tracked isInvisible = this.args.invisibleUntilLoaded;
willDestroy() {
if (this.messageListener) {
window.removeEventListener('message', this.messageListener);
}
this.args.onDestroyed?.();
}
get srcUrl() {
return this.args.src || `${this.config.get('blogUrl')}/`;
}
@action
resetSrcAttribute(iframe) {
// reset the src attribute and force reload each time the guid changes
// - allows for a click on the navigation item to reset back to the homepage
// or a portal preview modal to force a reload so it can fetch server-side data
if (this.args.guid !== this._lastGuid) {
if (iframe) {
if (this.args.invisibleUntilLoaded) {
this.isInvisible = true;
}
if (iframe.contentWindow.location.href !== this.srcUrl) {
iframe.contentWindow.location = this.srcUrl;
} else {
iframe.contentWindow.location.reload();
}
}
}
this._lastGuid = this.args.guid;
}
@action
onLoad(event) {
if (this.args.invisibleUntilLoaded && typeof this.args.invisibleUntilLoaded === 'boolean') {
this.makeVisible.perform();
}
this.args.onLoad?.(event);
}
@action
attachMessageListener() {
if (typeof this.args.invisibleUntilLoaded === 'string') {
this.messageListener = (event) => {
const srcURL = new URL(this.srcUrl);
const originURL = new URL(event.origin);
if (originURL.origin === srcURL.origin) {
if (event.data === this.args.invisibleUntilLoaded) {
this.makeVisible.perform();
}
}
};
window.addEventListener('message', this.messageListener, true);
}
}
@task
*makeVisible() {
// give any scripts a bit of time to render before making visible
// allows portal to render it's overlay and prevent site background flashes
yield timeout(100);
this.isInvisible = false;
}
}