Files

143 lines
4.5 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"label": {
"type": "string",
"description": "The field label displayed in the edit screen",
"minLength": 1
},
"type": {
"type": "string",
"enum": [
"checkbox"
],
"description": "Field type identifier. Must be \"checkbox\" for this field type."
},
"name": {
"type": "string",
"description": "The field name used to save/load data. Auto-generated from label if not provided.",
"pattern": "^[a-z_][a-z0-9_]*$"
},
"key": {
"type": "string",
"description": "Unique field key. Auto-generated if not provided.",
"pattern": "^field_[a-z0-9]+$"
},
"instructions": {
"type": "string",
"description": "Instructions displayed to editors below the field label"
},
"required": {
"type": "boolean",
"description": "Whether this field is required",
"default": false
},
"conditional_logic": {
"type": [
"boolean",
"array"
],
"description": "Conditional logic rules. Set to false to disable, or provide rules array.",
"default": false
},
"wrapper": {
"type": "object",
"description": "HTML wrapper attributes",
"properties": {
"width": {
"type": "string",
"description": "Width percentage (e.g., \"50\")"
},
"class": {
"type": "string",
"description": "Custom CSS classes"
},
"id": {
"type": "string",
"description": "Custom HTML ID"
}
}
},
"default_value": {
"type": [
"string",
"number",
"boolean",
"null"
],
"description": "Default value when creating new content"
},
"placeholder": {
"type": "string",
"description": "Placeholder text shown in empty fields"
},
"prepend": {
"type": "string",
"description": "Text to prepend before the input"
},
"append": {
"type": "string",
"description": "Text to append after the input"
},
"maxlength": {
"type": "integer",
"description": "Maximum character length (if applicable)",
"minimum": 1
},
"allow_in_bindings": {
"type": "boolean",
"description": "Whether this field can be used in block bindings",
"default": false
},
"choices": {
"type": "object",
"description": "Available choices for the checkbox field. Object with key-value pairs where keys are saved values and values are display labels (e.g., {\"red\": \"Red\", \"blue\": \"Blue\"})"
},
"layout": {
"type": "string",
"description": "Layout orientation of checkboxes",
"enum": [
"vertical",
"horizontal"
],
"default": "vertical"
},
"allow_custom": {
"type": "boolean",
"description": "Allow users to add custom choices",
"default": false
},
"save_custom": {
"type": "boolean",
"description": "Save custom choices as new choice options",
"default": false
},
"toggle": {
"type": "boolean",
"description": "Display a \"Toggle All\" checkbox",
"default": false
},
"return_format": {
"type": "string",
"description": "Format of returned value",
"enum": [
"value",
"label",
"array"
],
"default": "value"
},
"custom_choice_button_text": {
"type": "string",
"description": "Text for the \"Add new choice\" button when allow_custom is enabled",
"default": "Add new choice"
}
},
"required": [
"label",
"type",
"choices"
]
}