! -- header.html -->
Back to Documentation Home
|Description||Object field for containing other fields|
|JSON Schema Type(s)||object|
|Base Field Type||None|
|default||any||The default value to be assigned for this property. If the data for the field is empty or not provided, this default value will be plugged in for you. Specify a default value when you want to pre-populate the field's value ahead of time.|
|dependencies||array||List of property dependencies.|
|description||string||Detailed description of the property.|
|disallow||array||List of disallowed values for the property.|
|format||string||Data format of the property.|
|maxProperties||number||The maximum number of properties that this object is allowed to have|
|minProperties||number||The minimum number of properties that this object is required to have|
|properties||object||List of child properties.|
|readonly||boolean||Indicates that the field is read-only. A read-only field cannot have it's value changed. Read-only fields render in a grayed-out or disabled control. If the field is rendered using a view with the |
|required||boolean||Indicates whether the field's value is required. If set to true, the field must take on a valid value and cannnot be left empty or unassigned.|
|title||string||Short description of the property.|
|type||string||object||Data type of the property.|
|collapsible||boolean||Field set is collapsible if true.|
|fields||object||List of options for child fields.|
A simple object field. If you give Alpaca an object as it's data, it automatically figures out what to do and sets up both sub-fields for you.
Here we provide a schema to go along with our data. The schema simply provides a bit more information about the two sub-fields, such as their type and labels.
Here is a more complex example that provides the data, schema and options for all of the sub-fields of the object.
Object field with schema, options and view parameter.
Object field with default value.
Object field with lazy loading option. The lazy loading option is useful for improving performance of rendering forms for large schemas.
Object field rendered in display-only mode. The
gender field is hidden.
Object with a required field specified at the field level.
Object with a required field specified at the object-level.
Object that utilizes field-level
order property to apply an order to child fields.
Here is an example of an object field where we use a top-level layout and a nested override of the view to force the email address into display mode only.