ElementInternals: reportValidity()-Methode

Baseline 2023

Newly available

Since March 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Die reportValidity()-Methode der ElementInternals-Schnittstelle überprüft, ob das Element alle Einschränkungsvalidierungsregeln erfüllt, die darauf angewendet werden.

Wenn reportValidity false zurückgibt, wird ein abbrechbares ungültiges Ereignis auf dem Element ausgelöst.

Diese Methode verhält sich ähnlich wie ElementInternals.checkValidity(), allerdings übermittelt sie zusätzlich den Wert von ElementInternals.validationMessage an den Benutzeragenten zur Anzeige.

Syntax

reportValidity()

Rückgabewert

Ein boolescher Wert, true, wenn das Element alle Validierungsanforderungen erfüllt.

Ausnahmen

NotSupportedError DOMException: Wird ausgelöst, wenn die formAssociated-Eigenschaft des Elements nicht auf true gesetzt ist.

Im folgenden Beispiel wird ElementInternals.setValidity() verwendet, um anzuzeigen, dass das Element die Validierungsregeln nicht erfüllt. Der Aufruf von reportValidity() gibt false zurück und der Wert "my message" wird an den Benutzeragenten zur Anzeige übermittelt.

Nach einem erneuten Aufruf von setValidity, diesmal unter Angabe, dass alle Regeln falsch markiert sind, gibt reportValidity() true zurück.

let element = document.getElementById("join-checkbox");
element.internals_.setValidity({ valueMissing: true }, "my message");
console.log(element.internals_.reportValidity()); // false
element.internals_.setValidity({});
console.log(element.internals_.reportValidity()); // true

Spezifikationen

Specification
HTML Standard # dom-elementinternals-reportvalidity

Browser-Kompatibilität

BCD tables only load in the browser