Emit an input event primer-text-field#clearContents. #3062
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Having the `#clearContents` emit an `input` event, it integrates better whenever an `input` event listener is bound to the `primer-text-field` components. A classic example is to use the `primer-text-field` as a search field, which triggers a background request when the field's value is changed. Without emiting the `input` event on #clearContents, the filtering background request would not be triggered.
🦋 Changeset detectedLatest commit: b7bb9fe The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
camertron
requested changes
Sep 9, 2024
Co-authored-by: Cameron Dutro <[email protected]>
|
Ah I forgot to mention this last time @dombesz, but could you also add a changeset? Running |
@camertron I already have 1 here, do I need to add a new one? |
|
Ah sorry I missed it, carry on! |
camertron
approved these changes
Sep 10, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What are you trying to accomplish?
I want to make the
primer-text-fieldclear button to trigger aninputevent in the field. This makes the clear button logic to behave the same way as it was deleted by the user manually.A good example for this behaviour is to use the
primer-text-fieldas a search field, triggering a background request to refresh the results when its value is changed. Without emitting theinputevent on the#clearContents, refreshing the results would not be triggered.A possible workaround would be to bind the background request directly on the clear button too. Unfortunately there is no simple way to bind events to the clear button, because event binding to the clear button is not possible via the
primer-text-fieldcomponent declaration.Integration
Does not require any code change in production.
List the issues that this change affects.
Closes #3061
Risk Assessment
What approach did you choose and why?
The solution is trigger an
inputevent when theprimer-text-fieldclear button is clicked.Merge checklist
Added/updated documentationAdded/updated previews (Lookbook)Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.