Stabilize isPreviewMode flag #66149
Draft
Stabilize isPreviewMode flag #66149
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
|
Size Change: +15 B (0%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
…vate symbol within RichText block
zaguiini
force-pushed
the
stabilize-is-preview-mode-flag
branch
from
c30246d
to
72f81d3
Compare
|
Flaky tests detected in 72f81d3. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11355847467
|
youknowriad
reviewed
Oct 16, 2024
youknowriad
reviewed
Oct 16, 2024
| @@ -60,6 +60,7 @@ export function BlockPreview( { | |||
| ...originalSettings, | |||
| focusMode: false, // Disable "Spotlight mode". | |||
| __unstableIsPreviewMode: true, | |||
There was a problem hiding this comment.
Can we make this a getter and deprecate it or something?
There was a problem hiding this comment.
Maybe we can avoid passing all these __unstableIsPreviewMode configs and instead have a deprecated "property getter" in the default settings that fallbacks to isPreviewMode
There was a problem hiding this comment.
As much as I love that idea, it seems incredibly complex to do it right.
We're using the SETTINGS_DEFAULTS object in many places (defaults.native, the reducer, the Editor store), and the spread operator does not include the prototype, meaning the getter is not copied. Also, overriding the settings in this file, for example, would also result in the getter not being copied.
So, I think this duplication is better. Unfortunately, we cannot display the deprecation notice because we're not using the getter function. However, a possible workaround would be to add the getter function exclusively to the sub-registries (in this file and the others that override the original settings) and keep the reducers (block editor store, editor store) intact. I believe we can even remove the __unstableIsPreviewMode property from it directly if we're feeling adventurous.
youknowriad
reviewed
Oct 16, 2024
youknowriad
added
Needs Dev Note
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.
Why?
It's been almost three years since we introduced
__unstableIsPreviewModeas a flag to indicate if the block is being rendered as part of the blocks list, block preview, pattern preview, etc. It's time to make it stable.I was motivated after Automattic/jetpack#39768 (comment).
How?
This PR adds
isPreviewModeas a new default setting key and alongside__unstableIsPreviewModewhenever it's used as a sub-registry value.Finally, I'm rewriting all internal usages of
__unstableIsPreviewModeto the newisPreviewModeflag.