widgetSchemaConditional

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/widgetSchemaConditional",
  "title": "widgetSchemaConditional",
  "type": "object",
  "description": "An optional property that can be added to each setting to control whether it should be displayed to the user while editing in Page Builder. This does not clear the value in the setting, just controls the display of the setting.",
  "x-examples": {
    "Conditional attribute": {
      "key": "backgroundType",
      "operator": "IN",
      "value": [
        "color"
      ]
    }
  },
  "properties": {
    "key": {
      "type": "string",
      "description": "The ID of the `setting` object the conditional attribute is related to.",
      "example": "backgroundType"
    },
    "operator": {
      "type": "string",
      "description": "Specifies the operation used to determine whether to display the setting. The `IN` operator is currently the only supported operator. The setting will be displayed if the conditional\u2019s `value` property is equal to the selected value of the `selectOptions`. ",
      "example": "IN"
    },
    "value": {
      "type": "array",
      "description": "A single-object array containing a value from the `typeMeta`'s `selectOptions`.",
      "items": {}
    }
  },
  "x-internal": false
}