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: add number input #40962

Merged
merged 9 commits into from
Feb 13, 2025
Merged

Forms: add number input #40962

merged 9 commits into from
Feb 13, 2025

Conversation

simison
Copy link
Member

@simison simison commented Jan 10, 2025

Issue #40961

Proposed changes:

  • Adds simple number field
  • No min/max/step attributes for now as those can be added in follow-up PR.
  • Input is quite wide in editor, but how forms layout/CSS is done doesn't make it straightforward to correct. Good for follow-up PR.
Screenshot 2025-02-11 at 12 18 10 Screenshot 2025-02-11 at 13 02 09

Disables setting placeholders via sidebar, allowing setting them only in the editor (and thus only be number values for now) — PR for general improvement for all fields in #41712

Screenshot 2025-02-13 at 12 57 43

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

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

Testing instructions:

  • In forms, add number input.
  • Try different default values; can be only numberic
  • Try setting placeholder in the editor
  • Try submit the input with correct and incorrect information
  • Try hack the values, should accept only numeric values
  • Try export values

Number needs to appear in several places after submitting:

Confirmation message
Screenshot 2025-02-11 at 14 15 41

Email
Screenshot 2025-02-11 at 13 55 36

Inbox
Screenshot 2025-02-11 at 13 54 42

Export
Screenshot 2025-02-11 at 14 04 39

@simison simison added [Status] In Progress [Package] Forms [Feature] Forms Blocks Blocks designed to streamline user input and engagement, such as contact, newsletter sign-ups, etc. labels Jan 10, 2025
Copy link
Contributor

github-actions bot commented Jan 10, 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 add/forms-number-input branch.

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

    bin/jetpack-downloader test jetpack add/forms-number-input
    

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] AI Assistant [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/ Docs labels Jan 10, 2025
Copy link
Contributor

github-actions bot commented Jan 10, 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.

@simison simison force-pushed the add/forms-number-input branch from 7b5380d to 975a521 Compare January 13, 2025 12:10
@simison simison mentioned this pull request Jan 14, 2025
8 tasks
@simison simison force-pushed the add/forms-number-input branch from e7be37d to 2eac76d Compare February 11, 2025 10:17
Copy link
Contributor

github-actions bot commented Feb 11, 2025

Code Coverage Summary

Coverage changed in 5 files.

File Coverage Δ% Δ Uncovered
projects/packages/forms/src/contact-form/class-contact-form-field.php 342/507 (67.46%) -1.16% 9 💔
projects/packages/forms/src/blocks/contact-form/class-contact-form-block.php 0/156 (0.00%) 0.00% 6 💔
projects/packages/forms/src/contact-form/class-contact-form.php 532/765 (69.54%) -0.19% 3 ❤️‍🩹
projects/packages/forms/src/contact-form/class-contact-form-plugin.php 111/838 (13.25%) -0.03% 2 ❤️‍🩹
projects/packages/forms/src/blocks/contact-form/child-blocks.js 0/65 (0.00%) 0.00% 1 ❤️‍🩹

Full summary · PHP report · JS report

Add label I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage. to override the failing coverage check.

@simison simison mentioned this pull request Feb 11, 2025
3 tasks
@@ -52,7 +52,8 @@ const JetpackField = props => {
onChange={ e => setAttributes( { placeholder: e.target.value } ) }
style={ fieldStyle }
type={ type }
value={ placeholder }
value=""
placeholder={ placeholder }
Copy link
Member Author

Choose a reason for hiding this comment

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

@simison simison marked this pull request as ready for review February 11, 2025 12:27
@simison simison added [Status] Needs Team Review Obsolete. Use Needs Review instead. and removed [Status] In Progress [Block] AI Assistant labels Feb 11, 2025
@github-actions github-actions bot added [Block] AI Assistant [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Feb 11, 2025
@simison simison added [Type] Feature Development of a new feature and removed [Block] AI Assistant [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Feb 11, 2025
@simison simison force-pushed the add/forms-number-input branch from c1d6293 to 93c3317 Compare February 11, 2025 12:31
@enejb
Copy link
Member

enejb commented Feb 11, 2025

Nice work. We are getting close.

I think we still need to fix up some of the styling and make sure it looks more consistent across themes and from styles.
For example in https://wordpress.com/theme/archeo

The numbers input field looks like (across the different form styles)
Screenshot 2025-02-11 at 6 08 08 AM

Screenshot 2025-02-11 at 6 07 54 AM

Screenshot 2025-02-11 at 6 07 13 AM

There are a couple of other ones that I came across with missing styling.

icon: renderMaterialIcon(
<Path
fill={ getIconColor() }
d="M12 7H4V8.5H12V7ZM19.75 17.25V10.75H4.25V17.25H19.75ZM5.75 15.75V12.25H18.25V15.75H5.75Z"
Copy link
Contributor

Choose a reason for hiding this comment

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

on a follow up PR we should probably design a different icon?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes! :-)

lezama
lezama previously approved these changes Feb 11, 2025
Copy link
Contributor

@lezama lezama left a comment

Choose a reason for hiding this comment

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

looking good!

@simison
Copy link
Member Author

simison commented Feb 11, 2025

@enejb can you check if you need to build forms package or Jetpack plugin? Different themes worked fine in my testing; I was basically just using the same styles as for other basic text inputs so it should look identical to other inputs in all scenarios.

Archeo, for example:

image

@enejb
Copy link
Member

enejb commented Feb 11, 2025

Yeah I just double checked this and it it works well in Archo theme for me now 🥳

What kinds of numbers should we allow? Do we allow only limit it to integers? How about negative numbers?

IMHO we should allows be as liberal as possible and allow any type of number by default. ( Since most folk might not think about thus much) but folks that do might want to have very specific requirements. If you add step="any" it will allow for floating point (decimals) as well.

@lezama
Copy link
Contributor

lezama commented Feb 12, 2025

IMHO we should allows be as liberal as possible

👍

let's merge and do follow ups?

@simison
Copy link
Member Author

simison commented Feb 12, 2025

What kinds of numbers should we allow? Do we allow only limit it to integers? How about negative numbers?

I agree that's up to the site creator. :-) There will be min/max/step configuration which they can use to limit it, but not in this PR.

@simison
Copy link
Member Author

simison commented Feb 12, 2025

I wanna hold off from merging until placeholder question is solved (#41712), or otherwise I'll disable placeholder UI in this PR for the Number field and add it back later.

@simison
Copy link
Member Author

simison commented Feb 13, 2025

I disabled placeholder input in the sidebar for number field for now — we'll add it back with #41712

@simison simison merged commit 7e53a77 into trunk Feb 13, 2025
64 of 65 checks passed
@simison simison deleted the add/forms-number-input branch February 13, 2025 16:45
@github-actions github-actions bot removed the [Status] Needs Team Review Obsolete. Use Needs Review instead. label Feb 13, 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] AI Assistant [Block] Contact Form Form block (also see Contact Form label) Docs [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] Feature Development of a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants