Allows the user to select from a range of options.
- `allowReorder`
bool
Whether selected tags can be reordered by dragging them.
Default = true
- `as`
string
The name of the variable to be registered for each option. For example, as="myvar" will let you reference $myvar inside the control.
- `autoFocus`
bool
Auto Focus
If true, this control will attempt to focus itself after the page has loaded. Note that only one element may be focused on the page at a time.
Default = false
- `createColumn`
string
The field of createcomponent the typed text is saved into, for example post_category_title.
- `createComponent`
string
The component new entities are created in when the user types something which isn't in the list, for example \Components\Website\Posts\Categories.
The user must hold save permission on the component; creation is refused otherwise.
- `createValues`
array
Additional fixed values applied to entities created through createcomponent, as a column => value array. Use it to scope new entities, for example to a parent.
- `dataColumn`
Sets the data column
The datacolumn links the form item to a key used when getting or saving from a component (as defined by the parent form).
- `disabled`
bool
Disable Input
Disables the input, preventing user interaction
- `hasPrimary`
bool
Whether the first selected option is treated as the primary one. The first tag is badged, and tags can be dragged or promoted to first place.
Only applies when multiple is set.
Default = false
- `height`
string
Height
Sets the height of the element. The default units are pixels. include the percentage symbol % to user percentage values.
- `id`
string
Most form items need a unique id so that they can submit data to the server. No two form items may have the same id. For situations where multiple form items submit to the same field, see the
name attribute. Id's that begin with
contact_ will automatically save Contact information to the Contact database as long as the user has entered enough identifying information (ideally Name and Email). Check the
Contact Fields page for correct field names.
- `keyAs`
string
The name of the variable to be registered for each option's key.
For arrays of entities from the database (for example getAll()), the keys will be incrementing integers starting at 0.
- `maxSelections`
int
The maximum number of options that may be selected. 0 for no limit.
Default = 0
- `multiple`
bool
Allows more than one option to be selected. Selected options appear as tags inside the box, and the value submitted is the selected values in order, comma separated.
Default = false
- `name`
string
Sets the name of the form item. Most of the time, the id attribute will suffice. However, with form items that post multiple values into an array, each item will need to have the same name, followed by []. For example three controls with name="data[]", will all post into 'data'.
Radio buttons belonging to the same group will have to share the same name.
An empty name="" leaves the item unnamed, so the browser never posts it to the server (e.g. card fields a payment gateway tokenizes in the browser).
- `primaryDataColumn`
string
The datacolumn which stores the primary selection, when it is held in a column of its own rather than being implied by the order of the submitted list. When set, the control also submits the first selected value to that column.
Only applies when multiple and hasprimary are set.
- `saveState`
bool
Restore state on reload
Whether the value of the input persists when the page is revisited.
Default = false
- `showValueOption`
bool
If the value not a contact of the datasource or in the list of options, should it be allowed
- `transformations`
Value Transformations
Sets the value transformations to be applied to the value of the form item as a comma separated string.
- `tree`
bool
Renders hierarchical options as an indented tree with expand / collapse controls.
Set automatically when datasourcerecursive is used.
- `validations`
Validations
Sets the validations to be applied to the value of the form item as a comma separated string.
Eg: validations="mandatory"
When no validations attribute value is set, the form item is optional.
- `width`
string
Width
Sets the width of the element. The default units are pixels. include the percentage symbol % to user percentage values.
