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 field widths and spacing in the editor #41415

Merged
merged 4 commits into from
Jan 30, 2025
Merged

Conversation

talldan
Copy link
Contributor

@talldan talldan commented Jan 30, 2025

Fixes #41414

Proposed changes:

The previously merged PR #41348, seems to have broken the form styles in the editor.

Lots of the styles target the .block-editor-inner-blocks classname, which is no longer present after the switch to useInnerBlocksProps.

The block's styles shouldn't really be targeting the block editor's own internal class names, and instead add its own class names (jetpack-form-inner-blocks), but this PR is a quick fix to get things working again rather than a full refactor.

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?

Testing instructions:

  1. Add a contact form in the editor
  2. Set two neighbouring fields to 50% or 75/25 so that they're on the same row.
  3. The forms should visually update their size (in trunk they stay at 100%)
  4. Also note the fields have padding between them, in trunk they're very close together.

@talldan talldan added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Team Review [Package] Forms [Feature] Forms Blocks Blocks designed to streamline user input and engagement, such as contact, newsletter sign-ups, etc. labels Jan 30, 2025
@talldan talldan self-assigned this Jan 30, 2025
Copy link
Contributor

github-actions bot commented Jan 30, 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-field-widths branch.

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

    bin/jetpack-downloader test jetpack fix/form-field-widths
    

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 [Block] Contact Form Form block (also see Contact Form label) [Feature] Contact Form [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Jan 30, 2025
Copy link
Contributor

github-actions bot commented Jan 30, 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 February 4, 2025 (scheduled code freeze on February 4, 2025).

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

Comment on lines -580 to -590
// Overrides to make the preview look good
.block-editor-inserter__preview {
.jetpack-contact-form {
padding: 16px;

.block-editor-inner-blocks .block-editor-block-list__layout {
margin: 0;
}
}
}

Copy link
Contributor Author

@talldan talldan Jan 30, 2025

Choose a reason for hiding this comment

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

I'm not sure what this does, so I removed it (I like deleting stuff). The preview styles look ok to me, and I couldn't see how this has any effect (even after fixing the classnames).

I did try checking the git blame, but the change isn't in the history of this repo. It looks like the code was moved across from someplace else at some point.

Copy link
Member

Choose a reason for hiding this comment

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

Might be from times when preview was a small inline preview in sidebar, while now they are buttons with preview on hover.

Copy link
Contributor

@aaronrobertshaw aaronrobertshaw Jan 30, 2025

Choose a reason for hiding this comment

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

Comparing older commits to trunk and this branch I couldn't spot any spacing difference either. I think it's fine to remove.

I did notice another recent minor regression around preview styles unrelated to this PR.

Copy link
Contributor

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

Copy link
Contributor

@aaronrobertshaw aaronrobertshaw left a comment

Choose a reason for hiding this comment

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

Thanks for the quick fix @talldan 🚀

✅ Fixes both the spacing and width issues in the editor
✅ Tests well with multiple different width combinations on consecutive fields
✅ Form matches (button excepted) the frontend
✅ No apparent spacing change to the contact form preview

Before After
Screenshot 2025-01-30 at 4 51 29 pm Screenshot 2025-01-30 at 4 54 18 pm

While testing I did notice that there seems to have been another minor regression to styling within the preview. This time though it appears to have been introduced via #41274

Before #41274 After #41274
Screenshot 2025-01-30 at 5 11 16 pm Screenshot 2025-01-30 at 5 10 27 pm

In this PR, and on trunk, the odd border width to the text area in the preview only occurs on the first hover of a block style button. Moving to hover over other block style buttons, then back to the original block style, retains the proper border style.

Screen.Recording.2025-01-30.at.4.55.08.pm.mp4

@talldan
Copy link
Contributor Author

talldan commented Jan 30, 2025

In this PR, and on trunk, the odd border width to the text area in the preview only occurs on the first hover of a block style button. Moving to hover over other block style buttons, then back to the original block style, retains the proper border style.

Strange. I'll look into that one too!

@talldan talldan merged commit a2a02b1 into trunk Jan 30, 2025
66 checks passed
@talldan talldan deleted the fix/form-field-widths branch January 30, 2025 07:37
@github-actions github-actions bot added this to the jetpack/14.3 milestone Jan 30, 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: Field styles broken in the editor e.g. width, gap spacing etc.
3 participants