Properties

Property	Description	Type	Field Model Mapping
type	Schema type	SchemaTypes	GeneralField
title	Title	depends on the binding library	`title`
description	Description	depends on the binding library	`description`
default	Default value	`any`	`initialValue`
readOnly	Read-only flag	`boolean`	`readOnly`
writeOnly	Write-only flag	`boolean`	`editable`
enum	Enum options	SchemaEnum	`dataSource`
const	Validates equality with the given `const` value	`any`	`validator`
multipleOf	Validates divisibility by `multipleOf`	`number`	`validator`
maximum	Maximum value validation (`>`)	`number`	`validator`
exclusiveMaximum	Maximum value validation (`>=`)	`number`	`validator`
minimum	Minimum value validation (`<`)	`number`	`validator`
exclusiveMinimum	Minimum value validation (`<=`)	`number`	`validator`
maxLength	Maximum string length	`number`	`validator`
minLength	Minimum string length	`number`	`validator`
pattern	Pattern validation rule	RegExpString	`validator`
maxItems	Maximum item count	`number`	`validator`
minItems	Minimum item count	`number`	`validator`
uniqueItems	Whether duplicated items are forbidden	`boolean`	`validator`
maxProperties	Maximum property count	`number`	`validator`
minProperties	Minimum property count	`number`	`validator`
required	Required flag	`boolean`	`validator`
format	Built-in format validator	ValidatorFormats	`validator`
properties	Object property schemas	SchemaProperties	-
items	Array item schema	SchemaItems	-
additionalItems	Extra array item schema	Schema	-
patternProperties	Dynamic property schemas matched by pattern	SchemaProperties	-
additionalProperties	Schema for unmatched object properties	Schema	-
x-index	UI display order	`number`	-
x-pattern	UI interaction pattern	FieldPatternTypes	`pattern`
x-display	UI display mode	FieldDisplayTypes	`display`
x-validator	Field validator	FieldValidator	`validator`
x-decorator	Field UI decorator component	depends on the binding library	`decorator`
x-decorator-props	Field UI decorator props	`any`	`decorator`
x-component	Field UI component	depends on the binding library	`component`
x-component-props	Field UI component props	`any`	`component`
x-reactions	Field linkage protocol	SchemaReactions	`reactions`
x-content	Field content passed as component children	depends on the binding library	depends on the binding library
x-visible	Field visibility flag	`boolean`	`visible`
x-hidden	Hide field UI but keep data	`boolean`	`hidden`
x-disabled	Disable field	`boolean`	`disabled`
x-editable	Editable flag	`boolean`	`editable`
x-read-only	Read-only flag	`boolean`	`readOnly`
x-read-pretty	Read-pretty mode	`boolean`	`readPretty`
definitions	Predefined schema collection	SchemaProperties	-
$ref	Reads a predefined schema and merges it in place	String	-
x-data	Extra extension data	Object	`data`

Notes

The x-component identifier must match a key from the component registry passed to createSchemaField
The x-decorator identifier must match a key from the decorator registry passed to createSchemaField
Every Schema property can use string expressions in the form of {{expression}}; scope variables can come from both createSchemaField and the SchemaField component
$ref must use the predefined schema format #/definitions/address; loading remote JSON Schema is not supported

Properties ​

Notes ​

Properties

Notes