Skip to content 
Text input
Text input - Web Component
The TextInput component can be used imported from:
Playground
Parameters
...
Events
This component has events. Check the documentation about how to use the events.
| Name | Payload | Description |
|---|---|---|
change | string | Returns the new value of the "value" attribute |
enter | void | Triggered when "Enter" in pressed |
restarted | void | Emitted on value reset |
blur | void | Emitted on blur |
validated | boolean | Emitted when the validation status changes |
Slots
This component has slots. Check the documentation about how to use the slots.
| Name | Tags | Description |
|---|---|---|
default | span | |
label | span | |
help-text | span |
Parameters use
config
The config parameter is used to set the shape of the input between lined and shaped. Being omitted will render the default line shape.
label
The label parameter is used to set the text label of the component. Make sure you always use it.
Can also use the label slot:
model
The model parameter is used to set the text for the input.
Attention!
If you hardcode this value, it will not be reactive and the selection won't change. Use a variable instead and, ideally, a closed loop.
name
The name parameter is used to set the name of the component. This is useful when the component is part of a form.
help-text
The help-text parameter is used to provide additional assistance to the user.
input-type
The input-type parameter is used to set the type of input. Possible values are: text, tel, email and url.
icon
The icon parameter is used to set an icon to the input. The icon will be displayed on the right side of the input.
max-length
The max-length parameter is used to set the maximum number of characters that the user can input. A counter will be displayed below the input.
data-list
The data-list parameter is used to set a list of suggestions for the input. The list must be an array of strings.
Or using the default slot with <option> tags:
Flags
disabled
The disabled parameter is used to block the interaction with the component. Not to be confused with readonly.
readonly
The readonly parameter is used to set the input in a read-only state. It's commonly used to display information.
required
The required parameter is used to set the component as required.
The default text adapts to the localization:
invalid
The invalid parameter is used to set the component as invalid.
The default text adapts to the localization:
align-right
The align-right parameter aligns the input text to the right:
It can de combined with icon:
Methods
reset()
We can all the reset() method of the WebComponent in order to reset the value. This will clean the internal states and emit the nullable value with the change event, plus a restarted event:
In this example, the button triggers the method:
Value:
undefinedSpecial uses
Search
We can use the TextInput as a search, where the data-list are the available terms and then listening to the right events to trigger the search action:
Tip
You can selectively pass data-list only if a certain length has been reached in input, or even filtering, slicing, or sorting the data-list dynamically
Combined inputs
We can combine different inputs to achieve more control over the inputs:
Tip
This approach allows individual or combinational validation in addition to the more restrictive input options. The validation of one field can be dependant on the other or vice versa, ensuring more robust forms in the frontend side.
Browser support
Detected engine:
Chromium
Webkit
Gecko