Select Month

<et2-select-month> | Et2SelectMonth

Since 23.1

Slots

Name	Description
(default)	Reflected into listbox options. Must be `sl-option` elements. You can use `sl-divider` to group items visually. Normally you set the options by parameter.
`prefix`	Used to prepend a presentational icon or similar element to the combobox.
`help-text`	Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.

Learn more about using slots.

Inherited properties (33)

Et2WidgetWithSelect

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
`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`	Disables the select control.
`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 select’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 select’s label. If you need to display HTML, use the `label` slot instead.
`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
`select_options`	Select box options Will be found automatically based on ID and type, or can be set explicitly in the template using
`statustext`	Tooltip which is shown for this element on hover
`styles`	WebComponent *
`translate`	List of properties that get translated
`_optionTargetNode`	Get the node where we’re putting the options If this were a normal selectbox, this would be just the
`needed`	Compatibility for deprecated name “needed”
`options`	Get property-values as object
`supportedWidgetClasses`	et2_widget compatability

Select

Name	Description
`clearable`	Adds a clear button when the select is not empty.
`editModeEnabled`	Allow editing tags by clicking on them. allowFreeEntries must be true. Tag editing lives here rather than in SelectSearchMixin: it reuses the search container but is not search, and it needs Et2Tag, which only Et2Select has.
`multiple`	Allows more than one option to be selected.
`onTagClick`	Click handler for individual tags instead of the select as a whole. Only used if multiple=true so we have tags
`placeholder`	Placeholder text to show as a hint when the select is empty.
`placement`	The preferred placement of the select’s menu. Note that the actual placement may vary as needed to keep the listbox inside of the viewport.
`tagTag`	Tag used for rendering tags when multiple=true Used for creating, finding & filtering options.

LitElement

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

Events

Name	React Event	Description
`change`	Emitted when the control’s value changes.	`Event`
`sl-clear`	Emitted when the control’s value is cleared.	-
`sl-input`	Emitted when the control receives input.	-
`sl-focus`	Emitted when the control gains focus.	-
`sl-blur`	Emitted when the control loses focus.	-
`sl-show`	Emitted when the suggestion menu opens.	-
`sl-after-show`	Emitted after the suggestion menu opens and all animations are complete.	-
`sl-hide`	Emitted when the suggestion menu closes.	-
`sl-after-hide`	Emitted after the suggestion menu closes and all animations are complete.	-

Learn more about events.

Inherited methods (37)

Select

Name	Description
`blur()`	Removes focus from the control.
`filterOutMissingOptions()`	Check a value for missing options and remove them. We’ll warn about it in the helpText, and if they save the change will be made. This is to avoid the server-side validation error, which the user can’t do much about.
`hide()`	Hides the listbox.
`show()`	Shows the listbox.
`startEdit()`	Start editing the current value if multiple=false

Et2WidgetWithSelect

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.
`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
`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.
`isValid()`	Used by etemplate2 to determine if we can submit or not
`loadFromXML()`	Additional customisations from the XET node
`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.
`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
`submit()`	Called whenever the template gets submitted. We return false if the widget is not valid, which cancels the submission.
`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()`	Used for the “no value” option for single select Placeholder is used for multi-select with no 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

Name	Description
`prefix`	The container that wraps the prefix slot.
`tags`	The container that houses option tags when multiselect is used.
`display-input`	The element that displays the selected option’s label, an element.
`expand-icon`	The container that wraps the expand icon.
`combobox`	The container the wraps the prefix, combobox, clear icon, and expand button.
`listbox`	The listbox container where options are slotted.
`option`	The options in the listbox container
`icon`	Icon in the option
`emptyLabel`	Wrapper around the label shown when there is no option selected
`tag__prefix`	The container that wraps the option prefix
`tag__suffix`	The container that wraps the option suffix
`tag__limit`	Element that is shown when the number of selected options exceeds maxOptionsVisible

Learn more about customizing CSS parts.