Fix sticking “Reset” option in ToolsPanel
#60621
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
stokesman
added
[Type] Bug
stokesman
force-pushed
the
fix/tools-panel-sticking-reset
branch
2 times, most recently
from
58577f0 to
3007db7
Compare
|
Size Change: +1 B (0%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
stokesman
force-pushed
the
fix/tools-panel-sticking-reset
branch
2 times, most recently
from
086f577 to
d25ef9b
Compare
stokesman
commented
Apr 18, 2024
Comment on lines
-154
to
158
| if ( ! isMenuItemChecked && wasMenuItemChecked ) { | ||
| if ( ! isMenuItemChecked && isValueSet && wasMenuItemChecked ) { | ||
| onDeselect?.(); | ||
| } |
There was a problem hiding this comment.
The effect that triggers this runs more often now that flagItemCustomization get called when removing a value. That was causing onDeselect to be called multiple times and this change fixed that.
As an aside, I experimented with a little refactor to not call these (onSelect/onDeselect) from an effect and it seemed to work well and simplifies things a bit. I wanted to keep changes minimal so I've left it out but if that sounds good I'd happily make a PR for it.
Comment on lines
-208
to
211
| // Force a menu item to be checked. | ||
| // This is intended for use with default panel items. They are displayed | ||
| // separately to optional items and have different display states, | ||
| // we need to update that when their value is customized. | ||
| // Updates the status of the panel’s menu items. For default items the | ||
| // value represents whether it differs from the default and for optional | ||
| // items whether the item is shown. | ||
| const flagItemCustomization = useCallback( |
There was a problem hiding this comment.
The comment seemed out of date because the callback is already being used from optional panel items and now, of course, it’s being used to also “remove” a customization flag.
|
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. |
tyxla
approved these changes
May 9, 2024
There was a problem hiding this comment.
Looks good and tests well. ✅
I'd personally add a CHANGELOG entry, but that's not a requirement.
Thanks @stokesman 🙌
This reverts commit 3007db7.
Because they should not cause themselves to be hidden.
stokesman
force-pushed
the
fix/tools-panel-sticking-reset
branch
from
d25ef9b to
fa554e4
Compare
Me too, I just tend to wait for approval and try sparing conflict fixes. Thanks for testing and reviewing Marin ❤️. |
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?
Ensures the “Reset” action of tools panel’s menu items is present only when an item’s value is set.
Why?
Currently once a panel item has had its value set the ”Reset” option becomes enabled but it gets stuck that way even if the original value has been restored. This doesn't cause much of a problem so fixing it could be described as UI/UX polish.
Further, this is extracted from a larger effort in another branch to ensure defaults of block supports are represented in the controls. It can work without these changes but the UI discrepancy is perhaps more glaring in such a context.
How?
true).Testing Instructions
In the Editor
It's important to clear the value by using the same swatch as before. If you actually switch back to the original value by using its swatch then “Reset” will be enabled. This is a separate issue and fixing it also depends on these changes.
In Storybook
Testing Instructions for Keyboard
Not sure it’s required. The instructions above aren’t exclusively for pointing devices. I'll add more detailed instruction if need be.
Screenshots or screencast
Before
stuck-reset.mp4
After
unstuck-reset.mov