-
Notifications
You must be signed in to change notification settings - Fork 4.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Style Book: Clear Global Styles navigation history when selecting a block #46391
Merged
noisysocks
merged 2 commits into
trunk
from
update/clear-navigator-history-when-selecting-block-in-style-book
Dec 12, 2022
Merged
Style Book: Clear Global Styles navigation history when selecting a block #46391
noisysocks
merged 2 commits into
trunk
from
update/clear-navigator-history-when-selecting-block-in-style-book
Dec 12, 2022
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
noisysocks
added
[Type] Bug
An existing feature does not function as intended
Global Styles
Anything related to the broader Global Styles efforts, including Styles Engine and theme.json
labels
Dec 8, 2022
Size Change: +149 B (0%) Total Size: 1.32 MB
ℹ️ View Unchanged
|
ramonjd
approved these changes
Dec 12, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to break this but it wouldn't break!
Works as described. Navigating back to root is a good call.
Trunk
2022-12-12.12.16.33.mp4
This branch
2022-12-12.12.02.20.mp4
noisysocks
deleted the
update/clear-navigator-history-when-selecting-block-in-style-book
branch
December 12, 2022 05:29
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Global Styles
Anything related to the broader Global Styles efforts, including Styles Engine and theme.json
[Type] Bug
An existing feature does not function as intended
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?
Follows #45960.
Clears out the Global Styles navigation history when selecting a block in Style Book, so that pressing the back button after selecting a block in Style Book goes back to the root instead of to wherever you were previously.
Why?
Addressing this feedback from @javierarce in #45960 (comment):
How?
To clear the history we simply call
navigator.goBack()
until we're at the root. We can tell how many times we need to do this by counting the number of/
s in the path. For example if we're at/typography/headings
then we need to go back twice.One gotcha is that block names can contain
/
i.e./blocks/core/paragraph/typography
. To work around this I've updated Global Styles to URI encode the block name i.e./blocks/core%2Fparagraph/typography
. It makes sense to do this anyway since these paths approximate a URL.An alternative approach is to add something like
navigator.clearHistory()
to the Navigator API. I'm not sure how widely useful this would be though so thought I'd start with an approach that requires minimal changes to@wordpress/components
.I did have to make one minimal change to
@wordpress/components
which is to updatenavigator.goTo
andnavigator.goBack
to use thesetState( prevState => ... )
pattern so that multiple calls to these functions can be made in one render cycle.I also fixed a small bug I noticed which is that if you select Buttons in Style Book then both Button and Buttons appear selected. This was because I was using
path.startsWith()
to determine if the block is selected andcore/buttons
starts withcore/button
🙂Testing Instructions
An E2E test for this is included.
To test manually:
Testing Instructions for Keyboard