EGroupware
Behaviour
Intentionally Not Included
Examples
Basic
Add filemanager into right slot of infolog
Same slots as egw-app
Slots
Properties
LitElement
Custom Properties
Parts

App Box

<et2-app-box> | Et2AppBox

Since 23.1

Minimal application layout component for inside etemplate templates

Et2AppBox

et2-app-box is a minimal application component for etemplate apps.

It is intentionally simpler than egw-app / EgwFrameworkApp, but keeps enough behaviour for legacy app loading and refresh flows.

prefer egw-app (EgwFrameworkApp) as part of kdots for full framework behaviour.

Behaviour

Unconditional slot-based layout (all slots always present)
Minimal header actions:
- filter button
- reload button
Loading support:
- load(url)
Refresh support:
- refresh(_msg, _id, _type)
Event listeners:
- load, clear, et2-search-result, et2-show

Intentionally Not Included

No iframe fallback loading, urls must end with ”&ajax=true”
Split panel / collapse behaviour
- showLeft()/hideLeft()/showRight()/hideRight() are no-ops
Tab hide/show splitter logic
Sidebox/menu handling
- setSidebox() is intentionally a no-op
Application menu
- No direct access to preferences, categories, etc.

Examples

If loading an existing application into an AppBox, the DOM target of the etemplate must be changed to something unique to avoid conflict with the normal application tab.

EGroupware applications are not expected to work perfectly inside an Et2AppBox and may generate errors or unexpected behaviour.

// Overriding the DOM ID for filemanager
class filemanager_appbox extends filemanager_ui
{
    public static function get_view()
    {
        return array(new filemanager_appbox(), 'listview');
    }
    function listview(array $content = null, $msg = null)
    {
        $this->etemplate = $this->etemplate ? 
            $this->etemplate : new \EGroupware\Api\Etemplate(static::LIST_TEMPLATE);
        // Override the target DOM ID from "filemanager.index", doesn't matter what it is
        $this->etemplate->set_dom_id('appboxtest');
        return parent::listview($content, $msg);
    }
}

<!-- template example using overridden DOM ID -->
<et2-app-box
        url="/egroupware/index.php?menuaction=filemanager.filemanager_appbox.index&amp;ajax=true"
        name="filemanager"
>
</et2-app-box>

Basic

Shows infolog app


<et2-app-box
        name="infolog"
        url="/egroupware/index.php?menuaction=infolog.infolog_custom.index&amp;ajax=true">
</et2-app-box>

Add filemanager into right slot of infolog


<template id="infolog.index">
    <template template="infolog.index.header" slot="main-header"></template>
    <nextmatch id="nm" template="infolog.index.rows" span="all"/>
    <et2-app-box
            slot="right"
            url="/egroupware/index.php?menuaction=filemanager.filemanager_custom.index&amp;ajax=true"
            name="filemanager"
    >
    </et2-app-box>
</template>

Same slots as egw-app


<et2-app-box
        name="calendar"
        url="/egroupware/index.php?menuaction=calendar.calendar_uicustom.index&amp;ajax=true">
    <et2-button-icon slot="header-actions" name="bank"></et2-button-icon>
</et2-app-box>

More about egw-app slots

Slots

Name	Description
(default)	Main application content.
`main-header`	Top of app. Contains logo, application toolbar, search box etc.
`header-actions`	Top right. Filter, refresh, print and menu controls.
`filter`	Custom filter panel content.
`header`	Top of main content.
`footer`	Bottom of main content.
`left`	Optional content on the left for application navigation.
`left-header`	Top of left side.
`left-top`	Between left-header and favourites.
`left-footer`	Bottom of left side.
`right`	Optional content on the right for application details.
`right-header`	Top of right side.
`right-footer`	Bottom of right side.

Learn more about using slots.

Properties

Name	Description	Type	Default
`getFilterInfo`	Information for filter button and filter drawer header.	-	-
`getFramework`	Used to specify how this component can find the framework.	-	-
`getNextmatch`	Used to specify how this component can find its current / active nextmatch.	`() => et2_nextmatch`	-
`loading`	Component is currently loading.	`boolean`	`false`
`name`	Application name. Must be the internal name of an application, used for preferences & settings	`string`	`"Application name"`
`rowCount`	Current number of rows or records being shown.	`string`	`""`
`url`	URL to load.	`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

Custom Properties

Name	Description	Default
`--application-color`	Background color for the main header.
`--application-header-text-color`	Text color for the main header.

Learn more about customizing CSS custom properties.

Parts

Name	Description
`app-header`	Wrapper for the top header area.
`header`	Header container for the main header slot.
`name`	Right side header area containing actions.
`main`	Wrapper for the body area containing sidebars and content.
`left`	Left sidebar container.
`right`	Right sidebar container.
`content-header`	Header area for left, center, and right sections.
`content`	Main content container.
`footer`	Footer container for the main content.
`filter`	Filter drawer wrapper.
`filter__panel`	The filter drawer panel element.
`spinner`	Loading spinner element.

Learn more about customizing CSS parts.