EGroupware
When to use it
Examples
A spinner
Size
Colour, thickness and speed
Showing it while you wait
Properties
LitElement

Spinner

<et2-spinner> | Et2Spinner

When to use it

<et2-spinner> is the “working on it” indicator - a ring that turns while something is loading. Show one while you wait for a request, hide it when the answer arrives.

It has no value, no label and nothing to click. If the wait has a known length or a known number of steps, a progress bar tells the user more; use a spinner when you genuinely do not know how long it will take.

Examples

A spinner

There is nothing to configure to get the default.

<et2-spinner></et2-spinner>

Size

The ring is sized from the font size, so it scales with whatever text it sits in. Set font-size on the widget to make it bigger or smaller.

<et2-spinner style="font-size: 1rem;"></et2-spinner>
<et2-spinner style="font-size: 2rem;"></et2-spinner>
<et2-spinner style="font-size: 4rem;"></et2-spinner>

Colour, thickness and speed

Four CSS custom properties control the rest: --track-width, --track-color, --indicator-color and --speed, the time for one full turn.

<et2-spinner style="font-size: 3rem; --track-width: 6px;"></et2-spinner>
<et2-spinner style="font-size: 3rem; --indicator-color: var(--sl-color-danger-600); --track-color: var(--sl-color-danger-100);"></et2-spinner>
<et2-spinner style="font-size: 3rem; --speed: 3s;"></et2-spinner>

Showing it while you wait

The usual pattern is to keep the spinner in the template and toggle it around the request.

Loading…

<et2-spinner id="spinner-example" style="font-size: 2rem;"></et2-spinner>
<span id="spinner-example-status">Loading…</span>
<button id="spinner-example-button" type="button">Start again</button>
<script>
    const spinner = document.getElementById("spinner-example");
    const status = document.getElementById("spinner-example-status");

    const run = () =>
    {
        spinner.hidden = false;
        status.textContent = "Loading…";
        window.setTimeout(() =>
        {
            spinner.hidden = true;
            status.textContent = "Done";
        }, 2000);
    };

    document.getElementById("spinner-example-button").addEventListener("click", run);
    run();
</script>

Properties

Name	Description	Reflects	Type	Default
`style`	font-size size is based on font size –track-width The width of the track. –track-color The color of the track. –indicator-color The color of the indicator. –speed The time it takes for the spinner to complete one animation cycle.		`string`	`''`

Learn more about attributes and properties.

Inherited properties (18)

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 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
`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

LitElement

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

Inherited methods (21)

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