Update: Keep existing preset shape on theme.json #25407
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
jorgefilipecosta
requested review from
ajitbohra,
chrisvanpatten,
mkaz,
spacedmonkey,
TimothyBJacobs and
youknowriad
as code owners
jorgefilipecosta
changed the title
|
Size Change: +23 B (0%) Total Size: 1.2 MB
ℹ️ View Unchanged
|
jorgefilipecosta
force-pushed
the
update/key-existing-preset-shape-on-theme-json
branch
from
b700aeb to
1e5c527
Compare
|
🤔 Why are we worried about backwards-compatibility? |
|
Hi @aristath, We need to be backward compatible at the components level e.g: PanelColorGradientSettings, PanelColor, ColorPalette, and all the other components that use the current shape. Most of these components were shipped since WordPress 5.0 and use a different shape. If we change the shape we need to make the components accept both shapes or translate the new shape to the old one before passing it to the components. |
|
This PR is the basis of some work #25419, which is important for other tasks to continue. I'm going to merge the PR for now so other work with this branch as the base can be merged. I'm totally open to discussions on this change and in case there is feedback we can iterate on follow up PR's. |
jorgefilipecosta
deleted the
update/key-existing-preset-shape-on-theme-json
branch
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.
Before the colors, gradients and and font sizes had the shape ( {slug, name, color } ), ( {slug, name, gradient } ), and ( {slug, name, fontSize } ). On theme.json, we were following the idea of all presets having the same shape ( {slug, name, value } ). This change was made when all presets were in a preset array, and we would not have any preset mapping, so if all followed the same shape, we could have a straightforward loop. Meanwhile, presets are not a single array anymore. We have a mapping, and we can also easily map the value key.
This shape change is not bringing the simplification we hoped and is doing the opposite as we need to translate between the different shapes. Just applying this simple change, we are removing lines of code.
If we don't merge this PR and we follow the idea of shape change, we will need to make sure all components that receive font-sizes, colors, and gradients support both shapes, so they are back-compatible. Or that our useEditorFeature hook converts the new shape to the old one so when it is passed to components, they can interpret it. Either way, we are increasing our maintainability effort as we will have two shapes around the codebase.
It seems the shape change did not simplified things and had the opposite effect.
How has this been tested?
I verified the preset vars are still correctly generated on the server and client.