Breaking Change - Rename “option” to “control” in editor config (Deprecable)

Deployed Date: 3/7/24

Deprecation Date: 03/25/2024

We are renaming the option property in a section’s editor controls definition to control instead. This makes the relationship between the controls definition and each control more explicit. It also avoids association between the unrelated option and the select control’s options property.

Currently, both option and control are supported. Themes and documentation have been updated with the new control property. Once all existing developers have had a chance to update their theme templates, option support will be removed.

Migration path

Rename all instances of option to control in any section templates.

Here is an example of the migration being done in Brisk.

Before

{% editor %}
{
    "name": "Text",
    "controls": [
        {
            "option": "input",
            "label": "Heading",
            "value": {
                "$ref": "#/schema/heading"
            }
        },
        {
            "option": "textarea",
            "label": "Text",
            "value": {
                "$ref": "#/schema/text"
            }
        }
    ]
}
{% endeditor %}

After

{% editor %}
{
    "name": "Text",
    "controls": [
        {
            "control": "input",
            "label": "Heading",
            "value": {
                "$ref": "#/schema/heading"
            }
        },
        {
            "control": "textarea",
            "label": "Text",
            "value": {
                "$ref": "#/schema/text"
            }
        }
    ]
}
{% endeditor %}