Main Website →
Balloon Selector Field
Form Field
The balloon-selector field renders a list, where only one item can be selected at a time.
Balloon selectors support the same methods for defining the options as the dropdown field type.
gender:
type: balloon-selector
label: Gender
options:
female: Female
male: Male
The following field properties are commonly used.
| Property | Description |
|---|---|
| label | a name when displaying the form field to the user. |
| default | a default value to use for new records. |
| comment | places a descriptive comment below the field. |
| options | available options for the dropdown, as an array. |
| optionsMethod | take options from a method defined on the model or as a static method, eg Class::method. |
| allowEmpty | allows the selection to be unset by clicking on the active item, default: false. |
You may use the default property to set a default value, where the value is the key of the option.
gender:
type: balloon-selector
label: Gender
default: female
Set the allowEmpty property to true to allow the user to set an empty value by unselecting the active item.
gender:
type: balloon-selector
label: Gender
allowEmpty: true