@camunda/element-templates-json-schema-shared/src/defs/base-properties.json

Shared schema definitions used within element-templates-json-schema

{
  "type": "array",
  "description": "List of properties of the element template.",
  "allOf": [
    { "$ref": "examples.json#/properties" }
  ],
  "items": {
    "type": "object",
    "default": {},
    "allOf": [
      {
        "if": {
          "properties": {
            "type": {
              "const": "Dropdown"
            }
          },
          "required": [
            "type"
          ]
        },
        "then": {
          "required": [
            "choices"
          ]
        }
      },
      {
        "$ref": "condition.json"
      },
      {
        "if": {
          "properties": {
            "type": {
              "not": {
                "const": "Number"
              }
            }
          },
          "required": [
            "type"
          ]
        },
        "then": {
          "properties": {
            "value": {
              "type": [
                "string",
                "boolean"
              ]
            }
          }
        }
      },
      {
        "if": {
          "oneOf": [
            {
              "properties": {
                "type": {
                  "enum": [
                    "String",
                    "Text"
                  ]
                }
              },
              "required": [
                "type"
              ]
            },
            {
              "not": {
                "required": [
                  "type"
                ]
              }
            }
          ]
        },
        "then": {
          "properties": {
            "placeholder": {
              "type": "string"
            }
          }
        },
        "else": {
          "not": {
            "required": [
              "placeholder"
            ]
          }
        }
      }
    ],
    "properties": {
      "value": {
        "$id": "#/properties/property/value",
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "The value of a control field."
      },
      "description": {
        "$id": "#/properties/property/description",
        "type": "string",
        "description": "The description of a control field."
      },
      "label": {
        "$id": "#/properties/property/label",
        "type": "string",
        "description": "The label of a control field."
      },
      "type": {
        "$id": "#/properties/property/type",
        "type": "string",
        "description": "The type of a control field."
      },
      "editable": {
        "$id": "#/properties/property/editable",
        "type": "boolean",
        "description": "Indicates whether a control field is editable or not."
      },
      "choices": {
        "$id": "#/properties/property/choices",
        "type": "array",
        "description": "The choices for dropdown fields.",
        "default": [],
        "items": {
          "$id": "#/properties/property/choices/item",
          "type": "object",
          "default": {},
          "properties": {
            "name": {
              "$id": "#/properties/property/choices/item/name",
              "type": "string",
              "description": "The name of a choice."
            },
            "value": {
              "$id": "#/properties/property/choices/item/value",
              "type": "string",
              "description": "The value of a choice."
            },
            "condition": {
              "$ref": "condition.json#/properties/condition"
            }
          },
          "required": [
            "value",
            "name"
          ]
        }
      },
      "constraints": {
        "$id": "#/properties/property/constraints",
        "type": "object",
        "description": "The validation constraints of a control field.",
        "allOf": [
          { "$ref": "examples.json#/constraints" }
        ],
        "properties": {
          "notEmpty": {
            "$id": "#/properties/property/constraints/notEmpty",
            "type": "boolean",
            "description": "The control field must not be empty."
          },
          "minLength": {
            "$id": "#/properties/property/constraints/minLength",
            "type": "number",
            "description": "The minimal length of a control field value."
          },
          "maxLength": {
            "$id": "#/properties/property/constraints/maxLength",
            "type": "number",
            "description": "The maximal length for a control field value."
          },
          "pattern": {
            "$id": "#/properties/property/constraints/pattern",
            "description": "A regular expression pattern for a constraint.",
            "oneOf": [
              {
                "type": "object",
                "default": {},
                "properties": {
                  "value": {
                    "$id": "#/properties/property/constraints/pattern/value",
                    "type": "string",
                    "description": "The regular expression of a pattern."
                  },
                  "message": {
                    "$id": "#/properties/property/constraints/pattern/message",
                    "type": "string",
                    "description": "The validation message of a pattern."
                  }
                }
              },
              {
                "type": "string"
              }
            ]
          }
        }
      },
      "group": {
        "$id": "#/properties/property/group",
        "type": "string",
        "description": "The custom group of a control field."
      }
    }
  }
}