Skip to content

Fix legacy widget height overflow #33191

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
kevin940726 merged 6 commits into from
Jul 5, 2021
Merged

Fix legacy widget height overflow #33191

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ea170cc
Fix legacy widget height overflow
kevin940726 Jul 5, 2021
fdbd6a3
Rename to setHeight
kevin940726 Jul 5, 2021
b623e56
Only set height after iframe is loaded
kevin940726 Jul 5, 2021
48a5b4e
Set overflow to hidden
kevin940726 Jul 5, 2021
6b8c5db
Use max
kevin940726 Jul 5, 2021
07d3cf0
Remove try catch
kevin940726 Jul 5, 2021
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
82 changes: 55 additions & 27 deletions packages/widgets/src/blocks/legacy-widget/edit/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,36 +13,54 @@ import { Placeholder, Spinner, Disabled } from '@wordpress/components';
import { __ } from '@wordpress/i18n';

export default function Preview( { idBase, instance, isVisible } ) {
const [ iframeHeight, setIframeHeight ] = useState();
const [ isLoaded, setIsLoaded ] = useState( false );

// Resize the iframe on either the load event, or when the iframe becomes visible.
const ref = useRefEffect( ( iframe ) => {
function onChange() {
const boundingRect = iframe?.contentDocument?.body?.getBoundingClientRect();
if ( boundingRect ) {
// Include `top` in the height calculation to avoid the bottom
// of widget previews being cut-off. Most widgets have a
// heading at the top that has top margin, and the `height`
// alone doesn't take that margin into account.
setIframeHeight( boundingRect.top + boundingRect.height );
}
}
const ref = useRefEffect(
( iframe ) => {
// Only set height if the iframe is loaded,
// or it will grow to an unexpected large height in Safari if it's hidden initially.
if ( isLoaded ) {
// If the preview frame has another origin then this won't work.
// One possible solution is to add custom script to call `postMessage` in the preview frame.
// Or, better yet, we migrate away from iframe.
function setHeight() {
// Pick the maximum of these two values to account for margin collapsing.
const height = Math.max(
iframe.contentDocument.documentElement.offsetHeight,
iframe.contentDocument.body.offsetHeight
);
iframe.style.height = `${ height }px`;
}

const { IntersectionObserver } = iframe.ownerDocument.defaultView;
const {
IntersectionObserver,
} = iframe.ownerDocument.defaultView;

// Observe for intersections that might cause a change in the height of
// the iframe, e.g. a Widget Area becoming expanded.
const intersectionObserver = new IntersectionObserver( onChange, {
threshold: 1,
} );
intersectionObserver.observe( iframe );
// Observe for intersections that might cause a change in the height of
// the iframe, e.g. a Widget Area becoming expanded.
const intersectionObserver = new IntersectionObserver(
( [ entry ] ) => {
if ( entry.isIntersecting ) {
setHeight();
}
},
{
threshold: 1,
}
);
intersectionObserver.observe( iframe );

iframe.addEventListener( 'load', onChange );
iframe.addEventListener( 'load', setHeight );

return () => {
iframe.removeEventListener( 'load', onChange );
};
}, [] );
return () => {
intersectionObserver.disconnect();
iframe.removeEventListener( 'load', setHeight );
};
}
},
[ isLoaded ]
);

return (
<>
Expand All @@ -53,7 +71,7 @@ export default function Preview( { idBase, instance, isVisible } ) {
move the iframe off-screen instead of hiding it because web browsers
will not trigger onLoad if the iframe is hidden.
*/ }
{ isVisible && iframeHeight === null && (
{ isVisible && ! isLoaded && (
<Placeholder>
<Spinner />
</Placeholder>
Expand All @@ -62,7 +80,7 @@ export default function Preview( { idBase, instance, isVisible } ) {
className={ classnames(
'wp-block-legacy-widget__edit-preview',
{
'is-offscreen': ! isVisible || iframeHeight === null,
'is-offscreen': ! isVisible || ! isLoaded,
}
) }
>
Expand All @@ -84,7 +102,17 @@ export default function Preview( { idBase, instance, isVisible } ) {
instance,
},
} ) }
height={ iframeHeight || 100 }
onLoad={ ( event ) => {
// To hide the scrollbars of the preview frame for some edge cases,
// such as negative margins in the Gallery Legacy Widget.
// It can't be scrolled anyway.
// TODO: Ideally, this should be fixed in core.
event.target.contentDocument.body.style.overflow =
'hidden';

setIsLoaded( true );
} }
height={ 100 }
/>
</Disabled>
</div>
Expand Down