Text input - Web Component
Browser support
Detected engine:
Chromium
Webkit
Gecko
Parameters
The Web component uses the <z-text-input> tag:
By default, all the parameters are optional or can be set in different, except for the ones marked as required
The parametrization of the component can be done with the following custom HTML params:
| Name | Type | Description | Slot |
|---|---|---|---|
config | string | The main parameter has two components following the pattern:
| |
label | string | Label of the input | label |
readonly | boolean | Transforms the input into an output | |
value | string | Value of the model | |
disabled | boolean | Blocks the interaction with the input component. | |
required | boolean | Marks the input component as required. | |
name | string | Identification for the field inside the form | |
help-text | string | The forced message to be shown under the input | help-text |
invalid | boolean | The forced state for set the input as invalid | |
input-type | string | The type of input. Possible values are:
| |
data-list | string | Presents a list of suggestions for the input. Values to be separated by comma. |
The events emitted from the component are:
| 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 |
The available slots for the component are:
| Name | Tags | Description |
|---|---|---|
default | span |
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.
readonly
The readonly parameter is used to set the input in a read-only state. It's commonly used to display information.
value
The value parameter is used to set the text for the input.
disabled
The disabled parameter is used to block the interaction with the component. Not to be confused with readonly.
required
The required parameter is used to set the component as required.
name
The name parameter is used to set the name of the component. This is useful when the component is part of a form.
invalid
The invalid parameter is used to set the component as invalid.
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.