Textbox
<et2-textbox> | Et2Textbox
Examples
Label
Use the label attribute to give the input an accessible label.
Add the et2-label-fixed class to force the label to have a fixed width. This helps line up
labels and widgets into columns without having to use a grid. See
/getting-started/styling/#fixed-width-labels
<et2-textbox label="Name"></et2-textbox>
Prefix & Suffix
Use prefix and suffix slots to add content before or after the text
<et2-textbox>
<sl-icon name="youtube" slot="prefix"></sl-icon>
<sl-icon name="upload"></sl-icon>
</et2-textbox>
Mask
Setting a mask limits what the user can enter into the field.
<et2-textbox label="Part Number" helpText="P[aa]-0000" mask="{P}[aa]-0000"></et2-textbox>
Properties
| Name | Description | Reflects | Type | Default |
|---|---|---|---|---|
accesskey
|
Accesskey provides a hint for generating a keyboard shortcut for the current element. The attribute value must consist of a single printable character. |
|
string
|
- |
align
|
Used by Et2Box to determine alignment. Allowed values are left, right |
|
string
|
- |
autocapitalize
|
Controls whether and how text input is automatically capitalized as it is entered by the user. |
'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'
|
- | |
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. |
string
|
- | |
autocorrect
|
Indicates whether the browser’s autocorrect feature is on or off. |
'off' | 'on'
|
- | |
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 |
|
boolean
|
- |
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. |
|
string
|
- |
clearable
|
Adds a clear button when the input is not empty. |
boolean
|
false
|
|
data
|
Set the dataset from a CSV |
string
|
- | |
defaultValue
|
The default value of the form control. Primarily used for resetting the form control. |
string
|
''
|
|
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 input. It is still visible. |
|
boolean
|
false
|
dom_id
|
Get the actual DOM ID, which has been prefixed to make sure it’s unique. |
string
|
- | |
enterkeyhint
|
Used to customize the label or icon of the Enter key on virtual keyboards. |
'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'
|
- | |
filled
|
Draws a filled input. |
|
boolean
|
false
|
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.
|
|
string
|
''
|
hasFeedbackFor
|
Get a list of feedback types |
string[]
|
- | |
helpText
|
The input’s help text. If you need to display HTML, use the help-text slot instead.
|
string
|
''
|
|
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. |
|
boolean
|
- |
id
|
Get the ID of the widget |
string
|
- | |
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. |
'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'
|
- | |
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 |
string
|
- | |
mask
|
Mask the input to enforce format. The mask is enforced as the user types, preventing invalid input. | - | - | |
maskOptions
|
Get the options for masking. Can be overridden by subclass for additional options. | - | - | |
max
|
The input’s maximum value. Only applies to date and number input types. |
number | string
|
- | |
maxlength
|
The maximum length of input that will be considered valid. |
number
|
- | |
min
|
The input’s minimum value. Only applies to date and number input types. |
number | string
|
- | |
minlength
|
The minimum length of input that will be considered valid. |
number
|
- | |
name
|
The name of the input, submitted as a name/value pair with form data. |
string
|
''
|
|
noLang
|
Disable any translations for the widget |
boolean
|
- | |
noSpinButtons
no-spin-buttons
|
Hides the browser’s built-in increment/decrement spin buttons for number inputs. |
boolean
|
false
|
|
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 |
string
|
- | |
passwordToggle
password-toggle
|
Adds a button to toggle the password’s visibility. Only applies to password types. |
boolean
|
false
|
|
passwordVisible
password-visible
|
Determines whether or not the password is currently visible. Only applies to password input types. |
boolean
|
false
|
|
pattern
|
A regular expression pattern to validate input against. |
string
|
- | |
pill
|
Draws a pill-style input with rounded edges. |
|
boolean
|
false
|
placeholder
|
Placeholder text to show as a hint when the input is empty. | - | - | |
readonly
|
Makes the input readonly. |
|
boolean
|
false
|
required
|
Makes the input a required field. |
|
boolean
|
false
|
size
|
The input’s size. |
|
'small' | 'medium' | 'large'
|
'medium'
|
spellcheck
|
Enables spell checking on the input. |
boolean
|
true
|
|
statustext
|
Tooltip which is shown for this element on hover |
|
string
|
- |
step
|
Specifies the granularity that the value must adhere to, or the special value any which
means no stepping is implied, allowing any numeric value. Only applies to date and number input
types.
|
number | 'any'
|
- | |
styles
|
WebComponent * | - | - | |
translate
|
List of properties that get translated Done separately to not interfere with properties - if we re-define label property, labels go missing. | - | - | |
type
|
The type of input. Works the same as a native <input> element, but only a subset
of types are supported. Defaults to text.
|
|
| 'date' | 'datetime-local' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'text' |
'time' | 'url'
|
'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. |
string
|
''
|
|
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.
|
- | - | |
needed
|
Compatibility for deprecated name “needed”
use required instead |
- | - | |
options
|
Get property-values as object
use widget methods |
object
|
- | |
readOnly
|
Lion mapping
true |
- | - | |
supportedWidgetClasses
|
et2_widget compatability
Legacy compatability. Some legacy widgets check their parent to see whats allowed |
array
|
[]
|
|
updateComplete |
A read-only promise that resolves when the component has finished updating. |
Learn more about attributes and properties.
Methods
| Name | Description | Arguments |
|---|---|---|
blur()
|
Removes focus from the input. | - |
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 | - |
checkValidity()
|
Checks for validity but does not show a validation message. Returns true when valid and
false when invalid.
|
- |
clone()
|
Creates a copy of this widget. |
_parent: et2_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. |
_node: , _name:
|
et2HandleBlur()
|
If the value is unchanged, put any held validation messages back Named et2HandleBlur to avoid overwriting handleBlur() in Shoelace components |
_ev: FocusEvent
|
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 |
_ev: FocusEvent
|
focus()
|
Sets focus on the input. |
options: FocusOptions
|
getArrayMgr()
|
Returns the array manager object for the given part |
managed_array_type: string
|
getArrayMgrs()
|
Returns an associative array containing the top-most array managers. |
_mgrs: object
|
getChildren()
|
Get child widgets Use |
- |
getForm()
|
Gets the associated form, if one exists. | - |
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 | - |
isValid()
|
Used by etemplate2 to determine if we can submit or not |
messages:
|
loadFromXML()
|
Loads the widget tree from an XML node |
_node:
|
loadingFinished()
|
Needed for legacy compatability. |
promises: Promise[]
|
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. |
_attrsObj: , _target: object, _proto: et2_widget
|
reportValidity()
|
Checks for validity and shows the browser’s validation message if the control is invalid. | - |
select()
|
Selects all the text in the input. | - |
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 |
value: string
|
setArrayMgr()
|
Sets the array manager for the given part |
_part: string, _mgr: object
|
setArrayMgrs()
|
Sets all array manager objects - this function can be used to set the root array managers of the container object. |
_mgrs: object
|
setCustomValidity()
|
Sets a custom validation message. Pass an empty string to restore validity. |
message: string
|
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 |
manager: etemplate2
|
setRangeText()
|
Replaces a range of text with a new string. |
replacement: string, start: number, end: number, selectMode: 'select' | 'start' | 'end' |
'preserve'
|
setSelectionRange()
|
Sets the start and end positions of the text selection (0-based). |
selectionStart: number, selectionEnd: number, selectionDirection: 'forward' | 'backward' | 'none'
|
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. | - |
submit()
|
Called whenever the template gets submitted. We return false if the widget is not valid, which cancels the submission. |
_values:
|
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. |
skipManual:
|
_handleClick()
|
Click handler calling custom handler set via onclick attribute to this.onclick |
_ev: MouseEvent
|
_labelTemplate()
|
Common sub-template to add a label. This goes inside the form control wrapper div, before and at the same depth as the input controls. | - |
_oldChange()
|
Change handler calling custom handler set via onchange attribute |
_ev: Event
|
_set_label()
|
Do some fancy stuff on the label, splitting it up if there’s a %s in it Normally called from updated(), the “normal” setter stuff has already been run before this is called. We only override our special cases (%s) because the normal label has been set by the parent |
value: string
|
_setAriaAttributes()
|
Set aria-attributes on our input node | - |
destroy()
|
et2_widget compatability
true |
- |
set_class()
|
Set the widget class
Use this.class or this.classList instead |
new_class: string
|
set_disabled()
|
Wrapper on this.disabled because legacy had it.
Use widget.disabled for visually disabled, widget.hidden for visually hidden. Widgets that are hidden from the server via attribute or $readonlys will not be created. Widgets that are disabled from the server will not return a value to the application code. |
value: boolean
|
set_statustext()
|
supports legacy set_statustext
use this.statustext |
value: string
|
Learn more about methods.