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: use a placeholder attribute in the editor instead of value #41712

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from

Conversation

simison
Copy link
Member

@simison simison commented Feb 11, 2025

Use a placeholder attribute in the editor for placeholder text instead of value attribute.

By using value, we have a couple issues.

When theme includes styling for ::placeholder pseudo element, we don't show it. Consider for example CSS:

input::placeholder {
	font-style: italic;
}

Before

Screenshot 2025-02-11 at 12 49 02

After

Screenshot 2025-02-11 at 12 48 46

When we add a number input, its type="number" disallows non-numeric value, even if placeholder could be numeric. We would only need to support numeric placeholders for that input. We could change that field to type="text" in the editor, but that would miss out browser number controls, any styling applied to number fields, and otherwise also mismatch what they see in the editor with frontend.

Before

Screenshot 2025-02-11 at 12 57 28 Screenshot 2025-02-11 at 12 58 01

After

Screenshot 2025-02-11 at 12 33 56

Proposed changes:

  • Use a placeholder attribute in the editor for placeholder text instead of value attribute

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:

  • Add different inputs and set their placeholders; they continue working.

@simison simison added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Package] Forms [Feature] Forms Blocks Blocks designed to streamline user input and engagement, such as contact, newsletter sign-ups, etc. labels Feb 11, 2025
@simison simison requested a review from a team February 11, 2025 11:00
Copy link
Contributor

github-actions bot commented Feb 11, 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 update/forms-placeholder-attr-in-editor branch.

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

    bin/jetpack-downloader test jetpack update/forms-placeholder-attr-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 [Block] Contact Form Form block (also see Contact Form label) [Feature] Contact Form labels Feb 11, 2025
Copy link
Contributor

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!

@simison simison mentioned this pull request Feb 11, 2025
3 tasks
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

@enejb
Copy link
Member

enejb commented Feb 11, 2025

@simison Does this work as expected for you in any text input field?
I am not able to get it to work. It replaces the first character only.

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.

makes sense

@lezama
Copy link
Contributor

lezama commented Feb 11, 2025

works ok for me

It replaces the first character only.

what do you mean? 😆

@edanzer
Copy link
Contributor

edanzer commented Feb 11, 2025

I see what @enejb is talking about. With this PR loaded, I can add placeholder text as expected in the sidebar. But if I try to type placeholder text directly into the input in the main part of the block editor, it always deletes all but the last character I typed. I also confirmed this does not happen on trunk. I'm sure it's just some mix-up of state - basically since we changed the relationship between value and placeholder, we don't track value properly when typing into the input.

@simison
Copy link
Member Author

simison commented Feb 11, 2025

Weird, that's the scenario that worked for me just fine, but I'll do further testing 👍 Might be browser dependant.

@edanzer
Copy link
Contributor

edanzer commented Feb 11, 2025

Just to be sure we're talking and seeing the same thing, here's a video of the behavior. I type first in the placholder field in the sidebar (works), and then directly in the input.

I've also confirmed that that if I keep value = { placeholder } like below, the issue is resolved

value={ placeholder }
placeholder={ placeholder }
input-placeholder.mp4

@simison
Copy link
Member Author

simison commented Feb 11, 2025

I've also confirmed that that if I keep value = { placeholder } like below, the issue is resolved

Thanks! It might make sense to retain value when focused on the input, and set it empty when not. 🤔 That would fix the styling (keeping value removes the styles), and would still likely need some changes for inputs like Number where value can be only number.

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 [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants