EGroupware
Overview
Examples
Inline CSS
External stylesheet
Stylesheet beside the template
Datagrid row template styles
Slots
Properties
Methods
Parts

Styles

<et2-styles> | Et2Styles

Since 23.1

Overview

Et2Styles injects CSS into the document head.

It is the modern WebComponent replacement for the legacy et2_styles widget (api/js/etemplate/et2_widget_styles.ts). Inline CSS can be passed either as light-DOM text content (the classic <styles>...</styles> template usage) or via the value property. Additionally, an external stylesheet can be loaded by setting the src property to a URL.

The injected CSS is appended to the head of the EGroupware window so it can influence the whole document, not just the element’s shadow root. When the component is disconnected (removed from the DOM) the injected <style> and <link> nodes are removed again so they don’t accumulate.

Et2Styles injects CSS into the document <head> so the rules can affect the whole page, not just one widget. It is the modern replacement for the legacy et2_styles widget. Inline CSS can be passed as text content or the value property, and an external stylesheet can be loaded with src. When the component is removed, the injected <style> and <link> nodes are cleaned up automatically.

Examples

Inline CSS

The simplest way is to put the CSS rules inside the tag. They are injected into the head as a <style> element.

.styles-demo { color: rebeccapurple; font-weight: bold; }

This text is styled by the et2-styles above.

<et2-styles>
    .styles-demo {
        color: rebeccapurple;
        font-weight: bold;
    }
</et2-styles>
<div class="styles-demo">This text is styled by the et2-styles above.</div>

You can also set the rules from the server via the value property:

Styled through the value property.

<et2-styles value=".styles-demo-2 { color: teal; }"></et2-styles>
<div class="styles-demo-2">Styled through the value property.</div>

External stylesheet

Set src to load an external .css file. Absolute paths and full URLs are used as-is; relative paths are resolved against the EGroupware webserver root.

<et2-styles src="/egroupware/api/etemplate/extra.css"></et2-styles>

A data: URL is also passed through unchanged, which is handy for self-contained examples:

Styled via a data: URL.

<et2-styles src="data:text/css,.styles-demo-3%20%7B%20color%3A%20orange%3B%20%7D"></et2-styles>
<div class="styles-demo-3">Styled via a data: URL.</div>

Stylesheet beside the template

If you give src a bare filename like row.css, it is resolved relative to the template that contains it, so you can keep a stylesheet next to the .xet that uses it:

<!-- infolog/templates/default/index.xet -->
<et2-styles src="row.css"></et2-styles>

With the above, row.css is loaded from /egroupware/infolog/templates/default/row.css — no app prefix or absolute path required.

Datagrid row template styles

When an et2-nextmatch row template contains an et2-styles element, those styles are treated as row-template-local styles. They are adopted into the et2-datagrid row shadow root instead of being injected into the document head.

<template id="infolog.index.rows">
    <grid>
        <columns>
            <column id="info_subject"></column>
        </columns>
        <row class="$class">
            <et2-description id="info_subject"></et2-description>
        </row>
    </grid>

    <et2-styles src="row.css"></et2-styles>
</template>

The et2-styles element can be anywhere inside the row template definition; it does not need to be inside the <row> element. Both inline CSS and src are supported. A bare filename such as row.css resolves beside the .xet file that contains the row template.

If row-template-local styles are present, et2-nextmatch adopts only the framework row stylesheet and the extracted row-template styles into the datagrid row shadow root. The application’s templates/default/app.css fallback is not added to that shadow root. If no row-template-local et2-styles is present, app.css is still used as the compatibility fallback for row styling.

The injected CSS is document-wide, not scoped to the widget. Use specific selectors (or a unique id on the et2-styles element) to avoid affecting unrelated parts of the page.

Slots

Name	Description
(default)	Inline CSS rules (legacy text content of the tag)

Learn more about using slots.

Properties

Name	Description	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`	-
`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.	`object`	-
`align`	Used by Et2Box to determine alignment. Allowed values are left, right	`string`	-
`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`	-
`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.	`boolean`	`false`
`dom_id`	Get the actual DOM ID, which has been prefixed to make sure it’s unique.	`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`	-
`id`	Get the ID of the widget	`string`	-
`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	`string`	-
`noLang`	Disable any translations for the widget	`boolean`	-
`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`	-
`src`	URL of an external stylesheet to load. Relative URLs are resolved against the EGroupware webserver root.	`string`	`""`
`statustext`	Tooltip which is shown for this element on hover	`string`	-
`styles`	WebComponent *	-	-
`value`	Inline CSS rules. Set programmatically or via light-DOM text content.	`string`	`""`
`options`	Get property-values as object use widget methods	`object`	-
`supportedWidgetClasses`	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.

Methods

Name	Description	Arguments
`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.	`_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:`
`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	-
`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	`_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`
`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	`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`
`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`
`_get_action_links()`	Get all action-links / id’s of 1.-level actions from a given action object This can be overwritten to not allow all actions, by not returning them here.	`actions:`
`_handleClick()`	Click handler calling custom handler set via onclick attribute to this.onclick	`_ev: MouseEvent`
`_link_actions()`	Link the actions to the DOM nodes / widget bits.	`actions: object`
`_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`
`destroy()`	et2_widget compatability true	-
`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. Disabled vs Readonly vs Hidden	`value: boolean`
`set_statustext()`	supports legacy set_statustext use this.statustext	`value: string`

Learn more about methods.

Parts

Name	Description
`styles`	Not applicable; Et2Styles renders no shadow content.

Learn more about customizing CSS parts.