Interactivity API: Allow "default" suffix values #65815
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
sirreal
added
[Type] Bug
sirreal
requested review from
ntwb,
nerrad,
ajitbohra,
luisherranz and
DAreRodz
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: -28 B (0%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
|
I'm investigating test failure now. |
gziolo
reviewed
Oct 2, 2024
Comment on lines
+24
to
+25
| isDefaultDirectiveSuffix, | ||
| isNonDefaultDirectiveSuffix, |
There was a problem hiding this comment.
What's the reasoning behind having two utils for the same check?
There was a problem hiding this comment.
They're both type guards so Array.prototype.filter and Array.prototype.find work with them to narrow types. Type guards are one-sided, however, the true case is narrowed, so because we narrow to the default suffix and to a non-default suffix, it's necessary to have both.
This could be done other ways, but this seemed expressive and clear. I'd also originally implemented this with a symbol as the default value, but that wasn't necessary and switching the implementation was simple.
…fault-suffix-collision
michalczaplinski
approved these changes
Oct 7, 2024
|
Should this have the |
|
I'd like to know what folks think. If everyone is confident and happy with this change than it may be good to backport. |
|
I'll go ahead and land this. I don't believe it's critical for a backport but if folks would like to backport it that would also be fine. |
|
Thanks @sirreal, this change makes a lot of sense. It is easier to understand that entries where Regarding whether this PR should be backported, I would be in favor. 🙂 |
sirreal
added
the
Backport to WP 6.7 Beta/RC
|
I've added the label, I'm not sure whether automation will pick up this PR automatically now. |
github-actions
bot
removed
the
Backport to WP 6.7 Beta/RC
gutenbergplugin
pushed a commit
that referenced
this pull request
Oct 8, 2024
Fix an issue where "default" could not be used as "suffix" values in
Interactivity API directives, for example in a directive like:
data-wp-class--default="…"
---
Co-authored-by: sirreal <jonsurrell@git.wordpress.org>
Co-authored-by: michalczaplinski <czapla@git.wordpress.org>
Co-authored-by: gziolo <gziolo@git.wordpress.org>
github-actions
bot
added
the
Backported to WP Core
|
I just cherry-picked this PR to the wp/6.7 branch to get it included in the next release: 3ee7c74 |
karthick-murugan
pushed a commit
to karthick-murugan/gutenberg
that referenced
this pull request
Nov 13, 2024
Fix an issue where "default" could not be used as "suffix" values in
Interactivity API directives, for example in a directive like:
data-wp-class--default="…"
---
Co-authored-by: sirreal <jonsurrell@git.wordpress.org>
Co-authored-by: michalczaplinski <czapla@git.wordpress.org>
Co-authored-by: gziolo <gziolo@git.wordpress.org>
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?
Fix an issue where "default" could not be used as "suffix" values in Interactivity API directives:
I noticed this while investigating https://core.trac.wordpress.org/ticket/62131 / #65803.
Why?
"default" should be a valid value. This is most notable in the class directive where
defaultis a valid class name but the client ignores it.How?
Internally, the string value "default" was used to indicate the default suffix. Instead of a string value, a different value type,
nullin this case, can be used to indicate the default suffix.Testing Instructions
The PR includes e2e tests for the behavior.
Manual testing would be similar to the e2e test:
Screenshot
Trunk
trunk.mov
Branch
branch.mov