FieldWidgetProps.json

{
  "$ref": "#/definitions/FieldWidgetProps",
  "definitions": {
    "FieldWidgetProps": {
      "type": "object",
      "properties": {
        "value": {
          "description": "Current field value"
        },
        "readonly": {
          "type": "boolean",
          "default": false,
          "description": "Read-only mode flag"
        },
        "required": {
          "type": "boolean",
          "default": false,
          "description": "Required field flag"
        },
        "error": {
          "type": "string",
          "description": "Validation error message"
        },
        "field": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "pattern": "^[a-z_][a-z0-9_]*$",
              "description": "Machine name (snake_case)"
            },
            "label": {
              "type": "string",
              "description": "Human readable label"
            },
            "type": {
              "type": "string",
              "enum": [
                "text",
                "textarea",
                "email",
                "url",
                "phone",
                "password",
                "markdown",
                "html",
                "richtext",
                "number",
                "currency",
                "percent",
                "date",
                "datetime",
                "time",
                "boolean",
                "select",
                "lookup",
                "master_detail",
                "image",
                "file",
                "avatar",
                "formula",
                "summary",
                "autonumber",
                "location",
                "geolocation",
                "address",
                "code",
                "color",
                "rating",
                "slider",
                "signature",
                "qrcode"
              ],
              "description": "Field Data Type"
            },
            "description": {
              "type": "string",
              "description": "Tooltip/Help text"
            },
            "format": {
              "type": "string",
              "description": "Format string (e.g. email, phone)"
            },
            "required": {
              "type": "boolean",
              "default": false,
              "description": "Is required"
            },
            "searchable": {
              "type": "boolean",
              "default": false,
              "description": "Is searchable"
            },
            "multiple": {
              "type": "boolean",
              "default": false,
              "description": "Allow multiple values (Stores as Array/JSON). Applicable for select, lookup, file, image."
            },
            "unique": {
              "type": "boolean",
              "default": false,
              "description": "Is unique constraint"
            },
            "defaultValue": {
              "description": "Default value"
            },
            "maxLength": {
              "type": "number",
              "description": "Max character length"
            },
            "minLength": {
              "type": "number",
              "description": "Min character length"
            },
            "precision": {
              "type": "number",
              "description": "Total digits"
            },
            "scale": {
              "type": "number",
              "description": "Decimal places"
            },
            "min": {
              "type": "number",
              "description": "Minimum value"
            },
            "max": {
              "type": "number",
              "description": "Maximum value"
            },
            "options": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "label": {
                    "type": "string",
                    "description": "Display label"
                  },
                  "value": {
                    "type": "string",
                    "description": "Stored value"
                  },
                  "color": {
                    "type": "string",
                    "description": "Color code for badges/charts"
                  },
                  "default": {
                    "type": "boolean",
                    "description": "Is default option"
                  }
                },
                "required": [
                  "label",
                  "value"
                ],
                "additionalProperties": false
              },
              "description": "Static options for select/multiselect"
            },
            "reference": {
              "type": "string",
              "description": "Target Object Name"
            },
            "referenceFilters": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Filters applied to lookup dialogs (e.g. \"active = true\")"
            },
            "writeRequiresMasterRead": {
              "type": "boolean",
              "description": "If true, user needs read access to master record to edit this field"
            },
            "deleteBehavior": {
              "type": "string",
              "enum": [
                "set_null",
                "cascade",
                "restrict"
              ],
              "default": "set_null",
              "description": "What happens if referenced record is deleted"
            },
            "expression": {
              "type": "string",
              "description": "Formula expression"
            },
            "formula": {
              "type": "string",
              "description": "Deprecated: Use expression"
            },
            "summaryOperations": {
              "type": "object",
              "properties": {
                "object": {
                  "type": "string"
                },
                "field": {
                  "type": "string"
                },
                "function": {
                  "type": "string",
                  "enum": [
                    "count",
                    "sum",
                    "min",
                    "max",
                    "avg"
                  ]
                }
              },
              "required": [
                "object",
                "field",
                "function"
              ],
              "additionalProperties": false,
              "description": "Roll-up summary definition"
            },
            "language": {
              "type": "string",
              "description": "Programming language for syntax highlighting (e.g., javascript, python, sql)"
            },
            "theme": {
              "type": "string",
              "description": "Code editor theme (e.g., dark, light, monokai)"
            },
            "lineNumbers": {
              "type": "boolean",
              "description": "Show line numbers in code editor"
            },
            "maxRating": {
              "type": "number",
              "description": "Maximum rating value (default: 5)"
            },
            "allowHalf": {
              "type": "boolean",
              "description": "Allow half-star ratings"
            },
            "displayMap": {
              "type": "boolean",
              "description": "Display map widget for location field"
            },
            "allowGeocoding": {
              "type": "boolean",
              "description": "Allow address-to-coordinate conversion"
            },
            "addressFormat": {
              "type": "string",
              "enum": [
                "us",
                "uk",
                "international"
              ],
              "description": "Address format template"
            },
            "colorFormat": {
              "type": "string",
              "enum": [
                "hex",
                "rgb",
                "rgba",
                "hsl"
              ],
              "description": "Color value format"
            },
            "allowAlpha": {
              "type": "boolean",
              "description": "Allow transparency/alpha channel"
            },
            "presetColors": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Preset color options"
            },
            "step": {
              "type": "number",
              "description": "Step increment for slider (default: 1)"
            },
            "showValue": {
              "type": "boolean",
              "description": "Display current value on slider"
            },
            "marks": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              },
              "description": "Custom marks/labels at specific values (e.g., {0: \"Low\", 50: \"Medium\", 100: \"High\"})"
            },
            "barcodeFormat": {
              "type": "string",
              "enum": [
                "qr",
                "ean13",
                "ean8",
                "code128",
                "code39",
                "upca",
                "upce"
              ],
              "description": "Barcode format type"
            },
            "qrErrorCorrection": {
              "type": "string",
              "enum": [
                "L",
                "M",
                "Q",
                "H"
              ],
              "description": "QR code error correction level (L=7%, M=15%, Q=25%, H=30%). Only applicable when barcodeFormat is \"qr\""
            },
            "displayValue": {
              "type": "boolean",
              "description": "Display human-readable value below barcode/QR code"
            },
            "allowScanning": {
              "type": "boolean",
              "description": "Enable camera scanning for barcode/QR code input"
            },
            "currencyConfig": {
              "type": "object",
              "properties": {
                "precision": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 10,
                  "default": 2,
                  "description": "Decimal precision (default: 2)"
                },
                "currencyMode": {
                  "type": "string",
                  "enum": [
                    "dynamic",
                    "fixed"
                  ],
                  "default": "dynamic",
                  "description": "Currency mode: dynamic (user selectable) or fixed (single currency)"
                },
                "defaultCurrency": {
                  "type": "string",
                  "minLength": 3,
                  "maxLength": 3,
                  "default": "CNY",
                  "description": "Default or fixed currency code (ISO 4217, e.g., USD, CNY, EUR)"
                }
              },
              "additionalProperties": false,
              "description": "Configuration for currency field type"
            },
            "hidden": {
              "type": "boolean",
              "default": false,
              "description": "Hidden from default UI"
            },
            "readonly": {
              "type": "boolean",
              "default": false,
              "description": "Read-only in UI"
            },
            "encryption": {
              "type": "boolean",
              "default": false,
              "description": "Encrypt at rest"
            },
            "index": {
              "type": "boolean",
              "default": false,
              "description": "Create standard database index"
            },
            "externalId": {
              "type": "boolean",
              "default": false,
              "description": "Is external ID for upsert operations"
            }
          },
          "required": [
            "type"
          ],
          "additionalProperties": false,
          "description": "Field schema definition"
        },
        "record": {
          "type": "object",
          "additionalProperties": {},
          "description": "Complete record data"
        },
        "options": {
          "type": "object",
          "additionalProperties": {},
          "description": "Custom widget options"
        }
      },
      "required": [
        "field"
      ],
      "additionalProperties": false
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}