Text input - Web Component โ
The TextInput component can be used imported from:
Playground โ
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 | A11y |
---|---|---|---|---|
config | string | The main parameter has two components following the pattern:
| ||
label | string | Label of the input | label | |
placeholder | string | Placeholder of the input | ||
readonly | boolean | Transforms the input into an output | ||
autocomplete | string | Automated assistance in filling out form field values | ||
model | 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 | ||
max-length | number | The maximum number of characters allowed in the input | ||
input-type | string | The type of input. Possible values are:
| ||
data-list | string[] | Presents a list of suggestions for the input | default |
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 |
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.
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 readonly
parameter is used to set the input in a read-only state. It's commonly used to display information.
invalid
โ
The invalid
parameter is used to set the component as invalid.
align-right
โ
The align-right
parameter aligns the input text to the right:
It can de combined with icon
:
Special 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