Label
<et2-label> | Et2Label
et2-label or et2-description?
<et2-label> and <et2-description> are
the same class - Et2Label is an empty subclass of Et2Description registered under
a second tag name. Every attribute documented below behaves identically in both.
They exist separately so a template says which of the two jobs the text is doing:
-
<et2-label>names something else on the screen. It is the caption in front of an input, the title over a box, the word that tells the user what the widget beside it is for. -
<et2-description>is the content. It shows a value, a hint or a paragraph of explanation that stands on its own.
If the text would be meaningless with the widget next to it removed, it is a label. If it would still say something useful, it is a description.
Most widgets have their own label attribute, and that is always the better choice - it is
associated with the input for screen readers and it lays out correctly in a form. Use a separate
<et2-label> for the cases a label attribute cannot cover: a caption over a
group of widgets, or a label that has to sit somewhere the widget’s own label cannot go.
Examples
A caption
The text comes from value, or from the tag’s own content.
<et2-label value="Participants"></et2-label>
<et2-label>Attachments</et2-label>
Naming another widget
for takes the id of another widget in the same template. The label’s text is then
published as that widget’s accessible name, and clicking the label focuses it.
This one is deliberately not live: for is resolved against the surrounding eTemplate widget
tree, and this documentation page has no eTemplate around its examples, so the two widgets below would never
find each other here.
<et2-label for="name" value="Your name"></et2-label>
<et2-textbox id="name"></et2-textbox>
Everything else
Labels support the same text handling as descriptions - activateLinks, href,
markdown, noLang and a label of their own. See
Et2Description for worked examples of each.
<et2-label markdown value="Fields marked **bold** are required"></et2-label>
Inherited properties (26)
Description
| Name | Description |
|---|---|
accesskey |
Accesskey provides a hint for generating a keyboard shortcut for the current element. The attribute value must consist of a single printable character. |
actions |
Set Actions on the widget Each action is defined as an object: move: { type: “drop”, acceptedTypes: “mail”, icon: “move”, caption: “Move to” onExecute: javascript:mail_move” } This will turn the widget into a drop target for “mail” drag types. When “mail” drag types are dropped, the global function mail_move(egwAction action, egwActionObject sender) will be called. The ID of the dragged “mail” will be in sender.id, some information about the sender will be in sender.context. The etemplate2 widget involved can typically be found in action.parent.data.widget, so your handler can operate in the widget context easily. The location varies depending on your action though. It might be action.parent.parent.data.widget To customise how the actions are handled for a particular widget, override _link_actions(). It handles the more widget-specific parts. |
activateLinks |
Scan the value, and if there are any links (URL, mailto:) then wrap them in a clickable tag |
align |
Used by Et2Box to determine alignment. Allowed values are left, right |
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. |
data |
Set the dataset from a CSV |
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. |
dom_id |
Get the actual DOM ID, which has been prefixed to make sure it’s unique. |
extraLinkPopup |
widthxheight, if popup should be used, eg. 640x480 |
extraLinkTarget |
Extra link target Goes with href. If provided, that’s the target for opening the link. |
full |
Take every column of a layout, the same as span="all". Boolean rather than a bare
marker so it can be driven from content the way the rest of the template can -
full="@is_wide" resolves through the array manager like any other boolean attribute.
That does mean it needs a value: write full="true", since an empty
full="" resolves to false and removes the attribute again. Reflects for the same
reason grow does.
|
grow |
How much of a layout’s leftover space this widget should take. Only means anything inside a
container that has a layout (see Et2LayoutController): a bare grow or
grow="1" takes an equal share of whatever the non-growing children left over,
grow="2" takes twice what a grow="1" sibling does. It has to reflect.
The layout stylesheet matches the [grow] attribute - CSS cannot see a property - and
transformAttributes() only calls setAttribute() for an attribute the element already carries or a
property declared as reflecting. Widgets built from a .xet are created with
document.createElement() and handed their attributes as an object, so they carry none at that
point: without this declaration grow="1" lands as an inert JS property and nothing in
the layout ever matches it.
|
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. |
href |
Link URL If provided, will be clickable and open this URL |
id |
Get the ID of the widget |
label |
The label of the widget This is usually displayed in some way. It’s also important for accessability. This is defined in the parent somewhere, and re-defining it causes labels to disappear |
LINK_STYLES_ID |
Id of the |