ToolsPanel: Remove / re-register panel items if the panelId changes #34726
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
andrewserong
requested review from
ajitbohra and
chrisvanpatten
as code owners
andrewserong
added
[Feature] Design Tools
|
Size Change: 0 B Total Size: 1.05 MB ℹ️ View Unchanged
|
aaronrobertshaw
approved these changes
Sep 10, 2021
There was a problem hiding this comment.
Impressive turnaround on this fix! Very nice work 👍
Everything tests well for me.
✅ Unit tests still pass.
✅ Panel item registration works correctly when:
- Switching between existing blocks
- Adding a new block via inserter
- Copying blocks with or without values
- Copying blocks with varying combinations of default or optional controls with values
This can be merged once e2e tests finish.
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.
Description
Fixes #34724
When copy + pasting a block with a Dimensions Panel, for a moment when the ToolsPanel is being registered, the clientId of the selected block points to the block before the new block is inserted. This means that by the time the copied block has finished being inserted, the selected clientId changes, however the ToolsPanel appears to point to the previous clientId.
In this change, we add the
panelIdas a dependency in the useEffect responsible for registering and de-registering panel items. This ensures that if the id changes, the panel items get removed, and new ones are registered for the new clientId.How has this been tested?
To observe the change in clientId when pasting the block, you can add the following to
block-editor/src/components/inspector-contols/block-support-tools-panel.jsaround line 20:Screenshots
Types of changes
Bug fix (non-breaking change which fixes an issue)
Checklist:
*.native.jsfiles for terms that need renaming or removal).