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.

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

Enqueue global styles in editor only once #32377

Merged
merged 3 commits into from
Jun 8, 2021

Conversation

oandregal
Copy link
Member

@oandregal oandregal commented Jun 1, 2021

Follow-up to #32372

This relies on a core change WordPress/wordpress-develop#1326 to remove the styles that come from WordPress core before adding the styles from the plugin.

@oandregal oandregal requested a review from spacedmonkey as a code owner June 1, 2021 15:51
@oandregal oandregal self-assigned this Jun 1, 2021
@oandregal oandregal added the Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json label Jun 1, 2021
@oandregal oandregal added the [Type] Code Quality Issues or PRs that relate to code quality label Jun 1, 2021
Copy link
Member

@aristath aristath left a comment

Choose a reason for hiding this comment

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

LGTM 👍
This can be merged once WordPress/wordpress-develop#1326 lands in core 🚢

@oandregal
Copy link
Member Author

The core PR related to this just landed, so I'm commiting this one.

@oandregal oandregal merged commit dbb195d into trunk Jun 8, 2021
@oandregal oandregal deleted the update/editor-styles-with-5-8 branch June 8, 2021 08:23
@github-actions github-actions bot added this to the Gutenberg 10.9 milestone Jun 8, 2021
@@ -130,6 +130,14 @@ function_exists( 'gutenberg_is_edit_site_page' ) &&
'__experimentalNoWrapper' => true,
);

// Reset existing global styles.
foreach ( $settings['styles'] as $key => $style ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

@nosolosw Should $settings['styles'] always be defined before this line? This throws an error in the navigation editor which doesn't have a style setting beforehand, but still calls the gutenberg_experimental_global_styles_settings function.

Not entirely sure what the right way to solve that is, so any advice would be appreciated.

Copy link
Member Author

Choose a reason for hiding this comment

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

Dan, I've prepared #33127

But now I'm wondering if I understood the issue correctly: did you mean that the global styles shouldn't be present in the navigation editor either?

Copy link
Member Author

Choose a reason for hiding this comment

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

If that's the case, we may want to change the logic of this function to:

if ( 'mobile' === context ) { /* extra data for mobile */ } 
if ( 'site-editor' === context ) { /* extra data for site editor */ } 
if ( 'post-editor' === context ) { /* extra data for post editor */ } 

// editor settings for all: mobile, site-editor, post-editor, navigation-editor, etc.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that fix is correct as a defensive measure. One can't guarantee that the key will always be there so let's check for that.

Copy link
Contributor

Choose a reason for hiding this comment

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

But now I'm wondering if I understood the issue correctly: did you mean that the global styles shouldn't be present in the navigation editor either?

I'm not really sure on an answer for that right now. The navigation editor needs to evolve a bit. Probably in the basic mode the navigation editor doesn't need it, but there's an option for themes to opt in to some more advanced block features, and it might be an option for global styles to work in that case.

This fix works as an interim, so thank you! 👍

// Reset existing global styles.
foreach ( $settings['styles'] as $key => $style ) {
if ( isset( $style['__unstableType'] ) && 'globalStyles' === $style['__unstableType'] ) {
unset( $settings['styles'][ $key ] );
Copy link
Contributor

Choose a reason for hiding this comment

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

The problem with "unset" is that the "styles" will become an object instead of an array when passing to JS, which could have some unintended side effects. I'm fixing that here eea9799

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants