Verwendung von HTML-Formularvalidierung und der Constraint Validation API

Intrinsische und grundlegende Einschränkungen

In HTML werden grundlegende Einschränkungen auf zwei Arten deklariert:

• Durch Auswahl des semantisch passendsten Wertes für das type-Attribut des <input>-Elements, z. B. erzeugt die Wahl des email Typs automatisch eine Einschränkung, die überprüft, ob der Wert eine gültige E-Mail-Adresse ist.
• Durch das Setzen von Werten auf validierungsbezogenen Attributen, die grundlegende Einschränkungen beschreiben, ohne dass JavaScript benötigt wird.

Semantische Input-Typen

Die intrinsischen Einschränkungen für das type-Attribut sind:

Für beide dieser Eingabetypen, wenn das multiple-Attribut gesetzt ist, können mehrere Werte als durch Kommas getrennte Liste gesetzt werden. Wenn eine dieser Bedingungen nicht erfüllt wird, wird die Type mismatch Einschränkungsverletzung ausgelöst.

Beachten Sie, dass die meisten Eingabetypen keine intrinsischen Einschränkungen haben, da einige von der Constraint-Validierung ausgeschlossen sind oder einen Bereinigungsalgorithmus haben, der falsche Werte in einen korrekten Standardwert umwandelt.

Validierungsbezogene Attribute

Zusätzlich zum oben beschriebenen type-Attribut werden die folgenden Attribute verwendet, um grundlegende Einschränkungen zu beschreiben:

Prozess der Constraint-Validierung

Die Constraint-Validierung erfolgt über die Constraint Validation API entweder auf einem einzelnen Formularelement oder auf der Formularebene, auf dem <form>-Element selbst. Die Constraint-Validierung erfolgt in den folgenden Weisen:

• Durch einen Aufruf der checkValidity() oder reportValidity() Methode eines formularassoziierten DOM-Interfaces (HTMLInputElement, HTMLSelectElement, HTMLButtonElement, HTMLOutputElement oder HTMLTextAreaElement), die die Einschränkungen nur auf diesem Element auswertet, um ein Skript diese Informationen erhalten zu lassen. Die checkValidity() Methode gibt einen Boolean zurück, der anzeigt, ob der Wert des Elements seine Einschränkungen erfüllt. (Dies wird typischerweise vom Benutzeragenten getan, um zu bestimmen, welche der CSS-Pseudoklassen, :valid oder :invalid, angewendet wird.) Im Gegensatz dazu meldet die reportValidity() Methode dem Benutzer etwaige Einschränkungsfehler.
• Durch einen Aufruf der checkValidity() oder reportValidity() Methode auf dem HTMLFormElement Interface.
• Durch das Absenden des Formulars selbst.

Der Aufruf von checkValidity() wird als statische Validierung der Einschränkungen bezeichnet, während der Aufruf von reportValidity() oder das Absenden des Formulars als interaktive Validierung der Einschränkungen bezeichnet wird.

Komplexe Einschränkungen mittels der Constraint Validation API

Mithilfe von JavaScript und der Constraint API ist es möglich, komplexere Einschränkungen zu implementieren, zum Beispiel Einschränkungen, die mehrere Felder kombinieren, oder Einschränkungen, die komplexe Berechnungen beinhalten.

Grundsätzlich besteht die Idee darin, JavaScript bei einem bestimmten Ereignis eines Formularfelds (wie onchange) auszulösen, um zu berechnen, ob die Einschränkung verletzt wird, und dann die Methode field.setCustomValidity() zu verwenden, um das Ergebnis der Validierung festzulegen: Ein leerer String bedeutet, dass die Einschränkung erfüllt ist, und jeder andere String bedeutet, dass ein Fehler aufgetreten ist und dieser String die Fehlermeldung ist, die dem Benutzer angezeigt wird.

Einschränkung mehrerer Felder: Postleitzahlenvalidierung

Das Format der Postleitzahlen variiert von Land zu Land. Viele Länder erlauben ein optionales Präfix mit dem Ländercode (wie D- in Deutschland, F- in Frankreich und CH- in der Schweiz). Einige Länder verwenden nur eine feste Anzahl von Ziffern in Postleitzahlen, während andere, wie das Vereinigte Königreich, komplexere Formate haben, die Buchstaben an bestimmten Positionen erlauben.

Als Beispiel werden wir ein Skript hinzufügen, das die Constraint-Validierung für ein Formular überprüft:

<form>
  <label for="postal-code">Postal Code: </label>
  <input type="text" id="postal-code" />
  <label for="country">Country: </label>
  <select id="country">
    <option value="ch">Switzerland</option>
    <option value="fr">France</option>
    <option value="de">Germany</option>
    <option value="nl">The Netherlands</option>
  </select>
  <input type="submit" value="Validate" />
</form>

Dies zeigt folgendes Formular an:

Zuerst schreiben wir eine Funktion, die die Einschränkung selbst überprüft:

const countrySelect = document.getElementById("country");
const postalCodeField = document.getElementById("postal-code");

function checkPostalCode() {
  // For each country, defines the pattern that the postal code has to follow
  const constraints = {
    ch: [
      "^(CH-)?\\d{4}$",
      "Swiss postal codes must have exactly 4 digits: e.g. CH-1950 or 1950",
    ],
    fr: [
      "^(F-)?\\d{5}$",
      "French postal codes must have exactly 5 digits: e.g. F-75012 or 75012",
    ],
    de: [
      "^(D-)?\\d{5}$",
      "German postal codes must have exactly 5 digits: e.g. D-12345 or 12345",
    ],
    nl: [
      "^(NL-)?\\d{4}\\s*([A-RT-Z][A-Z]|S[BCE-RT-Z])$",
      "Dutch postal codes must have exactly 4 digits, followed by 2 letters except SA, SD and SS",
    ],
  };

  // Read the country id
  const country = countrySelect.value;

  // Build the constraint checker
  const constraint = new RegExp(constraints[country][0], "");
  console.log(constraint);

  // Check it!
  if (constraint.test(postalCodeField.value)) {
    // The postal code follows the constraint, we use the ConstraintAPI to tell it
    postalCodeField.setCustomValidity("");
  } else {
    // The postal code doesn't follow the constraint, we use the ConstraintAPI to
    // give a message about the format required for this country
    postalCodeField.setCustomValidity(constraints[country][1]);
  }
}

Dann verknüpfen wir sie mit dem change-Ereignis für das <select> und dem input-Ereignis für das <input>:

countrySelect.addEventListener("change", checkPostalCode);
postalCodeField.addEventListener("input", checkPostalCode);

Begrenzung der Dateigröße vor dem Hochladen

Eine weitere übliche Einschränkung ist die Begrenzung der Größe einer hochzuladenden Datei. Die Überprüfung auf der Client-Seite, bevor die Datei an den Server übertragen wird, erfordert die Kombination der Constraint Validation API und insbesondere der field.setCustomValidity() Methode mit einer anderen JavaScript-API, hier der File API.

Hier ist der HTML-Part:

<label for="fs">Select a file smaller than 75 kB: </label>
<input type="file" id="fs" />

Dies zeigt:

Das JavaScript liest die ausgewählte Datei, verwendet die File.size() Methode, um ihre Größe zu erhalten, vergleicht sie mit dem (hart kodierten) Limit und ruft die Constraint API auf, um den Browser zu informieren, ob eine Verletzung vorliegt:

const fs = document.getElementById("fs");

function checkFileSize() {
  const files = fs.files;

  // If there is (at least) one file selected
  if (files.length > 0) {
    if (files[0].size > 75 * 1000) {
      // Check the constraint
      fs.setCustomValidity("The selected file must not be larger than 75 kB");
      fs.reportValidity();
      return;
    }
  }
  // No custom constraint violation
  fs.setCustomValidity("");
}

Schließlich verbinden wir die Methode mit dem richtigen Ereignis:

fs.addEventListener("change", checkFileSize);

Visuelles Styling der Constraint-Validierung

Neben dem Setzen von Einschränkungen möchten Webentwickler kontrollieren, welche Nachrichten den Benutzern angezeigt werden und wie sie gestaltet werden.

Steuerung des Erscheinungsbildes von Elementen

Das Erscheinungsbild von Elementen kann über CSS-Pseudoklassen gesteuert werden.

:required und :optional CSS-Pseudoklassen

Die :required und :optional Pseudo-Klassen ermöglichen es, Selektoren zu schreiben, die Formularelemente auswählen, die das required Attribut haben oder nicht haben.

:placeholder-shown CSS-Pseudoklasse

Siehe :placeholder-shown.

:valid :invalid CSS-Pseudoklassen

Die :valid und :invalid Pseudo-Klassen werden verwendet, um <input>-Elemente darzustellen, deren Inhalt gemäß der Typeneinstellung des Eingabefelds validiert bzw. nicht validiert wird. Diese Klassen ermöglichen es dem Benutzer, gültige oder ungültige Formularelemente zu stylen, um es einfacher zu machen, Elemente zu identifizieren, die entweder korrekt oder falsch formatiert sind.

Steuerung des Textes der Einschränkungsverletzung

Folgende Punkte können helfen, den Text einer Einschränkungsverletzung zu steuern:

• Die setCustomValidity(message) Methode auf den folgenden Elementen:

  • <fieldset>. Hinweis: Das Setzen einer benutzerdefinierten Fehlermeldung auf fieldset-Elemente verhindert nicht die Formularübermittlung in den meisten Browsern.
  • <input>
  • <output>
  • <select>
  • Sende-Schaltflächen (erstellt mit entweder einem <button> Element mit dem submit-Typ, oder einem input Element mit dem submit Typ. Andere Arten von Schaltflächen nehmen nicht an der Constraint-Validierung teil.
  • <textarea>

• Das ValidityState Interface beschreibt das Objekt, das von der validity-Eigenschaft der oben aufgelisteten Elementtypen zurückgegeben wird. Es stellt verschiedene Möglichkeiten dar, wie ein eingegebener Wert ungültig sein kann. Zusammen helfen sie zu erklären, warum der Wert eines Elements nicht gültig ist, falls er es nicht ist.