Schema Options

x-addPropertyContent

Type: boolean

Text content for "add property" buttons.

x-arrayAdd

Type: boolean

Default: true

If array "add" buttons should be displayed.

x-arrayAddContent

Type: boolean

Text content for array "add" buttons.

x-arrayDelete

Type: boolean

Default: true

If array "delete" buttons should be displayed.

x-arrayDeleteContent

Type: boolean

Text content for array "delete" buttons.

x-arrayDragContent

Type: boolean

Text content for array "drag" buttons.

x-arrayMove

Type: boolean

Default: true

If array "move up" and "move down" buttons should be displayed.

x-arrayMoveDownContent

Type: boolean

Text content for array "move down" buttons.

x-arrayMoveUpContent

Type: boolean

Text content for array "move up" buttons.

x-assertFormat

Type: boolean

Default: false

Treats "format" as a validator rather than just an annotation.

x-collapseToggleContent

Type: boolean

Text content for "collapse" buttons.

x-containerAttributes

Type: object

Editors container HTML attributes can be set using this option. Attributes such as class or data-* will be applied to the container element.

x-deactivateNonRequired

Type: boolean

Whether the editor should deactivate (hide) or activate (show) non required properties. Works only with object type editors.

x-editJsonData

Type: boolean

Default: false

Enables inline JSON editing mode for this specific schema, allowing users to directly edit the JSON data within form fields.

{
  "x-editJsonData": true,
  "type": "object",
  "title": "Edit JSON Data",
  "description": "This object has 'x-editJsonData: true' which enables inline JSON editing.",
  "properties": {
    "name": {
      "type": "string",
      "title": "Name"
    },
    "description": {
      "type": "string",
      "title": "Description"
    }
  }
}

x-enableCollapseToggle

Type: boolean

Display a collapse button used to collapse or expand editors that support collapse like object and arrays.

x-enforceConst

Type: boolean

Default: true

Value will remain whatever is defined in schema "const".

x-enforceEnum

Type: boolean

Default: true

Whether the editor initial value will be the first item in the "enum".

x-enumTitles

Type: string[]

Used to display user-friendly labels in the editor instead of those listed in "enum".

x-format

Type: string

Determines which editor UI will be used to edit the json instance.

x-grid

Type: object

A configuration object to determine the position of the property editor in the parent's grid.

Options:

• columns: How many columns should the editor occupy. The number of columns can vary between css frameworks and their configuration.
• offset: How many columns should the editor be offsetted
• newRow: Whether the editor should be put in a new row

x-hidden

Type: boolean

Editors can be hidden using this option. When set to true, the editor is hidden.

x-info

Type: object

Used to display extra information.

Options:

• variant: "modal"
• title: Plain text or markdown
• content: Plain text or markdown

x-inputAttributes

Type: object

Used to set attributes for the editor input if it has one.

x-messages

Type: object | string[]

Validation error messages can be customized using this option in the schema. The option can be used in different ways:

Array format

Pass messages as an array of strings:

{
  "type": "string",
  "minLength": 5,
  "x-messages": [
    "5 chars please."
  ]
}

Object format with validation keywords

Pass messages as an object with validation keywords as keys:

{
  "type": "string",
  "minLength": 5,
  "const": "locoloco",
  "x-messages": {
    "minLength": "Need at least 5 sparks of brilliance.",
    "const": "Only 'locoloco' unlocks the magic here."
  }
}

Internationalization format

Pass messages with language codes for internationalization support:

{
  "type": "string",
  "minLength": 5,
  "const": "locoloco",
  "x-messages": {
    "en": {
      "minLength": "Need at least 5 sparks of brilliance.",
      "const": "Only 'locoloco' unlocks the magic here."
    }
  }
}

x-propertiesToggleContent

Type: boolean

Text content for "properties" buttons.

x-showErrors

Type: string

Default: "change"

Options: "never", "change", "input", "always"

Determines when to display validation errors for this specific schema. Overrides the instance-level showErrors setting.

Note: The "input" option provides real-time validation as the user types, but only affects text-based inputs (string inputs, textareas, number inputs).

x-sortable

Type: boolean

Default: false

Items can be sorted via drag and drop if Sortable.js is available.

x-startCollapsed

Type: boolean

Whether the editor should start expanded or collapsed. Works on editors that support collapse like object and arrays.

x-switcherTitle

Type: string

Default: property name or "title"

The text displayed in the multiple editor switcher to select this sub-schema editor.

x-titleHidden

Type: boolean

Default: false

Hides the editor title.

x-titleIconClass

Type: string

Icon class to use in titles if using any.

x-titleTemplate

Type: string

A template to form titles dynamically.