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

Forms: Fix block style variations not appearing in the editor #41457

Merged
merged 3 commits into from
Feb 6, 2025

Conversation

talldan
Copy link
Contributor

@talldan talldan commented Jan 31, 2025

Fixes #41119

Proposed changes:

Fixes the form block's style variations not appearing in the editor.

The issue seems to be caused by the class names in the stylesheet being the wrong way around. They expect the element with .jetpack-contact-form to be parent of .is-style-outlined, but it's the other way around, .is-style-outlined is set on the block wrapper, and .jetpack-contact-form is an inner element.

I've fixed it by updating the CSS. I expect this needs some thorough testing, as these style may have been dormant for a while.

This could be a more radical fix that does some more restructuring to the CSS and block markup, but I think this is a good change to tread lightly with. Separately it might be worth reconsidering a lot of the CSS for the form block. It should be possible to make the editor styles more closely match the front-end markup and not require so much duplication, but then I don't know much of the history of this block.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  1. Add a contact form block.
  2. Ensure the contact form block is selected, and from the block inspector select the 'Styles' tab and choose either the 'Animated' or 'Outlined' block styles
  3. Observe that the block style visually updates in the editor to match the frontend. In trunk it doesn't change.

@talldan talldan added [Type] Bug When a feature is broken and / or not performing as intended [Feature] Contact Form [Status] Needs Team Review Obsolete. Use Needs Review instead. [Block] Contact Form Form block (also see Contact Form label) [Package] Forms [Feature] Forms Blocks Blocks designed to streamline user input and engagement, such as contact, newsletter sign-ups, etc. labels Jan 31, 2025
@talldan talldan self-assigned this Jan 31, 2025
Copy link
Contributor

github-actions bot commented Jan 31, 2025

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/form-style-variations-in-editor branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/form-style-variations-in-editor
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Jan 31, 2025
Copy link
Contributor

github-actions bot commented Jan 31, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for none scheduled (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Copy link
Contributor

github-actions bot commented Jan 31, 2025

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

@talldan talldan force-pushed the fix/form-style-variations-in-editor branch from 2b37f00 to 2d698a5 Compare February 3, 2025 08:03
Copy link
Member

@ramonjd ramonjd left a comment

Choose a reason for hiding this comment

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

Great stuff. Works as described. Here are some gifs for you!

Before

2025-02-04 17 28 52

After

2025-02-04 17 29 29

ramonjd
ramonjd previously approved these changes Feb 4, 2025
@talldan talldan force-pushed the fix/form-style-variations-in-editor branch from 2d698a5 to 7560231 Compare February 5, 2025 07:39
@talldan
Copy link
Contributor Author

talldan commented Feb 5, 2025

After further testing, I spotted an issue with Single & Multiple Choice fields when the Outlined style is applied. Pushed a commit to fix it.

Before - the field is too wide and the checkboxes overflow

Screenshot 2025-02-05 at 3 40 27 pm

After - looks pretty good

Screenshot 2025-02-05 at 3 42 00 pm

@ramonjd
Copy link
Member

ramonjd commented Feb 5, 2025

Kapture.2025-02-06.at.10.39.54.mp4

LGTM

@talldan talldan merged commit 7f8563c into trunk Feb 6, 2025
64 checks passed
@talldan talldan deleted the fix/form-style-variations-in-editor branch February 6, 2025 01:52
@github-actions github-actions bot removed the [Status] Needs Team Review Obsolete. Use Needs Review instead. label Feb 6, 2025
@zinigor zinigor added this to the jetpack/14.4 milestone Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Contact Form Form block (also see Contact Form label) [Feature] Contact Form [Feature] Forms Blocks Blocks designed to streamline user input and engagement, such as contact, newsletter sign-ups, etc. [Package] Forms [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Forms: improve styles naming and preview
3 participants