Skip to content
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

Preview popup loader #3157

Merged
merged 9 commits into from
Nov 1, 2017
Merged

Preview popup loader #3157

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
533da25
Added test for Preview popup document.write
Oct 23, 2017
27b7f83
Render a loader in the Preview popup
Oct 23, 2017
6a06fd4
Added minimal styling to popup preview
Oct 25, 2017
1b37e12
Remove React.renderToString()
Oct 27, 2017
51ef53d
Remove <style> type; call document.close()
Oct 27, 2017
69e07e3
Use flexbox; change HTML/CSS string format
Oct 27, 2017
52f6d22
Combine html & css variables
Oct 27, 2017
76acdc5
Mock document.close() in test
Oct 27, 2017
739880a
Styled preview popup text
jack-lewin Oct 30, 2017
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: 11 additions & 1 deletion editor/header/preview-button/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { connect } from 'react-redux';
/**
* WordPress dependencies
*/
import { Component } from '@wordpress/element';
import { Component, renderToString } from '@wordpress/element';
import { IconButton } from '@wordpress/components';
import { _x } from '@wordpress/i18n';

Expand Down Expand Up @@ -73,6 +73,16 @@ export class PreviewButton extends Component {
'about:blank',
this.getWindowTarget()
);

const popupLoader = renderToString(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly seems like we could get away with just creating a string of HTML instead of using React to convert an element to string, particularly if we're separately creating a style tag anyways (which could itself be represented as an element).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good shout - I was only doing this because I'd originally used the <Spinner /> component. No longer necessary 🙂

<div>
<p>Please wait&hellip;</p>
<p>Generating preview.</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to translate this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #3301

</div>
);
const css = '<style type="text/css"> div { margin-top: 25%; } p { text-align: center; } </style>';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the intention that this be centered? Seems like flexbox might serve better, if so.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

type="text/css" is not necessary since it is the default:

This attribute is optional and defaults to text/css if it's missing.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/style

this.previewWindow.document.write( css );
this.previewWindow.document.write( popupLoader );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs for document.write encourage calling document.close after writing has completed:

Once you have finished writing, it is recommended to call document.close() to tell the browser to finish loading the page.

https://developer.mozilla.org/en-US/docs/Web/API/Document/write#Notes

}

render() {
Expand Down
9 changes: 8 additions & 1 deletion editor/header/preview-button/test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,13 @@ describe( 'PreviewButton', () => {
const autosave = jest.fn();
const preventDefault = jest.fn();
const windowOpen = window.open;
window.open = jest.fn();
window.open = jest.fn( () => {
return {
document: {
write: jest.fn(),
},
};
} );

const wrapper = shallow(
<PreviewButton { ...props } autosave={ autosave } />
Expand All @@ -66,6 +72,7 @@ describe( 'PreviewButton', () => {
expect( preventDefault ).toHaveBeenCalled();
expect( wrapper.state( 'isAwaitingSave' ) ).toBe( true );
expect( window.open ).toHaveBeenCalled();
expect( wrapper.instance().previewWindow.document.write ).toHaveBeenCalled();
} else {
expect( autosave ).not.toHaveBeenCalled();
expect( preventDefault ).not.toHaveBeenCalled();
Expand Down