Skip to main content
Light Dark System

Email

<et2-email> | Et2Email
Since 23.1

Enter email addresses, offering suggestions from contacts

<et2-email></et2-email>

Examples

Slots

Name Description
label The input’s label. Alternatively, you can use the label attribute.
prefix Used to prepend a presentational icon or similar element to the combobox.
suffix Like prefix, but after
help-text Text that describes how to use the input. Alternatively, you can use the help-text attribute.

Learn more about using slots.

Properties

Name Description Reflects Type Default
accesskey Accesskey provides a hint for generating a keyboard shortcut for the current element. The attribute value must consist of a single printable character. string -
align Used by Et2Box to determine alignment. Allowed values are left, right string -
allowDragAndDrop Allow drag and drop tags between two or more Et2Email widgets boolean | undefined true
allowPlaceholder Allow placeholders like {{email}}, as well as real email-addresses boolean -
autofocus Have browser focus this input on load. Overrides etemplate2.focusOnFirstInput(), use only once per page https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attributes boolean -
class CSS Class. This class is applied to the outside, on the web component itself. Due to how WebComponents work, this might not change anything inside the component. string -
data Set the dataset from a CSV string -
deferredProperties
Any attribute that refers to row content cannot be resolved immediately, but some like booleans cannot stay a string because it’s a boolean attribute. We store them for later, and parse when they’re fully in their row. If you are creating a widget that can go in a nextmatch row, and it has boolean attributes that can change for each row, add those attributes into deferredProperties - -
disabled Defines whether this widget is visibly disabled. The widget is still visible, but clearly cannot be interacted with. Widgets disabled in the template will not return a value to the application code, even if re-enabled via javascript before submitting. To allow a disabled widget to be re-enabled and return a value, disable via javascript in the app’s et2_ready() instead of an attribute in the template file. boolean false
dom_id
Get the actual DOM ID, which has been prefixed to make sure it’s unique. string -
emailDisplay What to display for the selected email addresses Et2EmailTag#emailDisplay "full" | "email" | "name" | "domain" -
hasFeedbackFor
Get a list of feedback types string[] -
helpText
help-text
The component’s help text. If you need to display HTML, use the help-text slot instead. string ''
hidden The widget is not visible. As far as the user is concerned, the widget does not exist. Widgets hidden with an attribute in the template may not be created in the DOM, and will not return a value. Widgets can be hidden after creation, and they may return a value if hidden this way. boolean -
id
Get the ID of the widget string -
includeLists Include mailing lists: returns them with their integer list_id boolean -
label The label of the widget Legacy support for labels with %s that get wrapped around the widget Not the best way go with webComponents - shouldn’t modify their DOM like this string -
noLang Disable any translations for the widget boolean -
open Indicates whether the suggestions are open. You can toggle this attribute to show and hide the menu, or you can use the show() and hide() methods and this attribute will reflect the suggestion open state. boolean false
parentId Parent is different than what is specified in the template / hierarchy. Widget ID of another node to insert this node into instead of the normal location string -
placeholder Placeholder text to show as a hint when the select is empty. string ''
rows Limit the maximum height of the widget, for when you have a lot of addresses. Set it to 1 for special single-line styling, 0 to disable number -
searchOptions Custom search options, passed to the searchUrl along with the search text {includeLists : boolean} {includeLists: true}
searchUrl Server-side search for suggested email addresses. Set to ”″ to cancel searching. string "EGroupware\Api\Etemplate\Widget\Taglist::ajax_email"
statustext Tooltip which is shown for this element on hover string -
styles
WebComponent * - -
translate
List of properties that get translated Done separately to not interfere with properties - if we re-define label property, labels go missing. - -
value The current value of the component, an array of valid email addresses. If allowPlaceholder=true, placeholders are also allowed string[] []
_tagsHidden
If the select is limited to 1 row, we show the number of tags not visible number 0
needed
Compatibility for deprecated name “needed”
use required instead
- -
options
Get property-values as object
use widget methods
object -
readOnly
Lion mapping
true
- -
supportedWidgetClasses
et2_widget compatability
Legacy compatability. Some legacy widgets check their parent to see whats allowed
array []
updateComplete A read-only promise that resolves when the component has finished updating.

Learn more about attributes and properties.

Events

Name React Event Description Event Detail
change Emitted when the control’s value changes. Event
sl-show Emitted when the suggestion menu opens. CustomEvent
sl-after-show Emitted after the suggestion menu opens and all animations are complete. CustomEvent
sl-hide Emitted when the suggestion menu closes. CustomEvent
sl-after-hide Emitted after the suggestion menu closes and all animations are complete. CustomEvent
sl-input Emitted when the control receives input. -
sl-focus Emitted when the control gains focus. -
sl-blur Emitted when the control loses focus. -

Learn more about events.

Methods

Name Description Arguments
addAddress() Create an entry that is not in the suggestions and add it to the value text: string
blur() Removes focus from the control. -
checkCreateNamespace() Checks whether a namespace exists for this element in the content array. If yes, an own perspective of the content array is created. If not, the parent content manager is used. Constructor attributes are passed in case a child needs to make decisions -
clone() Creates a copy of this widget. _parent: et2_widget
createElementFromNode() Create a et2_widget from an XML node. First the type and attributes are read from the node. Then the readonly & modifications arrays are checked for changes specific to the loaded data. Then the appropriate constructor is called. After the constructor returns, the widget has a chance to further initialize itself from the XML node when the widget’s loadFromXML() method is called with the node. _node: , _name:
et2HandleBlur() If the value is unchanged, put any held validation messages back Named et2HandleBlur to avoid overwriting handleBlur() in Shoelace components _ev: FocusEvent
et2HandleFocus() When input receives focus, clear any validation errors. If the value is the same on blur, we’ll put them back The ones from the server (ManualMessage) can interfere with submitting. Named et2HandleFocus to avoid overwriting handleFocus() in Shoelace components _ev: FocusEvent
focus() Sets focus on the control. options: FocusOptions
getArrayMgr() Returns the array manager object for the given part managed_array_type: string
getArrayMgrs() Returns an associative array containing the top-most array managers. _mgrs: object
getChildren() Get child widgets Use .children to get web component children -
getInputNode() Get input to e.g. set aria-attributes -
getInstanceManager() Returns the instance manager -
getPath() Returns the path into the data array. By default, array manager takes care of this, but some extensions need to override this -
getRoot() Returns the base widget Usually this is the same as getInstanceManager().widgetContainer -
handleComboboxKeyDown() Keyboard events that the search input did not grab (tags, otion navigation) event: KeyboardEvent
handlePaste() Sometimes users paste multiple comma separated values at once. Split them then handle normally. Overridden here to handle email addresses that may have commas using the regex from the validator. event: ClipboardEvent
handleSuggestionsKeyDown() Keyboard events from the suggestion list event: KeyboardEvent
handleSuggestionsMouseUp() Mouse up from the suggestion list event: MouseEvent
handleTagOverflow() Callback for the intersection observer so we know when tags don’t fit Here we set the flag to show how many more tags are hidden, but this only happens when there are more tags than space. entries: IntersectionObserverEntry[]
hide() Hides the listbox. -
isValid() Used by etemplate2 to determine if we can submit or not messages:
loadFromXML() Loads the widget tree from an XML node _node:
loadingFinished() Needed for legacy compatability. promises: Promise[]
optionTemplate() Used to render each option into the suggestions option: SelectOption
parseXMLAttrs() The parseXMLAttrs function takes an XML DOM attributes object and adds the given attributes to the _target associative array. This function also parses the legacyOptions. N.B. This is only used for legacy widgets. WebComponents use transformAttributes() and do their own handling of attributes. _attrsObj: , _target: object, _proto: et2_widget
set_label() NOT the setter, since we cannot add to the DOM before connectedCallback() TODO: This is not best practice. Should just set property, DOM modification should be done in render https://lit-element.polymer-project.org/guide/templates#design-a-performant-template value: string
setArrayMgr() Sets the array manager for the given part _part: string, _mgr: object
setArrayMgrs() Sets all array manager objects - this function can be used to set the root array managers of the container object. _mgrs: object
setInstanceManager() Set the instance manager Normally this is not needed as it’s set on the top-level container, and we just return that reference manager: etemplate2
show() Shows the listbox. -
startSearch() Start searching for contacts matching what has been typed -
submit() Called whenever the template gets submitted. We return false if the widget is not valid, which cancels the submission. _values:
updated() A property has changed, and we want to make adjustments to other things based on that changedProperties: PropertyValues
validate() Massively simplified validate, as compared to what ValidatorMixin gives us, since ValidatorMixin extends FormControlMixin which breaks SlSelect’s render() We take all validators for the widget, and if there’s a value (or field is required) we check the value with each validator. For array values we check each element with each validator. If the value does not pass the validator, we collect the message and display feedback to the user. We handle validation errors from the server with ManualMessages, which always “fail”. If the value is empty, we only validate if the field is required. skipManual:
validateAddress() Check if a free entry value is acceptable. We use validators directly using the proposed value text:
_handleClick() Click handler calling custom handler set via onclick attribute to this.onclick _ev: MouseEvent
_labelTemplate() Common sub-template to add a label. This goes inside the form control wrapper div, before and at the same depth as the input controls. -
_oldChange() Change handler calling custom handler set via onchange attribute _ev: Event
_set_label() Do some fancy stuff on the label, splitting it up if there’s a %s in it Normally called from updated(), the “normal” setter stuff has already been run before this is called. We only override our special cases (%s) because the normal label has been set by the parent value: string
_setAriaAttributes() Set aria-attributes on our input node -
destroy() et2_widget compatability
true
-
set_class() Set the widget class
Use this.class or this.classList instead
new_class: string
set_disabled() Wrapper on this.disabled because legacy had it.
Use widget.disabled for visually disabled, widget.hidden for visually hidden. Widgets that are hidden from the server via attribute or $readonlys will not be created. Widgets that are disabled from the server will not return a value to the application code.
value: boolean
set_statustext() supports legacy set_statustext
use this.statustext
value: string

Learn more about methods.

Custom Properties

Name Description Default
--height The maximum height of the widget, to limit size when you have a lot of addresses. Set by rows property, when set. 5

Learn more about customizing CSS custom properties.

Parts

Name Description
form-control The form control that wraps the label, input, and help text.
form-control-label The label’s wrapper.
form-control-input The textbox’s wrapper.
form-control-help-text The help text’s wrapper.
combobox The visible part of the control that is not the listbox - tags, input, prefix & suffix
prefix The container that wraps the prefix slot.
suffix The container that wraps the suffix slot.
listbox The listbox container where suggestions are slotted.
input The input element
option Each matching email address suggestion
tag The individual tags that represent each email address.

Learn more about customizing CSS parts.