HTMLInputElement: setCustomValidity() Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since December 2018.

Die Methode HTMLInputElement.setCustomValidity() setzt eine benutzerdefinierte Fehlermeldung für das Element.

Syntax

js
setCustomValidity(message)

Parameter

message

Die Nachricht, die für Validierungsfehler verwendet werden soll.

Rückgabewert

Keiner (undefined).

Ausnahmen

Keine.

Beispiele

In diesem Beispiel übergeben wir die ID eines Eingabeelements und setzen verschiedene Fehlermeldungen abhängig davon, ob der Wert fehlt, zu niedrig oder zu hoch ist. Beachten Sie, dass die Nachricht nicht sofort angezeigt wird. Der Versuch, das Formular abzuschicken, wird die Nachricht anzeigen, oder Sie können die Methode reportValidity() auf dem Element aufrufen.

js
function validate(inputID) {
  const input = document.getElementById(inputID);
  const validityState = input.validity;

  if (validityState.valueMissing) {
    input.setCustomValidity("You gotta fill this out, yo!");
  } else if (validityState.rangeUnderflow) {
    input.setCustomValidity("We need a higher number!");
  } else if (validityState.rangeOverflow) {
    input.setCustomValidity("That's too high!");
  } else {
    input.setCustomValidity("");
  }

  input.reportValidity();
}

Es ist wichtig, die Nachricht auf einen leeren String zu setzen, wenn keine Fehler vorliegen. Solange die Fehlermeldung nicht leer ist, wird das Formular die Validierung nicht bestehen und nicht abgesendet.

Spezifikationen

Specification
HTML Standard
# dom-cva-setcustomvalidity

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch