The checkbox field.

Properties

TitleCheckbox Field
DescriptionCheckbox Field for boolean (true/false), string ('true', 'false' or comma-delimited string of values) or data array.
JSON Schema Type(s)boolean
Field Typecheckbox
Base Field TypeNone

Schema

PropertyTypeDefaultDescription
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.
enumarrayList of specific values for this property
formatstringData format of the property.
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.
typestringbooleanData type of the property.

Options

PropertyTypeDefaultDescription
dataSourcestringData source for generating list of options. This can be a string or a function. If a string, it is considered to be a URI to a service that produces a object containing key/value pairs or an array of elements of structure {'text': '', 'value': ''}. This can also be a function that is called to produce the same list.
disabledbooleanField will be disabled if true.
fieldClassstringSpecifies one or more CSS classes that should be applied to the dom element for this field once it is rendered. Supports a single value, comma-delimited values, space-delimited values or values passed in as an array.
focuscheckboxtrueIf true, the initial focus for the form will be set to the first child element (usually the first field in the form). If a field name or path is provided, then the specified child field will receive focus. For example, you might set focus to 'name' (selecting the 'name' field) or you might set it to 'client/name' which picks the 'name' field on the 'client' object.
formobjectOptions for rendering the FORM tag.
helperstringField help message.
helpersarrayAn array of field help messages. Each message will be displayed on it's own line.
hiddenbooleanField will be hidden if true.
hideInitValidationErrorbooleanHide initial validation errors if true.
idstringUnique field id. Auto-generated if not provided.
labelstringField label.
multiplebooleanWhether to render multiple checkboxes for multi-valued type (such as an array or a comma-delimited string)
namestringField Name.
optionLabelsarrayAn array of string labels for items in the enum array
readonlybooleanField will be readonly if true.
rightLabelstringOptional right-hand side label for single checkbox field.
showMessagesbooleantrueDisplay validation messages if true.
sortfunctionDefines an f(a,b) sort function for the array of enumerated values [{text, value}]. This is used to sort enum and optionLabels as well as results that come back from any data sources (for select and radio controls). By default the items are sorted alphabetically. Don't apply any sorting if false.
typestringcheckboxField type.
useDataSourceAsEnumbooleantrueWhether to constrain the field's schema enum property to the values that come back from the data source.
validatebooleantrueField validation is required if true.
viewstringAllows for this field to be rendered with a different view (such as 'display' or 'create')

Example 1

Simple checkbox field for boolean data.

Example 2

Checkbox field with both field label and right label.

Example 3

Simple checkbox field rendered in display-only mode.

Example 4

Checkbox Field used for multiple values provided as an array.

Example 5

Checkbox Field used for multiple values provided as a comma-delimited string. We also hook up some form buttons to get at the JSON. Click the "View JSON" button to see it.

Example 6

Checkbox Field for multiple values with it's selection options loaded from a data source.

Example 7

A checkbox field that uses an enumerated value set on an array to specify the selection options. This is in accordance with JSON schema v4.

© 2016 Gitana Software, Inc.

Alpaca is sponsored by