Menu Item

<et2-menu-item> | Et2MenuItem

Examples

One entry in a menu. It is what the context menu built by the action system renders each action as, and what et2-ai and the markdown editor’s style dropdown use for their own menus - so most of the time you get menu items without writing one. When you do write one, it has to live inside an sl-menu; on its own it has nothing to be an item of.

value is what the menu reports as selected. Listen for sl-select on the menu, not on the item.

Picked: nothing yet

<sl-menu id="menu-example" style="max-width: 20em;">
    <et2-menu-item value="open">Open</et2-menu-item>
    <et2-menu-item value="edit">Edit</et2-menu-item>
    <sl-divider></sl-divider>
    <et2-menu-item value="delete">Delete</et2-menu-item>
</sl-menu>
<p>Picked: <span id="menu-output">nothing yet</span></p>
<script>
    const menu = document.getElementById("menu-example");
    const out = document.getElementById("menu-output");
    menu.addEventListener("sl-select", (event) => {out.textContent = event.detail.item.value;});
</script>

Icons and shortcuts

The prefix slot takes an icon, the suffix slot the keyboard shortcut - that is how the context menu lays out both.

Save Ctrl+S

Print Ctrl+P

<sl-menu style="max-width: 20em;">
    <et2-menu-item value="save">
        <et2-image slot="prefix" src="save"></et2-image>
        Save
        <span slot="suffix">Ctrl+S</span>
    </et2-menu-item>
    <et2-menu-item value="print">
        <et2-image slot="prefix" src="printer"></et2-image>
        Print
        <span slot="suffix">Ctrl+P</span>
    </et2-menu-item>
</sl-menu>

Checkboxes

type="checkbox" turns the item into something that can be ticked, with checked for the initial state. The menu ticks it for you - do not toggle it again in your own handler, or the two cancel out and the tick never appears to move. By the time sl-select reaches you, the item is already in its new state, so read event.detail.item.checked rather than inverting it.

Showing: details

<sl-menu id="menu-checkbox-example" style="max-width: 20em;">
    <et2-menu-item type="checkbox" value="details" checked>Show details</et2-menu-item>
    <et2-menu-item type="checkbox" value="deleted">Show deleted</et2-menu-item>
</sl-menu>
<p>Showing: <span id="menu-checkbox-output">details</span></p>
<script>
    const checkMenu = document.getElementById("menu-checkbox-example");
    const checkOut = document.getElementById("menu-checkbox-output");
    checkMenu.addEventListener("sl-select", () =>
    {
        const on = Array.from(checkMenu.querySelectorAll("et2-menu-item[type=checkbox]"))
            .filter(item => item.checked).map(item => item.value);
        checkOut.textContent = on.join(", ") || "nothing";
    });
</script>

Submenus

Nest an sl-menu in the submenu slot.

Open

Export as

CSV

PDF

<sl-menu style="max-width: 20em;">
    <et2-menu-item value="open">Open</et2-menu-item>
    <et2-menu-item value="export">
        Export as
        <sl-menu slot="submenu">
            <et2-menu-item value="csv">CSV</et2-menu-item>
            <et2-menu-item value="pdf">PDF</et2-menu-item>
        </sl-menu>
    </et2-menu-item>
</sl-menu>

Disabled vs hidden

A menu item is the exception to the usual eTemplate rule. Everywhere else disabled on a non-input widget takes the widget off the page entirely (see Disabled vs Readonly vs Hidden), but a disabled menu entry has to stay visible and greyed: that an action exists but is not available right now is exactly what the menu is there to say. So et2-menu-item undoes the inherited rule, and hidden is the flag that actually removes an item.

Both are below. “Edit” is disabled and still there; “Delete” is hidden and is not.

Open

Edit

<sl-menu style="max-width: 20em;">
    <et2-menu-item value="open">Open</et2-menu-item>
    <et2-menu-item value="edit" disabled>Edit</et2-menu-item>
    <et2-menu-item value="delete" hidden>Delete</et2-menu-item>
</sl-menu>

The action system drives both from an EgwAction: enabled becomes disabled and visible becomes hidden, so an action’s hideOnDisabled flag is what decides which of the two you get.

Inherited properties (25)

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.
`full`	Take every column of a layout, the same as `span="all"`. Boolean rather than a bare marker so it can be driven from content the way the rest of the template can - `full="@is_wide"` resolves through the array manager like any other boolean attribute. That does mean it needs a value: write `full="true"`, since an empty `full=""` resolves to false and removes the attribute again. Reflects for the same reason `grow` does.
`grow`	How much of a layout’s leftover space this widget should take. Only means anything inside a container that has a `layout` (see Et2LayoutController): a bare `grow` or `grow="1"` takes an equal share of whatever the non-growing children left over, `grow="2"` takes twice what a `grow="1"` sibling does. It has to reflect. The layout stylesheet matches the `[grow]` attribute - CSS cannot see a property - and transformAttributes() only calls setAttribute() for an attribute the element already carries or a property declared as reflecting. Widgets built from a .xet are created with document.createElement() and handed their attributes as an object, so they carry none at that point: without this declaration `grow="1"` lands as an inert JS property and nothing in the layout ever matches it.
`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
`span`	How many of a layout’s columns this widget should take. `span="all"` is every column wherever the widget landed, `span="end"` / `span="*"` is from its own column to the end of its line. Only means anything inside a container that has a `layout`, and only for the column layouts - `stack` gives every child the full width anyway. The same name is also read straight off the XML node by the legacy `<grid>` widget, for the unrelated job of counting table cells to merge; that path never looks at the widget, so declaring it here does not disturb it. Reflecting it does mean a legacy grid’s `span="all"` cells now carry the attribute too, which matches nothing outside a layout. Reflects for the same reason `grow` does.
`statustext`	Tooltip which is shown for this element on hover
`styles`	WebComponent *
`options`	Get property-values as object
`supportedWidgetClasses`	et2_widget compatability

SlMenuItem⁠ (Shoelace)

Name	Description
`checked`	Draws the item in a checked state.
`loading`	Draws the menu item in a loading state.
`type`	The type of menu item to render. To use `checked`, this value must be set to `checkbox`.
`value`	A unique value to store in the menu item. This can be used as a way to identify menu items when selected.

LitElement

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

Inherited methods (22)

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

SlMenuItem⁠ (Shoelace)

Name	Description
`getTextLabel()`	Returns a text label based on the contents of the menu item’s default slot.