The object field.


TitleObject Field
DescriptionObject field for containing other fields
JSON Schema Type(s)object
Field Typeobject
Base Field TypeNone


defaultanyThe 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.
dependenciesarrayList of property dependencies.
descriptionstringDetailed description of the property.
disallowarrayList of disallowed values for the property.
formatstringData format of the property.
maxPropertiesnumberThe maximum number of properties that this object is allowed to have
minPropertiesnumberThe minimum number of properties that this object is required to have
propertiesobjectList of child properties.
readonlybooleanIndicates 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 displayReadonly attribute set to false, the read-only field will not appear.
requiredbooleanIndicates 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.
titlestringShort description of the property.
typestringobjectData type of the property.


fieldsobjectList of options for child fields.

Example 1

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.

Example 2

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.

Example 3

Here is a more complex example that provides the data, schema and options for all of the sub-fields of the object.

Example 4

Object field with schema, options and view parameter.

Example 5

Object field with default value.

Example 6

Object field with lazy loading option. The lazy loading option is useful for improving performance of rendering forms for large schemas.

Example 7

Object field rendered in display-only mode. The gender field is hidden.

Example 8

Object with a required field specified at the field level.

Example 9

Object with a required field specified at the object-level.

Example 10

Object that utilizes field-level order property to apply an order to child fields.

Example 11

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.

© 2017 Gitana Software, Inc.

Alpaca is sponsored by