The select field.

Properties

TitleSelect Field
DescriptionSelect Field
Field Typeselect
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 field value options
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.
typestringData type of the property.

Options

PropertyTypeDefaultDescription
dataSourcestringDatasource 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.
emptySelectFirstbooleanIf the data is empty, then automatically select the first item in the list.
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.
hideNonebooleanWhether to hide the None option from a list (select, radio or otherwise). This will be true if the field is required and false otherwise.
idstringUnique field id. Auto-generated if not provided.
labelstringField label.
multiplebooleanAllow multiple selection if true.
multiselectanyMultiselect plugin properties - http://davidstutz.github.io/bootstrap-multiselect
namestringField Name.
noneLabelstringNoneThe label to use for the 'None' option in a list (select, radio or otherwise).
optionLabelsarrayAn array of string labels for items in the enum array
readonlybooleanField will be readonly if true.
removeDefaultNonebooleanIf true, the default 'None' option will not be shown.
showMessagesbooleantrueDisplay validation messages if true.
sizenumberNumber of options to be shown.
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.
typestringselectField 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

Select field with data, options and schema parameters. As default, a select field will be rendered if schema enum property has more than 3 options. The sort order for enumerated values and their text are assumed to be alphanumeric.

Example 2

Here is the same select field but labels in French. The important thing to note is that the schema stays the same. The options change, letting you customize forms into different languages.

In addition, we apply a custom sort here using the options.sort override. This lets us plug in a custom sort function. Here we reverse the order.

Note: If you want to disable sorting, set sort to false. Or, if you wish to disable sorting for all of your enumerated fields, set Alpaca.defaultSort to false. See the example below! to false

Example 3

Select field with options loaded from external data source.

Example 4

Multiple select field with options loaded from external data source.

Example 5

Select field with an onField event listener option that reacts to select change event.

Example 6

Multiple select field for array data. Note that when using multiple select mode, the hideNone option will default to true.

Example 7

Select field in display-only mode

Example 8

Multiple select field that works with a local data source file (array of string values).

Example 9

Multiple select field that works with a local data source file (array of object values).

Example 10

Multiple select field that works with an inline datasource function.

Example 11

Multiple select field that works with an inline datasource function.

Example 12

A select field that uses the removeDefaultNone option to remove the option for the end user to select None from the list of available options.

Note that if the property that the field describes is required for data integrity to be maintained, consider setting the property schema's required setting to true. This produces the same effect and also allows your data to validate appropriately.

Example 13

A select field that is required but which keeps the None option. By default, required fields do not have a None option. Here we set the removeDefaultNone option to false explicitly so that the none option still appears.

This also changes the label from "None" to "-- Select --".

Example 14

A multi-select field with numeric selects.

## Example 15 Here is an example where we explicitly disable sorting. We do this within the field configuration. We could also do this by globally setting Alpaca.defaultSort to false.

© 2016 Gitana Software, Inc.

Alpaca is sponsored by