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: remove onSplit in favor of splitting feature #38246

Merged
merged 2 commits into from
Jul 12, 2024

Conversation

monsieur-z
Copy link
Contributor

@monsieur-z monsieur-z commented Jul 8, 2024

Fixes #38031

Proposed changes:

The onSplit prop of the RichText component is no longer supported in Gutenberg. The last remaining component that uses this property in the forms package is JetpackFieldOptionEdit, which is used by the Multiple Choice (Checkbox) and Single Choice (Radio) fields.

Screenshot 2024-07-08 at 4 27 56 PM Screenshot 2024-07-08 at 4 27 58 PM

This PR replaces the onSplit prop with the splitting support feature. This comment thread explains the change in more detail.

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)?

Jetpack product discussion

n/a

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

No.

Testing instructions:

Regression testing

  • Spin up a Jetpack site
  • Create a new post
  • Add a form with the block inserter
  • In the form, add both the Multiple Choice (Checkbox) and Single Choice (Radio) fields
Screenshot 2024-07-08 at 4 30 38 PM Screenshot 2024-07-08 at 4 30 44 PM
  • Ensure you can add a separate option when you hit the Enter key and that you can delete items with the keyboard
  • Open the preview and verify the form renders and behaves as expected

Update testing

  • Install the Gutenberg plugin from the plugin repo and activate it. This version will take over the one shipped with WordPress.
Screenshot 2024-07-11 at 11 38 56 AM
  • Refresh the post editor page in WPadmin
  • Make sure there's no error message
  • Test that the fields work as before

Note: after removing an option with the delete key, the previous item gets the focus. but the caret doesn't move to the end. I haven't been able to fix this yet, but it doesn't break functionality, and we can ship this PR as is.

Copy link
Contributor

github-actions bot commented Jul 8, 2024

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-onSplit-deprecation branch.

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

    bin/jetpack-downloader test jetpack fix/form-onSplit-deprecation
    

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

Copy link
Contributor

github-actions bot commented Jul 8, 2024

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 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.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

@monsieur-z monsieur-z force-pushed the fix/form-onSplit-deprecation branch 2 times, most recently from 8fcc86e to 349afd5 Compare July 11, 2024 15:38
@monsieur-z monsieur-z force-pushed the fix/form-onSplit-deprecation branch from 349afd5 to 1148386 Compare July 11, 2024 15:38
@monsieur-z monsieur-z marked this pull request as ready for review July 11, 2024 15:50
@monsieur-z monsieur-z requested a review from a team July 11, 2024 15:50
@@ -243,6 +243,7 @@ const OptionFieldDefaults = {
supports: {
reusable: false,
html: false,
splitting: true,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This has no impact on Gutenberg versions that don't support it.

@@ -62,7 +62,7 @@ function JetpackFieldMultiple( props ) {
<InnerBlocks
allowedBlocks={ ALLOWED_BLOCKS }
template={ [ [ `jetpack/field-option-${ type }`, {} ] ] }
templateInsertUpdatesSelection={ false }
templateInsertUpdatesSelection={ true }
Copy link
Contributor Author

@monsieur-z monsieur-z Jul 11, 2024

Choose a reason for hiding this comment

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

Ensure option input has focus initially, for all versions.

@@ -41,21 +48,46 @@ export const JetpackFieldOptionEdit = props => {
removeBlock( clientId );
};

const onFocus = () => {
// TODO: move cursor to end
Copy link
Contributor Author

Choose a reason for hiding this comment

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

When you delete an option, the previous one gets the focus, but the caret stays at the start. I've tried to move it at the end and select the entire text but couldn't eventually make it work, though both approaches are documented online numerous times. I don't know what's blocking here. Even requestAnimationFrame and setTimeout calls didn't work.

Copy link
Contributor

@coder-karen coder-karen left a comment

Choose a reason for hiding this comment

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

Note: after removing an option with the delete key, the previous item gets the focus. but the caret doesn't move to the end. I haven't been able to fix this yet, but it doesn't break functionality, and we can ship this PR as is.

Agree - we can create a new issue for the caret issue in order to get this out as soon as possible. Seems to be an issue when just selecting an option in a dropdown too in the editor, but a second click moves the caret to the intended location.

The functionality apart from that works well, also if not using the updated Gutenberg version.

@monsieur-z monsieur-z merged commit 82e822b into trunk Jul 12, 2024
57 checks passed
@monsieur-z monsieur-z deleted the fix/form-onSplit-deprecation branch July 12, 2024 14:15
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.

Contact Form: move away from onSplit prop
2 participants