Text input

Search

Text input is a form element that allows users to input data entries with any combination of letters, numbers or symbols. It is used for short entries that span across a single line, such as names, addresses, emails or passwords.

Implementations

The component TextInput is available in the following technologies:

CSS Components

Web Components

Parameters

Parameters

Make sure you have read about the parameters in here.

The parametrization of the component can be done with the following custom params or properties:

Name	Type	Slot	Description
config	string		The main parameter has two components following the pattern: <shape><?:size>. shape: (optional) Establishes the styling of the input. Default value is shaped, assumed if nothing is specified. Possible values are: shaped or line. export type ZInput_Type = 'shaped' | 'line'; size: (optional) defines de size of the input. The default value is m, being omitted from the param. The possible values are: m or l. export type ZInput_Size = 'm' | 'l';
label	string	✅	Label of the input
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 by using the disabled attribute of the HTML input element.
required	boolean		Marks the input component as required. If and interaction is made with the input and the value is nullable or empty, the input will be marked as invalid as using the invalid attribute.
name	string		Identification for the field inside the form.
help-text	string	✅	The forced message to be shown under the input. It is used to give more information about the input, or a message to the user, specially when the input is invalid.
invalid	boolean		The attribute that forces the state of the input as invalid.
locale	string		The locale parameter is used to set the locale of the component. The value must be part of the registered locales in ZDS. If not set, the default locale of the document will be used. Have a look to the localization mechanisms.
max-length	number		The maximum number of characters allowed in the input
input-type	string		The type of input. Possible values are: text: it will handle a single line of text. tel: it will handle a telephone number. email: it will handle an email address. url: it will handle an URL.
data-list	string[]		Presents a list of suggestions for the input
min-length	number		The minimum number of characters allowed in the input
icon	string		Icon to be displayed in the input
pattern	string
no-counter	boolean		Hides the character counter
align-right	boolean		Aligns the text to the right
custom	object		A record of key-value pairs to set the CSS custom tokens. It's a complex attribute set as an JS object in stringified JSON format. Example: <z-text-input custom='{"fill":"#06e7a3"}' /> Check the available values in the customization section.
custom-str	string		The stringified version of the custom property. It follows the pattern key:value;key:value;, with the possibility of setting multiple values and spaces between the punctuation characters. Example: <z-text-input custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-text-input z-theme="dark" />

From Figma to code

...

Customization

INFO

Check everything about the customization mechanics in the "How it works" documentation.

No customization tokens yet implemented for this component

Accessibility

...

Related components