Email¶
The "Email" type generates an <input>
field, specified for entry of email
addresses only.
This type adds a server-side validation of an email address. If the input does
not contain a valid email address, a flash message warning will be displayed.
It corresponds with the TCA type='input'
(default) and eval='email'
.
Properties¶
- autocomplete
| Required: false | Type: boolean | Default: 'false' |
Controls the autocomplete attribute of a given input field. If set to true (default false), adds attribute autocomplete="on" to the input field allowing browser auto filling the field.
- default
| Required: false | Type: string | Default: '' |
Default value set if a new record is created.
- placeholder
| Required: false | Type: string | Default: '' |
Placeholder text for the field.
- size
| Required: false | Type: integer | Default: '20' |
Abstract value for the width of the
<input>
field.- required
| Required: false | Type: boolean | Default: 'false' |
If set, the field will become mandatory.
- trim
| Required: false | Type: boolean | Default: 'false' |
If set, the PHP trim function is applied on the field's content.
- valuePicker
| Required: false | Type: array | Default: '' |
Renders a select box with static values next to the input field. When a value is selected in the box, the value is transferred to the field. Keys:
- items (array)
An array with selectable items. Each item is an array with the first being the value transferred to the input field, and the second being the label in the select drop-down (LLL reference possible).
Example:
valuePicker: items: 'contact_1@example.com': Contact 1 'contact_2@example.com': Contact 2 'contact_3@example.com': Contact 3
Example¶
group: common
fields:
- identifier: email
type: Email
properties:
autocomplete: true
default: 'developer@localhost'
placeholder: 'Enter your email address'
size: 20
required: true
trim: true
valuePicker:
items:
'contact_1@example.com': Contact 1
'contact_2@example.com': Contact 2
'contact_3@example.com': Contact 3