Light Dark System

Number

<et2-number> | Et2Number
Since 23.1

Enter a numeric value. Number formatting comes from preferences by default

Examples

Spinners

To add up / down arrow buttons to change the value, set step.

<et2-number label="0.5 step" step="0.5"></et2-number>

Precision

To enforce a certain number of decimal places, set precision.

<et2-number label="Two decimal places" precision="2" value="123.456"></et2-number>
<et2-number label="Integers only" precision="0" value="123.456"></et2-number>

Number Format

Normally numbers use the user’s number format for thousands and decimal separator from preferences, but it is possible to specify for a particular number. The internal value is not affected. 

<et2-number decimalSeparator="p" thousandsSeparator=" " value="1234.56"></et2-number>

Minimum and Maximum

Limit the value with min and max

<et2-number min="0" label="Greater than 0"></et2-number>
<et2-number min="10" max="20" label="Between 10 and 20"></et2-number>

Prefix & Suffix

Use prefix and suffix attributes to add text before or after the input field. To include HTML or other widgets, use the prefix and suffix slots instead. 

<et2-number prefix="$" value="15.46"></et2-number>

Currency

Using suffix,min and precision together

<et2-number suffix="€" min="5.67" precision="2" label="Price"></et2-number>

Slots

Name Description
label The input’s label. Alternatively, you can use the label attribute.
prefix Used to prepend a presentational icon or similar element to the combobox.
suffix Like prefix, but after
help-text Text that describes how to use the input. Alternatively, you can use the help-text attribute.

Learn more about using slots.

Properties

Name Description Reflects Type Default
decimalSeparator Decimal separator. Defaults to user preference. - -
max Maximum value - -
min Minimum value - -
precision Precision of float number or 0 for integer - -
prefix Text placed before the value string ""
step Step value - -
suffix Text placed after the value string ""
thousandsSeparator Thousands separator. Defaults to user preference. - -

Learn more about attributes and properties.

Inherited properties (53)

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
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 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
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

SlInput (Shoelace)

Name Description
autocapitalize Controls whether and how text input is automatically capitalized as it is entered by the user.
autocomplete Specifies what permission the browser has to provide assistance in filling out form field values. Refer to this page on MDN for available values.
autocorrect Indicates whether the browser’s autocorrect feature is on or off.
clearable Adds a clear button when the input is not empty.
defaultValue The default value of the form control. Primarily used for resetting the form control.
enterkeyhint Used to customize the label or icon of the Enter key on virtual keyboards.
filled Draws a filled input.
form By default, form controls are associated with the nearest containing <form> element. This attribute allows you to place the form control outside of a form and associate it with the form that has this id. The form must be in the same document or shadow root for this to work.
helpText The input’s help text. If you need to display HTML, use the help-text slot instead.
inputmode Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual keyboard on supportive devices.
maxlength The maximum length of input that will be considered valid.
minlength The minimum length of input that will be considered valid.
name The name of the input, submitted as a name/value pair with form data.
noSpinButtons Hides the browser’s built-in increment/decrement spin buttons for number inputs.
passwordToggle Adds a button to toggle the password’s visibility. Only applies to password types.
passwordVisible Determines whether or not the password is currently visible. Only applies to password input types.
pattern A regular expression pattern to validate input against.
pill Draws a pill-style input with rounded edges.
readonly Makes the input readonly.
required Makes the input a required field.
size The input’s size.
spellcheck Enables spell checking on the input.
type The type of input. Works the same as a native <input> element, but only a subset of types are supported. Defaults to text.
validationMessage Gets the validation message
validity Gets the validity state object
value The current value of the input, submitted as a name/value pair with form data.
valueAsDate Gets or sets the current value as a Date object. Returns null if the value can’t be converted. This will use the native <input type="{{type}}"> implementation and may result in an error.
valueAsNumber Gets or sets the current value as a number. Returns NaN if the value can’t be converted.

Et2InputWidget

Name Description
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
hasFeedbackFor Get a list of feedback types
needed Compatibility for deprecated name “needed”

Textbox

Name Description
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.
mask Mask the input to enforce format. The mask is enforced as the user types, preventing invalid input.
placeholder Placeholder text to show as a hint when the input is empty.
translate List of properties that get translated Done separately to not interfere with properties - if we re-define label property, labels go missing.
validator Somehow the setter is not inherited from the parent, not defining it here leaves the validator a string!

LitElement

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

Events

Name React Event Description Event Detail
sl-change EVENT NEEDS A DESCRIPTION CustomEvent
change Emitted when the control’s value changes. Event

Learn more about events.

Methods

Name Description Arguments
stripFormat() Remove special formatting from a string to get just a number value formattedValue: string | number

Learn more about methods.

Inherited methods (42)

SlInput (Shoelace)

Name Description
blur() Removes focus from the input.
checkValidity() Checks for validity but does not show a validation message. Returns true when valid and false when invalid.
focus() Sets focus on the input.
getForm() Gets the associated form, if one exists.
reportValidity() Checks for validity and shows the browser’s validation message if the control is invalid.
select() Selects all the text in the input.
setCustomValidity() Sets a custom validation message. Pass an empty string to restore validity.
setRangeText() Replaces a range of text with a new string.
setSelectionRange() Sets the start and end positions of the text selection (0-based).
showPicker() Displays the browser picker for an input element (only works if the browser supports it for the input type).
stepDown() Decrements the value of a numeric input type by the value of the step attribute.
stepUp() Increments the value of a numeric input type by the value of the step attribute.

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

Et2InputWidget

Name Description
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
getInputNode() Get input to e.g. set aria-attributes
getValue() Value returned to server is always no thousands separator, ”.” decimal separator
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
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.
_oldChange() Change handler calling custom handler set via onchange attribute

Parts

Name Description
form-control The form control that wraps the label, input, and help text.
form-control-label The label’s wrapper.
form-control-input The input’s wrapper.
form-control-help-text The help text’s wrapper.

Learn more about customizing CSS parts.