Behaviors - Lightbox: Update theme.json schema

[cbravobernal]

What?

Updating the theme.json schema with the new values available for Behaviors UI and the Lightbox feature.

As Behaviors UI and the Lightbox feature can be enabled and disabled through the theme.json file. Updating the schemas should facilitate its use for Theme developers.

Important: ⚠️ ⚠️ Do not merge while behaviors and lightbox are behind the experimental flag.

[SantosGuillamot]

Thanks for taking care of this 🙂 I just have one comment:

It seems that when defining "settings.blocks.core/image.behaviors.lightbox` still complains in Visual Studio:

I am not familiar with schemas but, if we are using allOf in the code (here), should we include "behaviors" here as well? If I am not mistaken, that would allow other blocks to include the "behaviors" property, but that is something that is already happening. For example, I can define "settings.blocks.core/post-date.border" which isn't supported.

I guess we could try using anyOf as well, but that seems to allow any property.

[ramonjd]

I guess there's a need to be specific until the behavior API is extended to more blocks. I think we could still create a behaviors properties definition, similar to settingsPropertiesComplete et al so that our future selves, and other devs, know where to add them.

It seems that when defining "settings.blocks.core/image.behaviors.lightbox` still complains in Visual Studio:

Is your theme's theme.json pointing to "$schema": "https://schemas.wp.org/trunk/theme.json",?

You can point it to the local copy. See the README

[ramonjd]

Ha, good one! I spotted this yesterday and fixed. 👍

[t-hamano]

I have tested with the following file, which references this PR as the schema URL.

{
	"$schema": "https://raw.githubusercontent.com/WordPress/gutenberg/update/theme-json-schema-behaviors/schemas/json/theme.json",
	"version": 2
}

---

The description of the root level behaviors puzzled me.

This is because the default type of value is an object, even though it is described as "an array of blocks."

How about moving this description to behaviors.blocks? In that case, I think we need a separate description for the root level behaviors.

---

It would be nice to have validation in the behaviors.blocks property to check if the block name is correct, like settings.blocks or settings.blocks.

---

The behaviors.blocks.core/image allows all properties and values. It may be better to use additionalProperties": false" and not allow any properties other than lightbox. This is also the case for settings.blocks.core/image.behaviors.

---

The settings.blocks.core/image property suggests behaviors as a definable property. However, the defined property causes an error as not allowed.

[SantosGuillamot]

Is your theme's theme.json pointing to "$schema": "https://schemas.wp.org/trunk/theme.json",?

I was testing it pointing to a local file and making changes to it seems to work 🤷 Thank you anyway for the information! 🙂

[michalczaplinski]

I've updated the PR with the correct types for the Lightbox animations. I think this is ready now, but we should wait until removing the experimental flag as mentioned by Carlos.

Just noting here that we'll also need to change the types for block.json now that we're using the block supports.