Skip to content

Fix Block Editor Iframe component to render in standards mode #38855

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

Merged
gziolo merged 7 commits into from
Mar 24, 2022
Merged

Fix Block Editor Iframe component to render in standards mode #38855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2d557d5
fix Block Editor Iframe component to render in standards mode
tomasztunik Feb 16, 2022
c74edb6
Tests validating site editor's iframe rendering mode
tomasztunik Feb 17, 2022
512fa24
restart CI after flaky test failure
tomasztunik Feb 25, 2022
d953032
Solve the issue with srcDoc rather than document.write
tomasztunik Mar 8, 2022
271485d
Clean up the iframe srcDoc
tomasztunik Mar 8, 2022
552ac83
Simplify the code based on findings
tomasztunik Mar 8, 2022
1473350
cleanup + ensure we unbind the event
tomasztunik Mar 9, 2022
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
12 changes: 5 additions & 7 deletions packages/block-editor/src/components/iframe/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,14 +203,10 @@ function Iframe(
return true;
}

if ( setDocumentIfReady() ) {
return;
}
// Document set with srcDoc is not immediately ready.
node.addEventListener( 'load', setDocumentIfReady );

// Document is not immediately loaded in Firefox.
node.addEventListener( 'load', () => {
setDocumentIfReady();
} );
return () => node.removeEventListener( 'load', setDocumentIfReady );
}, [] );
const headRef = useRefEffect( ( element ) => {
scripts
Expand Down Expand Up @@ -264,6 +260,8 @@ function Iframe(
{ ...props }
ref={ useMergeRefs( [ ref, setRef ] ) }
tabIndex={ tabIndex }
// Correct doctype is required to enable rendering in standards mode
srcDoc="<!doctype html>"
title={ __( 'Editor canvas' ) }
>
{ iframeDocument &&
Expand Down
31 changes: 31 additions & 0 deletions packages/e2e-tests/specs/site-editor/iframe-rendering-mode.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/**
* WordPress dependencies
*/
import { activateTheme, visitSiteEditor } from '@wordpress/e2e-test-utils';

describe( 'Site editor iframe rendering mode', () => {
beforeAll( async () => {
await activateTheme( 'emptytheme' );
} );

afterAll( async () => {
await activateTheme( 'twentytwentyone' );
} );

it( 'Should render editor in standards mode.', async () => {
await visitSiteEditor( {
postId: 'emptytheme//index',
postType: 'wp_template',
} );

const compatMode = await page.evaluate(
() =>
document.querySelector( `iframe[name='editor-canvas']` )
.contentDocument.compatMode
);

// CSS1Compat = expected standards mode.
// BackCompat = quirks mode.
expect( compatMode ).toBe( 'CSS1Compat' );
} );
} );