TextField
I campi di testo, tipicamente utilizzati in moduli e dialoghi, consentono agli utenti di inserire testo.
Utilizzo
Importa il componente:
import 'mdui/components/text-field.js';
Importa il tipo TypeScript:
import type { TextField } from 'mdui/components/text-field.js';
Esempio:
<mdui-text-field label="Campo di testo"></mdui-text-field>Testo di Supporto
L'attributo label imposta il testo dell'etichetta sopra il campo di testo.
L'attributo placeholder imposta il testo segnaposto quando il campo è vuoto.
L'attributo helper o lo slot helper imposta il testo di supporto nella parte inferiore del campo di testo. Per visualizzare il testo di supporto solo quando l'input è focalizzato, usa l'attributo helper-on-focus.
Cancellabile
L'attributo clearable aggiunge un pulsante di cancellazione a destra quando il campo di testo ha un valore.
Testo Allineato a Destra
L'attributo end-aligned allinea il testo a destra.
Prefisso, Suffisso, Icone
Gli attributi o gli slot icon e end-icon aggiungono Icone Material rispettivamente a sinistra e a destra del campo di testo.
Gli attributi o gli slot prefix e suffix aggiungono testo a sinistra e a destra del campo di testo. Questo testo viene mostrato solo quando il campo di testo è focalizzato o ha un valore.
Solo Lettura
L'attributo readonly rende il campo di testo di sola lettura.
Disabilitato
L'attributo disabled disabilita il campo di testo.
Campo di Testo Multiriga
L'attributo rows imposta il numero di righe per un campo di testo multiriga.
Per regolare automaticamente l'altezza del campo di testo in base alla lunghezza dell'input, usa l'attributo autosize. Gli attributi min-rows e max-rows specificano il numero minimo e massimo di righe.
Contatore di Caratteri
L'attributo maxlength imposta il numero massimo di caratteri per il campo di testo. Per visualizzare un contatore di caratteri sotto il campo di testo, usa l'attributo counter.
Campo Password
Per i campi password (type="password"), l'attributo toggle-password aggiunge un pulsante a destra per alternare la visibilità della password.
API
Proprietà
| Attributo HTML | Proprietà JavaScript | Reflect | Tipo | Predefinito |
|---|---|---|---|---|
variant | variant | 'filled' | 'outlined' | 'filled' | |
Forma del campo di testo. Il valore predefinito è
| ||||
type | type | 'text' | 'number' | 'password' | 'url' | 'email' | 'search' | 'tel' | 'hidden' | 'date' | 'datetime-local' | 'month' | 'time' | 'week' | 'text' | |
Tipo di input del campo di testo. Il valore predefinito è
| ||||
name | name | string | '' | |
Nome del campo di testo, verrà inviato insieme ai dati del modulo | ||||
value | value | string | '' | |
Valore del campo di testo, verrà inviato insieme ai dati del modulo | ||||
defaultValue | string | '' | ||
Valore predefinito. Quando si reimposta il modulo, verrà ripristinato a questo valore predefinito. Questa proprietà può essere impostata solo tramite JavaScript. | ||||
label | label | string | - | |
Testo dell'etichetta | ||||
placeholder | placeholder | string | - | |
Testo del segnaposto | ||||
helper | helper | string | - | |
Testo di aiuto nella parte inferiore del campo di testo. Può anche essere impostato tramite | ||||
helper-on-focus | helperOnFocus | boolean | false | |
Se mostrare il testo di aiuto nella parte inferiore solo quando si riceve il focus | ||||
clearable | clearable | boolean | false | |
Se è possibile svuotare il contenuto del campo di testo | ||||
clear-icon | clearIcon | string | - | |
Nome dell'icona Material per il pulsante di cancellazione visualizzato a destra del campo di testo quando è cancellabile. Può anche essere impostato tramite | ||||
end-aligned | endAligned | boolean | false | |
Se allineare il testo a destra | ||||
prefix | prefix | string | - | |
Testo del prefisso del campo di testo. Viene visualizzato solo quando il campo di testo è in focus o ha un valore. Può anche essere impostato tramite | ||||
suffix | suffix | string | - | |
Testo del suffisso del campo di testo. Viene visualizzato solo quando il campo di testo è in focus o ha un valore. Può anche essere impostato tramite | ||||
icon | icon | string | - | |
Nome dell'icona Material per l'icona del prefisso del campo di testo. Può anche essere impostato tramite | ||||
end-icon | endIcon | string | - | |
Nome dell'icona Material per l'icona del suffisso del campo di testo. Può anche essere impostato tramite | ||||
error-icon | errorIcon | string | - | |
Nome dell'icona Material visualizzata a destra del campo di testo quando la convalida del campo del modulo fallisce. Può anche essere impostato tramite | ||||
form | form | string | - | |
Elemento Se questo attributo non è specificato, l'elemento deve essere un elemento figlio dell'elemento | ||||
readonly | readonly | boolean | false | |
Se è in modalità di sola lettura | ||||
disabled | disabled | boolean | false | |
Se il campo di input deve essere disabilitato | ||||
required | required | boolean | false | |
Se è obbligatorio compilare questo campo al momento dell'invio del modulo | ||||
rows | rows | number | - | |
Numero di righe fisse visualizzate per il campo di testo | ||||
autosize | autosize | boolean | false | |
Se regolare automaticamente l'altezza del campo di testo in base al contenuto inserito | ||||
min-rows | minRows | number | - | |
Quando | ||||
max-rows | maxRows | number | - | |
Quando | ||||
minlength | minlength | number | - | |
Numero minimo di caratteri consentito | ||||
maxlength | maxlength | number | - | |
Numero massimo di caratteri consentito | ||||
counter | counter | boolean | false | |
Se mostrare il conteggio dei caratteri, valido solo quando è specificato | ||||
min | min | number | - | |
Quando | ||||
max | max | number | - | |
Quando | ||||
step | step | number | - | |
Quando | ||||
pattern | pattern | string | - | |
Espressione regolare per la convalida del modulo | ||||
toggle-password | togglePassword | boolean | false | |
Quando | ||||
show-password-icon | showPasswordIcon | string | - | |
Icona Material per il pulsante di commutazione della password, visualizzata quando la password è in chiaro. Può anche essere impostato tramite | ||||
hide-password-icon | hidePasswordIcon | string | - | |
Icona Material per il pulsante di commutazione della password, visualizzata quando la password è mascherata. Può anche essere impostato tramite | ||||
autocapitalize | autocapitalize | 'none' | 'sentences' | 'words' | 'characters' | - | |
Attributo non standard di iOS, utilizzato per controllare se la prima lettera del testo deve essere automaticamente in maiuscolo. Valido su iOS5 e versioni successive. I valori opzionali includono:
| ||||
autocorrect | autocorrect | string | - | |
Attributo | ||||
autocomplete | autocomplete | string | - | |
Attributo | ||||
enterkeyhint | enterkeyhint | 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send' | - | |
Attributo
| ||||
spellcheck | spellcheck | boolean | false | |
Se abilitare il controllo ortografico | ||||
inputmode | inputmode | 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url' | - | |
Attributo
| ||||
validity | ValidityState | - | ||
Oggetto dello stato di convalida del modulo, per i dettagli fare riferimento a | ||||
validationMessage | string | - | ||
Se la convalida del modulo non viene superata, questo attributo conterrà un messaggio informativo. Se la convalida viene superata, questo attributo sarà una stringa vuota | ||||
valueAsNumber | number | - | ||
Ottiene il valore corrente e lo converte in tipo | ||||
autofocus | autofocus | boolean | false | |
Se deve ricevere automaticamente il focus al caricamento della pagina | ||||
tabindex | tabIndex | number | - | |
Ordine di tabulazione dell'elemento | ||||
Metodi
| Nome | Parametri | Restituisce |
|---|---|---|
select | void | |
Seleziona il testo nel campo di testo | ||
setSelectionRange |
| void |
Seleziona un intervallo specifico di contenuto nel campo di testo | ||
setRangeText |
| void |
Sostituisce il testo in un intervallo specifico del campo di testo con un nuovo testo | ||
checkValidity | boolean | |
Verifica se il campo del modulo supera la convalida. In caso contrario, restituisce | ||
reportValidity | boolean | |
Verifica se il campo del modulo supera la convalida. In caso contrario, restituisce Se la convalida non viene superata, viene visualizzato un messaggio di errore sul componente. | ||
setCustomValidity |
| void |
Imposta un messaggio di errore personalizzato. Finché questo testo non è vuoto, significa che il campo non ha superato la convalida | ||
click | void | |
Simula un clic del mouse sull'elemento | ||
focus |
| void |
Imposta il focus sull'elemento corrente. È possibile passare un oggetto come parametro, le cui proprietà includono:
| ||
blur | void | |
Rimuove il focus dall'elemento corrente | ||
Eventi
| Nome |
|---|
focus |
Attivato quando si riceve il focus |
blur |
Attivato quando si perde il focus |
change |
Attivato quando il valore del campo di testo cambia e si perde il focus |
input |
Attivato quando il valore del campo di testo cambia |
invalid |
Attivato quando la convalida del campo del modulo non viene superata |
clear |
Attivato quando si fa clic sul pulsante di cancellazione generato dall'attributo |
Slots
| Nome |
|---|
icon |
Icona a sinistra |
end-icon |
Icona a destra |
error-icon |
Icona a destra nello stato di errore di convalida |
prefix |
Testo a sinistra |
suffix |
Testo a destra |
clear-button |
Pulsante di cancellazione |
clear-icon |
Icona nel pulsante di cancellazione |
toggle-password-button |
Pulsante per mostrare o nascondere la password |
show-password-icon |
Icona del pulsante quando la password è visibile |
hide-password-icon |
Icona del pulsante quando la password è nascosta |
helper |
Testo di aiuto in basso |
CSS Parts
| Nome |
|---|
container |
Contenitore del campo di testo |
icon |
Icona a sinistra |
end-icon |
Icona a destra |
error-icon |
Icona a destra nello stato di errore di convalida |
prefix |
Testo a sinistra |
suffix |
Testo a destra |
label |
Testo dell'etichetta in alto |
input |
Elemento |
clear-button |
Pulsante di cancellazione |
clear-icon |
Icona nel pulsante di cancellazione |
toggle-password-button |
Pulsante per mostrare o nascondere la password |
show-password-icon |
Icona del pulsante quando la password è visibile |
hide-password-icon |
Icona del pulsante quando la password è nascosta |
supporting |
Contenitore delle informazioni di supporto nella parte inferiore, inclusi helper, error e counter |
helper |
Testo di aiuto nella parte inferiore |
error |
Testo di descrizione dell'errore nella parte inferiore |
counter |
Conteggio dei caratteri in basso a destra |