Skip to content

FieldSelect

FieldSelect is a fully custom select field

type select

Basic example

Code
javascript
{
  name: 'cityExample',
  label: 'Which city is cool?', 
  model: 'city', 
  type: 'select', 
  options: [
    { name: 'San Francisco', value: 'SF' },
    { name: 'Amsterdam', value: 'AMS' },
    { name: 'New York', value: 'NYC' },
  ]
}
Selected:
Select an option

Multiple values

To allow for multiple values to be selected, simply add multiple: true to your field schema object.

Code
javascript
{
  name: 'cityExample',
  label: 'Which city is cool?', 
  model: 'city', 
  type: 'select',
  multiple: true, 
  options: [
    { name: 'San Francisco', value: 'SF' },
    { name: 'Amsterdam', value: 'AMS' },
    { name: 'New York', value: 'NYC' },
  ]
}
Selected:
Select an option

Properties

Shared properties
PropertyDefaultTypeDescription
name-stringName of the field
model-stringKey of model in the form schema model
label-stringLabel for the field
type-stringType of field, generally input if the field is an input.
inputType-stringType of input, only required when type === 'input'
idcomputedstringid of the field
visibletrueBoolean | FunctionWhether the field is visible, method will be passed the model, field and field component*
requiredfalseBoolean | FunctionWhether the field is required, method will be passed the model, field and field component*
readonlyfalseBoolean | FunctionWhether the field is read only, method will be passed the model, field and field component*
disabledfalseBoolean | FunctionWhether the field is disabled, method will be passed the model, field and field component*
hint-string | FunctionHint to display underneath the field, can be passed a method*
validatorcomputedArray<Function> | Function | undefinedA (list of) validator(s) to be validating the field against.
onValidated-Function | undefinedMethod to be called after validation has been completed.

* see determineDynamicAttribute() for more information.

PropertyDefaultTypeDescription
multiplefalsebooleanDetermine if user can select multiple values
options-Option[]Selectable options