Light Dark System

Button Icon

<et2-button-icon> | Et2ButtonIcon

Examples

An icon button is a Button with no label and no chrome - just the icon, clickable. Everything about images, noSubmit, disabled and the id-based defaults is the same as on a regular button, so it is only described there.

Icon

image picks the icon. Because there is no label to read, always give an icon button a label too: it is not rendered, it is what a screen reader announces and what the tooltip shows. 

<et2-button-icon image="printer" label="Print"></et2-button-icon>
<et2-button-icon image="trash" label="Delete"></et2-button-icon>
<et2-button-icon image="three-dots-vertical" label="More"></et2-button-icon>

In a toolbar

Icon buttons are meant to sit together in a row, which is most of what they are used for - a nextmatch header, a dialog toolbar, the buttons inside a tag. 

<et2-hbox>
    <et2-button-icon image="type-bold" label="Bold"></et2-button-icon>
    <et2-button-icon image="type-italic" label="Italic"></et2-button-icon>
    <et2-button-icon image="type-underline" label="Underline"></et2-button-icon>
</et2-hbox>

Colour

The button inherits its colour, so it takes on whatever it is sitting in rather than fighting it.

Something needs attention 
<div style="color: var(--sl-color-danger-600)">
    <et2-button-icon image="exclamation-triangle" label="Warning"></et2-button-icon>
    Something needs attention
</div>

Disabled 

<et2-button-icon image="printer" label="Print"></et2-button-icon>
<et2-button-icon image="printer" label="Print" disabled></et2-button-icon>
Inherited properties (33)

Et2Widget

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.
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.
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.
id Get the ID of the widget
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
noLang Disable any translations for the widget
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
statustext Tooltip which is shown for this element on hover
styles WebComponent *
options Get property-values as object
supportedWidgetClasses et2_widget compatability

Et2InputWidget

Name Description
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
hasFeedbackFor Get a list of feedback types
translate List of properties that get translated Done separately to not interfere with properties - if we re-define label property, labels go missing.
needed Compatibility for deprecated name “needed”

ButtonMixin

Name Description
default_background_images images to be used as background-image, if none is explicitly applied and id matches given regular expression
default_classes Classnames added automatically to buttons to set certain hover background colors
hideOnReadonly If button is set to readonly, do we want to hide it completely (old behaviour) or show it as disabled (default) Something’s not quite right here, as the attribute shows up as “hideonreadonly” instead of “hide” but it does not show up without the “attribute”, and attribute:“hideonreadonly” does not show as an attribute
noSubmit Button should submit the etemplate Return false from the click handler to cancel the submit, or set noSubmit to true to skip submitting.
noValidation When submitting, skip the validation step. Allows to submit etemplates directly to the server.

SlIconButton⁠ (Shoelace)

Name Description
download Tells the browser to download the linked file as this filename. Only used when href is set.
href When set, the underlying button will be rendered as an <a> with this href instead of a <button>.
library The name of a registered custom icon library.
name The name of the icon to draw. Available names depend on the icon library being used.
src An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and can result in XSS attacks.
target Tells the browser where to open the link. Only used when href is set.

LitElement

Name Description
updateComplete A read-only promise that resolves when the component has finished updating.

Events

Name Description Event Detail
click Missing description MouseEvent
change Missing description Event

Learn more about events.

Inherited methods (36)

SlIconButton⁠ (Shoelace)

Name Description
blur() Removes focus from the icon button.
click() Simulates a click on the icon button.
focus() Sets focus on the icon button.

Et2Widget

Name Description
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.
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.
getArrayMgr() Returns the array manager object for the given part
getArrayMgrs() Returns an associative array containing the top-most array managers.
getChildren() Get child widgets Use .children to get web component children
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
loadFromXML() Loads the widget tree from an XML node
loadingFinished() Needed for legacy compatability.
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.
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
setArrayMgr() Sets the array manager for the given part
setArrayMgrs() Sets all array manager objects - this function can be used to set the root array managers of the container 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
_handleClick() Click handler calling custom handler set via onclick attribute to this.onclick
destroy() et2_widget compatability
set_class() Set the widget class
set_disabled() Wrapper on this.disabled because legacy had it.
set_statustext() supports legacy set_statustext

Et2InputWidget

Name Description
et2HandleBlur() If the value is unchanged, put any held validation messages back Named et2HandleBlur to avoid overwriting handleBlur() in Shoelace components
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
getInputNode() Reimplemented to pass aria-attributes to button
handleSlChange() Handle sl-change event from Shoelace components and dispatch a change event so anything listening for change events can react to it instead of having to listen for both sl-change and change.
isDirty() Always return false as a button is never dirty
isValid() Used by etemplate2 to determine if we can submit or not
submit() Called whenever the template gets submitted. We return false if the widget is not valid, which cancels the submission.
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.
_oldChange() Change handler calling custom handler set via onchange attribute

ButtonMixin

Name Description
_get_default_class() Get a default class for the button based on ID
_get_default_image() Get a default image for the button based on ID
_register_default_keyhandler() If button ID has a default keyboard shortcut (eg: Save: Ctrl+S), register with egw_keymanager

These widgets are related by naming but not by inheritance or sub-widget composition.