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

Elements: Avoid specificity bump for top-level element-only selectors #7012

Conversation

aaronrobertshaw
Copy link

@aaronrobertshaw aaronrobertshaw commented Jul 11, 2024

This PR backports the PHP changes from WordPress/gutenberg#63403

These changes prevent issues caused by a bump in CSS specificity for top-level element-only global element styles. See the linked PR and original issue for further details.

Trac ticket: https://core.trac.wordpress.org/ticket/61630
Trac ticket: https://core.trac.wordpress.org/ticket/61660

Testing Instructions

Please note: JS package updates are required for the issue to be resolved in the editor. When testing, make the relevant changes in the editor and then confirm correct styles on the frontend

  1. Edit a page via the site editor and add a test nav structure/markup using custom HTML block
<header>
  <nav>
     <ul>
       <li>
         <a>Test Link</a>
       </li>
     </ul>
  </nav>
</header>
  1. Test custom global element styles including hover styles; Global Styles > Colors > Link
  2. Add custom css using element only selector header nav ul li a. You'll need to toggle the custom HTML block preview for it to pick up the custom CSS.
header nav ul li a {
    color: red;
    text-decoration: none;
}
  1. Test global block type element styles; Global Styles > Blocks > Group > Elements > Link
  2. Test element style overrides on block instances
  3. Define multiple block style variations that define both styles.elements and styles.blocks.core/group.elements.link styles. The following snippets can be used to create theme.json partial files within the theme's /styles directory which will then be registered as block style variations.
Example Block Style Variation Partials
{
	"$schema": "https://schemas.wp.org/trunk/theme.json",
	"version": 3,
	"title": "Custom Links",
	"slug": "custom-links",
	"blockTypes": [ "core/group" ],
	"styles": {
		"elements": {
			"link": {
				"color": {
					"text": "crimson"
				},
				":hover": {
					"color": {
						"text": "darkmagenta"
					}
				}
			},
			"button": {
				"color": {
					"background": "purple",
					"text": "white"
				},
				":hover": {
					"color": {
						"background": "darkorchid"
					}
				}
			}
		},
		"blocks": {
			"core/group": {
				"elements": {
					"link": {
						"color": {
							"text": "dodgerblue"
						},
						":hover": {
							"color": {
								"text": "darkseagreen"
							}
						}
					},
					"heading": {
						"color": {
							"text": "teal"
						}
					}
				}
			}
		}
	}
}

{
	"$schema": "https://schemas.wp.org/trunk/theme.json",
	"version": 3,
	"title": "Alt Links",
	"slug": "alt-links",
	"blockTypes": [ "core/group" ],
	"styles": {
		"elements": {
			"link": {
				"color": {
					"text": "green"
				},
				":hover": {
					"color": {
						"text": "lime"
					}
				}
			}
		},
		"blocks": {
			"core/group": {
				"elements": {
					"link": {
						"color": {
							"text": "coral"
						},
						":hover": {
							"color": {
								"text": "brown"
							}
						}
					}
				}
			}
		}
	}
}


  1. Ensure the block style variation element styles are capped at 0-1-0 specificity
  2. Test nesting block style variations and that the correct element styles are applied
  3. Ensure block instance element style override the block style variation's element styles
  4. Give other elements e.g. heading and cite a test, they should not have their selectors wrapped unless the style includes a pseudo selector
  5. Give button and caption a run as well. Their selectors should be wrapped in :root :where() at all times.

Screenshots

Before After
Screenshot 2024-07-11 at 5 39 59 PM Screenshot 2024-07-11 at 5 35 21 PM

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Copy link

github-actions bot commented Jul 11, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props aaronrobertshaw, andrewserong, noisysocks.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link
Contributor

@andrewserong andrewserong left a comment

Choose a reason for hiding this comment

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

This is testing well for me. At first I ran into a bug that turns out is unrelated to this change, and has a POC fix over in #7017. With that applied locally, the testing steps are working nicely for me on the site frontend, and the code change matches what merged in Gutenberg over in WordPress/gutenberg#63403

@noisysocks
Copy link
Member

Applied the diff of this PR to the 6.6 branch and followed the testing instructions. Looks ok 👍

@noisysocks
Copy link
Member

noisysocks commented Jul 18, 2024

Committed to trunk in r58749 and re-opened https://core.trac.wordpress.org/ticket/61660 to request backport to 6.6 branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants