The object field.
Properties
| Title | Object Field |
| Description | Object field for containing other fields |
| JSON Schema Type(s) | object |
| Field Type | object |
| Base Field Type | None |
Schema
| Property | Type | Default | Description |
|---|---|---|---|
| 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 displayReadonly attribute set to false, the read-only field will not appear. | |
| 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. |
Options
| Property | Type | Default | Description |
|---|---|---|---|
| collapsible | boolean | Field set is collapsible if true. | |
| fields | object | List 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.