Fix Navigable Toolbar initialIndex #51181
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
If the initialIndex was undefined, the toolbar would set the tabindex=0 to the last item in the toolbar, which was an unexpected behavior.
jeryj
added
[Package] Block editor
|
Size Change: +2.4 kB (0%) Total Size: 1.39 MB
ℹ️ View Unchanged
|
|
I would like it to reset after interacting with a new block. |
Me too. That feels like a more expected behavior, and what it originally did. I can update this tomorrow. |
|
Flaky tests detected in 9089681. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5156640998
|
ajlende
reviewed
Jun 6, 2023
Comment on lines
+105
to
+109
| useEffect( () => { | ||
| // Resets the index whenever the active block changes so this is not | ||
| // persisted. See https://github.com/WordPress/gutenberg/pull/25760#issuecomment-717906169 | ||
| initialToolbarItemIndexRef.current = undefined; | ||
| }, [ clientId ] ); |
There was a problem hiding this comment.
If we're switching back to using useEffect for this, do we still need the key prop for the BlockContextualToolbar?
See https://github.com/WordPress/gutenberg/pull/29573/files#r620982401
There was a problem hiding this comment.
I'm not sure why, but I can only get the behavior to work if this useEffect and the key prop are set. Without one of them, the index is persisted across block changes.
There was a problem hiding this comment.
Changing the key prop on a React element basically tells it that it's a different component now, triggering the component to re-mount. So the BlockContextualToolbar gets re-mounted when you change blocks.
And refs, when used like this, can prevent a component from re-rendering. So it prevents SelectedBlockPopover from re-rendering when the selected toolbar index changes.
So I guess it makes sense to me that they're both needed when I think through it. You can't move the state inside BlockContextualToolbar unless the shouldShowContextualToolbar state moves inside it too because the BlockContextualToolbar also gets remounted when the toolbar is hidden and then shown.
Maybe it would make sense to move that state inside to clear up some of the weirdness, but this PR is probably good enough for now to get the fix in.
There was a problem hiding this comment.
@ajlende and I worked on this refactor and decided to leave it as is, as the refactor was getting too involved.
sethrubenstein
pushed a commit
to pewresearch/gutenberg
that referenced
this pull request
Jul 13, 2023
* Store navigableToolbarRef so we have access on useEffect cleanup * Always set initialIndex to 0 if undefined If the initialIndex was undefined, the toolbar would set the tabindex=0 to the last item in the toolbar, which was an unexpected behavior. * Reset toolbar focus index on clientId change
priethor
added
[Focus] Accessibility (a11y)
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 and Why
There is a bug in the
<NavigableToolbar />used in the block popover that incorrectly sets the active toolbar item to the last item in the toolbar. To reproduce this issue:The expected and intended behavior is that the toolbar will always return you to the last item you were interacting with. So, if you were at 0, it should return you to the 0 index item. If you're at 6, it should return you to the 6 index item. If you haven't interacted with it at all, you should go to the first (0) item.
How?
There are two issues:
Testing Instructions
Screenshots or screencast
Before
After
