Select Category

<et2-select-cat> | Et2SelectCategory

Since 23.1

Slots

Learn more about using slots.

Properties

Learn more about attributes and properties.

Inherited properties (39)

Tree Dropdown

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
autoloading	“JSON URL or menuaction to be called for nodes marked with child=1, but not having children, getSelectedNode() contains node-id”
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.
clearable	Adds a clear button when the dropdown is not empty.
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.
emptyLabel	Textual label for first row, eg: ‘All’ or ‘None’. It’s value will be ″
hasFeedbackFor	Get a list of feedback types
helpText	The component’s help text. If you need to display HTML, use the help-text slot instead.
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 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
leafOnly	If true, only leafs (NOT folders) are selectable
noLang	Disable any translations for the widget
open	Indicates whether the dropdown is open. You can toggle this attribute to show and hide the tree, or you can use the show() and hide() methods and this attribute will reflect the open state.
openAtSelection	set the corresponding attribute if you want the tree to scroll to the selected item, when it is opened Please already supply the parents of the current selection in an open state from the server side if possible
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 to show as a hint when the select is empty.
resultsOpen	Indicates whether the search results are open. You can toggle this attribute to show and hide the results list.
search	Enable or disable searching
SEARCH_TIMEOUT	How long to wait after the user stops typing before searching, in ms. Override in a subclass to change the debounce.
searchOptions	Additional search parameters that are passed to the server when we query searchUrl
searchUrl	Where search results come from, instead of just searching in the browser. Either: - a menuaction string, requested from the server - an “app.appname.method” string, resolved via egw().applyFunc() - the same convention onExecute=“javaScript:app.X.Y” uses, minus the prefix. applyFunc() lazy-loads the app’s JS object, so this can be wired straight into a template with no extra app code. - a JS callback returning a Promise of results, for per-instance sourcing without a subclass (overriding remoteSearch() would need one, or patching the instance) {attribute: false} because a function cannot come from an HTML attribute. Template attributes still work: etemplate assigns them as properties (Et2Widget.transformAttributes).
select_options	Select box options Will be found automatically based on ID and type, or can be set explicitly in the template using children, or using widget.select_options = SelectOption[]
statustext	Tooltip which is shown for this element on hover
styles	WebComponent *
tagTag	Tag used for rendering tags when multiple=true Used for creating, finding & filtering options.
translate	List of properties that get translated
value	Selected tree leaves
_optionTargetNode	Get the node where we’re putting the options If this were a normal selectbox, this would be just the tag (this._inputNode) but in a more complicated widget, this could be anything.
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.

Events

Learn more about events.

Inherited methods (41)

Tree Dropdown

Name	Description
blur()	Removes focus from the control.
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
focus()	Sets focus on the control.
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
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
getValueAsArray()	The value as an array, whatever shape it is stored in. A host that has its own idea of this wins: Et2WidgetWithSelectMixin’s version keeps an empty string when there is an emptyLabel, and silently shadowing it drops the empty option from the rendered list. Only fall back to our own when the host has none.
handleComboboxKeyDown()	Keyboard events that the search input did not grab (tags, option navigation)
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.
hide()	Hides the tree.
isValid()	Used by etemplate2 to determine if we can submit or not
loadFromXML()	Load extra stuff from the template node. In particular, we’re looking for any tags added.
loadingFinished()	Needed for legacy compatability.
optionSearch()	Search options for a given value, returning the first matching option
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.
searchMatch()	Check if one of our [local] items matches the search
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
show()	Shows the tree.
startSearch()	Start searching for results matching what has been typed
submit()	Called whenever the template gets submitted. We return false if the widget is not valid, which cancels the submission.
tagsTemplate()	Shows the currently selected values as tags when multiple=true
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.
_emptyLabelTemplate()	Render the “empty label”, used when the selectbox does not currently have a value
_handleClick()	Click handler calling custom handler set via onclick attribute to this.onclick
_oldChange()	Change handler calling custom handler set via onchange attribute
destroy()	et2_widget compatability
set_class()	Set the widget class
set_disabled()	Wrapper on this.disabled because legacy had it.
set_select_options()	Set select options
set_statustext()	supports legacy set_statustext

Parts

Learn more about customizing CSS parts.