Skip to main content
Light Dark System

Button Timestamper

<et2-button-timestamp> | Et2ButtonTimestamper
Since 23.1


Class which implements the “et2-button-timestamp” tag

Clicking the button puts the current time and current user at the end of the provided field.


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 -
autofocus Have browser focus this input on load. Overrides etemplate2.focusOnFirstInput(), use only once per page boolean -
caret Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior. boolean false
circle Draws a circular icon button. When this attribute is present, the button expects a single <sl-icon> in the default slot. boolean false
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 -
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
Get the actual DOM ID, which has been prefixed to make sure it’s unique. string -
download Tells the browser to download the linked file as this filename. Only used when href is present. string | undefined -
form The “form owner” to associate the button with. If omitted, the closest containing form will be used instead. The value of this attribute must be an id of a form in the same document or shadow root as the button. string -
Used to override the form owner’s action attribute. string -
format Format for the timestamp. User is always after. string -
Used to override the form owner’s enctype attribute. 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain' -
Used to override the form owner’s method attribute. 'post' | 'get' -
Used to override the form owner’s novalidate attribute. boolean -
Used to override the form owner’s target attribute. '_self' | '_blank' | '_parent' | '_top' | string -
Get a list of feedback types 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 -
href When set, the underlying button will be rendered as an <a> with this href instead of a <button>. string ''
Get the ID of the widget string -
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 -
loading Draws the button in a loading state. boolean false
name The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter. This attribute is ignored when href is present. string ''
noLang Disable any translations for the widget boolean -
outline Draws an outlined button. 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 -
pill Draws a pill-style button with rounded edges. boolean false
rel When using href, this attribute will map to the underlying link’s rel attribute. Unlike regular links, the default is noreferrer noopener to prevent security exploits. However, if you’re using target to point to a specific tab/window, this will prevent that from working correctly. You can remove or change the default value by setting the attribute to an empty string or a value of your choice, respectively. string 'noreferrer noopener'
size The button’s size. 'small' | 'medium' | 'large' 'medium'
statustext Tooltip which is shown for this element on hover string -
WebComponent * - -
target Which field to place the timestamp in string -
timezone Timezone. Default is user time. string -
List of properties that get translated Done separately to not interfere with properties - if we re-define label property, labels go missing. - -
type The type of button. Note that the default value is button instead of submit, which is opposite of how native <button> elements behave. When the type is submit, the button will submit the surrounding form. 'button' | 'submit' | 'reset' 'button'
Gets the validation message - -
Gets the validity state object - -
value The value of the button, submitted as a pair with the button’s name as part of the form data, but only when this button is the submitter. This attribute is ignored when href is present. string ''
variant The button’s theme variant. 'default' | 'primary' | 'success' | 'neutral' | 'warning' | 'danger' | 'text' 'default'
Compatibility for deprecated name “needed”
use required instead
- -
Get property-values as object
use widget methods
object -
Lion mapping
- -
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.


Name Description Arguments
blur() Removes focus from the button. -
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 -
checkValidity() Checks for validity but does not show a validation message. Returns true when valid and false when invalid. -
click() Simulates a click on the button. -
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 button. 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 -
getForm() Gets the associated form, if one exists. -
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 -
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[]
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
reportValidity() Checks for validity and shows the browser’s validation message if the control is invalid. -
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 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
setCustomValidity() Sets a custom validation message. Pass an empty string to restore validity. message: string
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
stamp() Stamp the date / user into the target widget event: MouseEvent, _ev:
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:
_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
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.