-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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.
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
Full site editor: load content in iframe #25775
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,189 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import mergeRefs from 'react-merge-refs'; | ||
|
||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { | ||
useState, | ||
createPortal, | ||
useCallback, | ||
forwardRef, | ||
} from '@wordpress/element'; | ||
import { __ } from '@wordpress/i18n'; | ||
|
||
const BODY_CLASS_NAME = 'editor-styles-wrapper'; | ||
const BLOCK_PREFIX = 'wp-block'; | ||
|
||
/** | ||
* Clones stylesheets targetting the editor canvas to the given document. A | ||
* stylesheet is considered targetting the editor a canvas if it contains the | ||
* `editor-styles-wrapper`, `wp-block`, or `wp-block-*` class selectors. | ||
* | ||
* Ideally, this hook should be removed in the future and styles should be added | ||
* explicitly as editor styles. | ||
* | ||
* @param {Document} doc The document to append cloned stylesheets to. | ||
*/ | ||
function styleSheetsCompat( doc ) { | ||
// Search the document for stylesheets targetting the editor canvas. | ||
Array.from( document.styleSheets ).forEach( ( styleSheet ) => { | ||
try { | ||
// May fail for external styles. | ||
// eslint-disable-next-line no-unused-expressions | ||
styleSheet.cssRules; | ||
} catch ( e ) { | ||
return; | ||
} | ||
|
||
const { ownerNode, cssRules } = styleSheet; | ||
|
||
if ( ! cssRules ) { | ||
return; | ||
} | ||
|
||
const isMatch = Array.from( cssRules ).find( | ||
( { selectorText } ) => | ||
selectorText && | ||
( selectorText.includes( `.${ BODY_CLASS_NAME }` ) || | ||
selectorText.includes( `.${ BLOCK_PREFIX }` ) ) | ||
); | ||
|
||
if ( isMatch && ! doc.getElementById( ownerNode.id ) ) { | ||
doc.head.appendChild( ownerNode.cloneNode( true ) ); | ||
} | ||
} ); | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this meant for stylesheets from themes and plugins not using the "official" editor styles way of enqueuing things? Should we add a deprecated call when we find one of these? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's correct! We could do that, yes. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's still some of our own stylesheets left as well. Maybe we should attempt this in a follow-up? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes, definitely, what are our own stylesheets that fall here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In the case of the site editor (I need to check for the post editor, but I think there are several), it's the .wp-block {
max-width: 840px;
}
.wp-block[data-align=wide] {
max-width: 1100px;
}
.wp-block[data-align=full] {
max-width: none;
} It seems that there styles need to more in some sort of default stylesheet. They don't belong in the package I think. |
||
|
||
/** | ||
* Bubbles some event types (keydown, keypress, and dragover) to parent document | ||
* document to ensure that the keyboard shortcuts and drag and drop work. | ||
* | ||
* Ideally, we should remove event bubbling in the future. Keyboard shortcuts | ||
* should be context dependent, e.g. actions on blocks like Cmd+A should not | ||
* work globally outside the block editor. | ||
* | ||
* @param {Document} doc Document to attach listeners to. | ||
*/ | ||
function bubbleEvents( doc ) { | ||
const { defaultView } = doc; | ||
const { frameElement } = defaultView; | ||
|
||
function bubbleEvent( event ) { | ||
const prototype = Object.getPrototypeOf( event ); | ||
const constructorName = prototype.constructor.name; | ||
const Constructor = window[ constructorName ]; | ||
|
||
const init = {}; | ||
|
||
for ( const key in event ) { | ||
init[ key ] = event[ key ]; | ||
} | ||
|
||
if ( event instanceof defaultView.MouseEvent ) { | ||
const rect = frameElement.getBoundingClientRect(); | ||
init.clientX += rect.left; | ||
init.clientY += rect.top; | ||
} | ||
|
||
const newEvent = new Constructor( event.type, init ); | ||
const cancelled = ! frameElement.dispatchEvent( newEvent ); | ||
|
||
if ( cancelled ) { | ||
event.preventDefault(); | ||
} | ||
} | ||
|
||
const eventTypes = [ 'keydown', 'keypress', 'dragover' ]; | ||
|
||
for ( const name of eventTypes ) { | ||
doc.addEventListener( name, bubbleEvent ); | ||
} | ||
} | ||
|
||
/** | ||
* Sets the document direction. | ||
* | ||
* Sets the `editor-styles-wrapper` class name on the body. | ||
* | ||
* Copies the `admin-color-*` class name to the body so that the admin color | ||
* scheme applies to components in the iframe. | ||
* | ||
* @param {Document} doc Document to add class name to. | ||
*/ | ||
function setBodyClassName( doc ) { | ||
doc.dir = document.dir; | ||
doc.body.className = BODY_CLASS_NAME; | ||
|
||
for ( const name of document.body.classList ) { | ||
if ( name.startsWith( 'admin-color-' ) ) { | ||
doc.body.classList.add( name ); | ||
} | ||
} | ||
} | ||
|
||
/** | ||
* Sets the document head and default styles. | ||
* | ||
* @param {Document} doc Document to set the head for. | ||
* @param {string} head HTML to set as the head. | ||
*/ | ||
function setHead( doc, head ) { | ||
doc.head.innerHTML = | ||
// Body margin must be overridable by themes. | ||
'<style>body{margin:0}</style>' + head; | ||
} | ||
|
||
function Iframe( { contentRef, children, head, ...props }, ref ) { | ||
const [ iframeDocument, setIframeDocument ] = useState(); | ||
|
||
const setRef = useCallback( ( node ) => { | ||
if ( ! node ) { | ||
return; | ||
} | ||
|
||
function setDocumentIfReady() { | ||
const { contentDocument } = node; | ||
const { readyState } = contentDocument; | ||
|
||
if ( readyState !== 'interactive' && readyState !== 'complete' ) { | ||
return false; | ||
} | ||
|
||
setIframeDocument( contentDocument ); | ||
setHead( contentDocument, head ); | ||
setBodyClassName( contentDocument ); | ||
styleSheetsCompat( contentDocument ); | ||
bubbleEvents( contentDocument ); | ||
setBodyClassName( contentDocument ); | ||
contentRef.current = contentDocument.body; | ||
|
||
return true; | ||
} | ||
|
||
if ( setDocumentIfReady() ) { | ||
return; | ||
} | ||
|
||
// Document is not immediately loaded in Firefox. | ||
node.addEventListener( 'load', () => { | ||
setDocumentIfReady(); | ||
} ); | ||
}, [] ); | ||
|
||
return ( | ||
<iframe | ||
{ ...props } | ||
ref={ useCallback( mergeRefs( [ ref, setRef ] ), [] ) } | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm pretty sure, the useCallback here is useless. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's not, see #27686. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Interesting :) |
||
tabIndex="0" | ||
title={ __( 'Editor canvas' ) } | ||
name="editor-canvas" | ||
> | ||
{ iframeDocument && createPortal( children, iframeDocument.body ) } | ||
</iframe> | ||
); | ||
} | ||
|
||
export default forwardRef( Iframe ); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a better to do that without the new variable. Maybe by just reusing the "styles" property in the editor settings?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I can look into that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to do this, but the styles are not available yet at the time when the editor scripts are registered.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was not suggesting at the script registration, I was more suggesting
block_editor_settings
filter for post editor andgutenberg_edit_site_init
for the site editor.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's what I mean. The
block_editor_settings
filter is run at script registration, which is too early. The settings are passed as an inline script initialising the editor.