EGroupware
Overview
Examples
Elapsed time
It picks its own unit
Forcing a unit
Nothing to show
Properties
LitElement
Related

Date Since

<et2-date-since> | Et2DateSince

Overview

Displays the elapsed time since the given date

The time units (years, months, days, etc) will be calculated automatically to best match the time scale being dealt with, unless the units property is set.

This is a stripped-down read-only widget used in nextmatch

Examples

et2-date-since shows how long ago something happened - “5 days”, “3 hours” - rather than when it happened. It is read-only: there is nothing to pick, and no value is submitted. Its natural home is a “Last modified” column, where the age of a row is the interesting part and the exact timestamp is not.

For the moment itself rather than its age, see et2-date-time-today, or Which date widget for the whole family.

Elapsed time

value here is an attribute, because the widget only ever reads it. Give it anything the other date widgets accept - the server’s Y-m-dTH:i:00Z is the usual one - and it counts forward to now.

<et2-date-since id="since-fixed" value="2020-01-01T09:00:00Z"></et2-date-since>

Note what that Z does and does not mean. Everywhere in the date family the string is the time on the user’s own clock, not real UTC - set 14:35 on an et2-date-time and 14:35 is what comes back out, wherever the user is. et2-date-since is the one that has to turn that back into a real instant to subtract it from now, which it does with the user’s timezone offset. A value built from new Date().toJSON(), which really is UTC, is therefore an offset out - hence the shift in the examples below.

It picks its own unit

One number and one unit, chosen to suit the gap: seconds become minutes become hours become days, months, years. Nothing is ever shown as “2 days, 4 hours” - the largest unit that fits wins, and the rest is rounded away.

ago

<p><et2-date-since id="since-scale-1"></et2-date-since> ago</p>
<p><et2-date-since id="since-scale-2"></et2-date-since> ago</p>
<p><et2-date-since id="since-scale-3"></et2-date-since> ago</p>
<p><et2-date-since id="since-scale-4"></et2-date-since> ago</p>
<script>
    // The user's own clock, with a Z on the end - what the server would have sent
    const sinceAgo = (ms) => new Date(Date.now() - ms - new Date().getTimezoneOffset() * 60 * 1000).toJSON();

    document.getElementById("since-scale-1").value = sinceAgo(45 * 1000);
    document.getElementById("since-scale-2").value = sinceAgo(90 * 60 * 1000);
    document.getElementById("since-scale-3").value = sinceAgo(5 * 24 * 60 * 60 * 1000);
    document.getElementById("since-scale-4").value = sinceAgo(400 * 24 * 60 * 60 * 1000);
</script>

Forcing a unit

units limits which units may be used, as a string of YmdHis letters. units="d" keeps a whole column in days no matter how old the rows are, so the numbers can be compared down the column instead of each one carrying its own scale.

Automatic:

units=“d”:

units=“H”:

<p>Automatic: <et2-date-since id="since-auto"></et2-date-since></p>
<p>units="d": <et2-date-since id="since-days" units="d"></et2-date-since></p>
<p>units="H": <et2-date-since id="since-hours" units="H"></et2-date-since></p>
<script>
    const sinceUnitsValue = new Date(Date.now() - 400 * 24 * 60 * 60 * 1000 - new Date().getTimezoneOffset() * 60 * 1000).toJSON();

    document.getElementById("since-auto").value = sinceUnitsValue;
    document.getElementById("since-days").value = sinceUnitsValue;
    document.getElementById("since-hours").value = sinceUnitsValue;
</script>

Nothing to show

An empty value renders nothing at all rather than “0 seconds” or a placeholder date, which is what you want for a row that has never been touched.

[]

<p>[<et2-date-since></et2-date-since>]</p>

Properties

Name	Description	Reflects	Type	Default
`units`	Allowed display units, default ‘YmdHis’, e.g. ‘d’ to display a value only in days”		`string`	-

Learn more about attributes and properties.

Inherited properties (30)

Et2Date⁠ (Shoelace)

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
`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
`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.
`freeMinuteEntry`	Allow value that is not a multiple of minuteIncrement eg: 11:23 with default 5 minuteIncrement = 11:25 16:47 with 30 minuteIncrement = 17:00 If false (default), it is impossible to have a time that is not a multiple of minuteIncrement. Does not affect scroll, which always goes to nearest multiple.
`hasFeedbackFor`	Get a list of feedback types
`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
`inline`	Display the calendar inline instead of revealed as needed
`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
`max`	Latest date the user is allowed to choose
`maxDate`	Latest date the user is allowed to choose, or ”″ for no limit
`min`	Earliest date the user is allowed to choose The same thing as minDate, under the name templates use. Flatpickr calls it minDate, the server-side widget calls it min, and both names have to work.
`minDate`	Earliest date the user is allowed to choose, or ”″ for no limit Anything new Date() understands is accepted; something it cannot parse is treated as no limit rather than becoming an Invalid Date the calendar would choke on. The value has to be kept here rather than handed straight to Flatpickr: the calendar is not created until the widget is first shown (see init()), which is long after a template has set its limits, so getOptions() reads these back when it eventually does get built.
`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
`placeholder`	Placeholder text for input
`placement`	The preferred placement of the calendar popup can be set with the placement attribute. The default is “auto”. Note that the actual position may vary to ensure the calendar remains in the viewport. Valid placements are “top”, “bottom” or “auto”.
`statustext`	Tooltip which is shown for this element on hover
`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.
`needed`	Compatibility for deprecated name “needed”
`options`	Get property-values as object
`supportedWidgetClasses`	et2_widget compatability

LitElement

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

Inherited methods (41)

Et2Date⁠ (Shoelace)

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.
`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
`findInputField()`	Override from flatpickr - This is the node we tell flatpickr to use It must be an , flatpickr doesn’t understand anything else
`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
`getInputNode()`	Get input to e.g. set aria-attributes
`getInstanceManager()`	Returns the instance manager
`getOptions()`	Override some flatpickr defaults to get things how we like it
`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
`handleScroll()`	Handle clicks on scroll buttons
`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.
`increment()`	Increment the current value
`init()`	Override parent to skip call to CDN
`isValid()`	Used by etemplate2 to determine if we can submit or not
`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
`set_max()`	Set the maximum allowed date
`set_min()`	Set the minimum allowed date
`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
`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.
`_handleCalendarChange()`	flatpickr’s onChange callback - fires for every real value change (a calendar pick, clear(), or a committed setDate() call from _handleInputChange), unlike _onReady’s one-off startup call straight into _updateValueOnChange. Dispatch our own “change” here so onchange=”″ template bindings see calendar picks too, not just typed-and-parsed input (which previously only fired “change” from within _handleInputChange itself).
`_handleClick()`	Click handler calling custom handler set via onclick attribute to this.onclick
`_handleInputChange()`	Update the calendar when the input value changes Otherwise, user’s change will be overwritten by calendar popup when the input loses focus
`_handleShortcutButtonClick()`	Handle click on shortcut button(s) like “Today”
`_mobileInputType()`	For mobile, we use a plain input of the proper type
`_oldChange()`	Change handler calling custom handler set via onchange attribute
`_updateValueOnChange()`	Change handler setting modelValue for validation
`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

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

Overview

Examples

Elapsed time

It picks its own unit

Forcing a unit

Nothing to show

Properties

Et2Date⁠ (Shoelace)

LitElement

Et2Date⁠ (Shoelace)

Related