Docs: Add description for templateParts in theme json.
#30118
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
Addison-Stavlo
requested review from
ajitbohra and
chrisvanpatten
as code owners
Addison-Stavlo
requested review from
oandregal,
vindl,
jeyip,
mattwiebe,
Copons,
david-szabo97 and
gziolo
Addison-Stavlo
added
[Feature] Full Site Editing
[Type] Developer Documentation
6 tasks
|
Size Change: +9.4 kB (+1%) Total Size: 1.42 MB
ℹ️ View Unchanged
|
ntsekouras
reviewed
Mar 23, 2021
There was a problem hiding this comment.
Thanks @Addison-Stavlo !
Something that I'm not sure myself is: do we need to declare all created Template parts in theme.json or we have to, only if we want to utilize the Block variations API?
| @@ -464,6 +464,19 @@ There's a growing need to add more theme metadata to the theme.json. This sectio | |||
| } | |||
| ``` | |||
|
|
|||
| **templateParts**: within this field themes can list the template parts present in the `block-template-parts` folder. For example, for a template part named `my-template-part.html`, the `theme.json` can declare what area that template part is intended for to use the corresponding block variation in the editor. Currently block variations exist for "header" and "footer" values of the area term, any other values and undefined template parts will default to the general template part block. | |||
There was a problem hiding this comment.
I think it needs a bit more clarification about why this has to be set here (theme.json) and not as an attribute in the markup. Maybe something like this:
the Template part block renders its own entity internally. Any attributes on the outer block itself are just block attributes, and thus saved as part of the post it is a child of (template, page, etc). - you have written this :).
Also a bit more info about what a match with a block variation means (results), like the proper display information and where else will be used for (semantic).
There was a problem hiding this comment.
do we need to declare all created Template parts in theme.json or we have to, only if we want to utilize the Block variations API?
We don't have to declare them, as they would default to the general/uncategorized area. Thats part of what I was getting at with:
undefined template parts will default to the general template part block.
I think it needs a bit more clarification about why this has to be set here (theme.json) and not as an attribute in the markup.
I was trying to keep it light, describing what needs to be done and how to do it without adding all the weight of internal database structures, entities, taxonomy terms, etc. etc. Im happy to add more if people think it is necessary, but I was trying to avoid making the description a bit too heavy and confusing.
There was a problem hiding this comment.
and not as an attribute in the markup.
Thinking about it more, especially since we recently added that 'area' attribute used in placeholder/creation flows it probably makes sense to clarify that here. 👍
There was a problem hiding this comment.
updated a bit 😁
gziolo
changed the title
templateParts in theme json.templateParts in theme json.
gziolo
added
the
[Feature] Themes
carolinan
approved these changes
Mar 25, 2021
|
Thanks for taking a look @carolinan!
Im glad it became more clear. I pushed a minor update to try and improve clarity, hopefully that is slightly better. 😁 If you have any other suggestions I am happy to hear them. |
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
Updates theme json docs to include schema for definine template part areas.
How has this been tested?
Screenshots
Types of changes
Checklist: