Fix EntitiesSavedStates panel dialog props. #67351
Merged
+23
−14
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
afercia
added
[Type] Bug
|
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: +36 B (0%) Total Size: 1.83 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 843d9ef. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12117682421
|
This was referenced Nov 27, 2024
|
Cc @WordPress/gutenberg-core I'd appreciate a review, when you have a chance. |
ntsekouras
reviewed
Dec 2, 2024
afercia
force-pushed
the
fix/entities-saved-panel-remove-close-on-click-outside
branch
from
72480e0 to
843d9ef
Compare
|
Removed |
afercia
deleted the
fix/entities-saved-panel-remove-close-on-click-outside
branch
im3dabasia
pushed a commit
to im3dabasia/gutenberg
that referenced
this pull request
Dec 4, 2024
* Fix EntitiesSavedStates panel dialog props. * Remove renderDialog default value. Co-authored-by: afercia <afercia@git.wordpress.org> Co-authored-by: ntsekouras <ntsekouras@git.wordpress.org> Co-authored-by: Mayank-Tripathi32 <mayanktripathi32@git.wordpress.org> Co-authored-by: jameskoster <jameskoster@git.wordpress.org>
ciampo
reviewed
Dec 4, 2024
|
The 'close when clicking outside' behavior no longer works in the post editor, but it does in the site editor. I'm not sure if it's intentional or a recent regression. |
It works for me. Are you testing the entity saved panel or the normal pubish panel? As in: in the post editor you need to edit something other than the post content to get the enity saved panel e.g. edit the template from the post editor. |
|
GIF to illustrate the entity saved panel in the post editor 'close when clicking outside' behavior:
|
|
Sorry, I was testing the normal publish panel. However, I expect it to have similar behavior since they share the design. |
I'd agree and I noted it in the issue:
Also, see this comment where there's some related considerations. |
michalczaplinski
pushed a commit
that referenced
this pull request
Dec 5, 2024
* Fix EntitiesSavedStates panel dialog props. * Remove renderDialog default value. Co-authored-by: afercia <afercia@git.wordpress.org> Co-authored-by: ntsekouras <ntsekouras@git.wordpress.org> Co-authored-by: Mayank-Tripathi32 <mayanktripathi32@git.wordpress.org> Co-authored-by: jameskoster <jameskoster@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.
Fixes #67313
Alternative to #67327
What?
When the entity saved states component is rendered inside a Modal component, clicking the padding area inside the modal dialog closes the modal unexpectedly.
Basically, this PR seeks to:
renderDialogprop as it is supposed to be used.useDialogprops to the component only when it is expected to work with a modal behavior i.e. whenrenderDialogis true.renderDialogdocs.TL;DR
#59622 made the
EntitiesSavedStatescomponent behave like a modal dialog when the newrenderDialogprop is true. However, the props fromuseDialogare always passed unconditionally to the component. As such, the component gets some modal behaviors including the 'close when clicking outside'. This works when the component is rendered in the save panel on the right. I doesn't work well when it is rendered inside a Modal dialog because in this case it's a sort of 'modal behavior' within a 'modal behavior' e.g.: clicking outside the inner component with modal behavior but still inside the outer Modal component closes the modal unexpectedly.Why?
Modal dialogs should not close unexpectedly.
The
useDialogprops should be passed conditionally, in the same wayrole=dialog,aria-labelledby, andaria-describedbyare passed conditionally. This makes sure that when the component gets the ARIA attributes related to a modal dialog, it also behaves like a modal dialog. WhenrenderDialogis false, none of the props related to the modal dialog should be set.How?
useDialogprops conditionally based onrenderDialog.renderDialogprops, please double check this as it seems to me the docs introduced in Documentation: EntitiesSavedStates editor component #62377 aren't accurate.aria-haspopup="dialog"attribute.Testing Instructions
entities-saved-states__paneldoes have a role=dialog and correct aria-labelledby and aria-describedby.These are the ARIA properties for the component in the Site editor:
And these are the ones for the theme preview:
Testing Instructions for Keyboard
Screenshots or screencast