Verwendung von HTML-Formularvalidierung und der Constraint Validation API

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

• Durch die Auswahl des am besten semantisch passenden Werts für das type-Attribut des <input>-Elements, z.B. erzeugt die Auswahl des email-Typs automatisch eine Einschränkung, die überprüft, ob der Wert eine gültige E-Mail-Adresse ist.
• Durch Setzen von Werten für validierungsbezogene Attribute, die es ermöglichen, grundlegende Einschränkungen ohne die Notwendigkeit von JavaScript zu beschreiben.

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

Für beide Eingabetypen können, wenn das multiple-Attribut gesetzt ist, mehrere Werte als kommagetrennte Liste festgelegt werden. Wenn einer dieser Werte die hier beschriebene Bedingung nicht erfüllt, wird die Type mismatch Constraint-Verletzung 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.

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

Die Constraint-Validierung wird entweder an einem einzelnen Formularelement oder auf Formularebene am <form>-Element selbst über die Constraint Validation API durchgeführt. Die Validierung der Einschränkungen erfolgt auf folgende Weise:

• Durch einen Aufruf der checkValidity()- oder reportValidity()-Methode eines formularzugehörigen DOM-Interfaces, (HTMLInputElement, HTMLSelectElement, HTMLButtonElement, HTMLOutputElement oder HTMLTextAreaElement), was die Einschränkungen nur auf diesem Element evaluiert und es einem Skript ermöglicht, diese Informationen zu erhalten. Die checkValidity()-Methode gibt ein Boolean zurück, das angibt, ob der Wert des Elements seine Einschränkungen besteht. (Dies wird typischerweise vom Benutzeragenten durchgeführt, wenn er bestimmt, welcher der CSS-Pseudoklassen :valid oder :invalid zutrifft.) Im Gegensatz dazu meldet die reportValidity()-Methode dem Benutzer etwaige Constraint-Verletzungen.
• Durch einen Aufruf der checkValidity()- oder reportValidity()-Methode auf dem HTMLFormElement-Interface.
• Durch das Einreichen des Formulars selbst.

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

Mit Hilfe von JavaScript und der Constraint API ist es möglich, komplexere Einschränkungen zu implementieren, z.B. Einschränkungen, die mehrere Felder kombinieren, oder Einschränkungen, die komplexe Berechnungen beinhalten.

Grundsätzlich besteht die Idee darin, JavaScript beim Auftreten eines bestimmten Ereignisses im Formularfeld (wie onchange) auszuführen, 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 vorliegt und dieser String die Fehlermeldung ist, die dem Benutzer angezeigt werden soll.

Das Postleitzahlformat variiert von Land zu Land. Nicht nur erlauben die meisten Länder eine optionale Präfix mit dem Ländercode (wie D- in Deutschland, F- in Frankreich oder der Schweiz), sondern einige Länder haben Postleitzahlen mit nur einer festen Anzahl von Ziffern; andere wie das Vereinigte Königreich haben komplexere Strukturen, die Buchstaben an bestimmten Positionen erlauben.

Als Beispiel fügen wir ein Skript hinzu, 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 das folgende Formular an:

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

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 = document.getElementById("country").value;

  // Get the NPA field
  const postalCodeField = document.getElementById("postal-code");

  // 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 onchange-Ereignis für das <select> und dem oninput-Ereignis für das <input>:

window.onload = () => {
  document.getElementById("country").onchange = checkPostalCode;
  document.getElementById("postal-code").oninput = checkPostalCode;
};

Eine weitere häufige Einschränkung ist die Begrenzung der Größe einer hochzuladenden Datei. Um dies auf der Clientseite zu überprüfen, bevor die Datei an den Server übertragen wird, muss die Constraint Validation API, insbesondere die field.setCustomValidity()-Methode, mit einer anderen JavaScript API, hier der File API, kombiniert werden.

Hier ist der HTML-Teil:

<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 ermitteln, vergleicht sie mit dem (hartcodierten) Limit und ruft die Constraint API auf, um den Browser zu informieren, ob eine Verletzung vorliegt:

function checkFileSize() {
  const fs = document.getElementById("fs");
  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 verknüpfen wir die Methode mit dem richtigen Ereignis:

window.onload = () => {
  document.getElementById("fs").onchange = checkFileSize;
};

Neben der Festlegung von Einschränkungen möchten Webentwickler die angezeigten Nachrichten kontrollieren und wie sie gestaltet sind.

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

:required und :optional CSS-Pseudoklassen

Die :required und :optional Pseudoklassen erlauben das Schreiben von Selektoren, die Formular-Elemente mit dem required-Attribut oder solche ohne dieses Attribut auswählen.

:placeholder-shown CSS-Pseudoklasse

Siehe :placeholder-shown.

:valid :invalid CSS-Pseudoklassen

Die :valid und :invalid Pseudoklassen werden verwendet, um <input>-Elemente darzustellen, deren Inhalt gültig ist oder nicht, entsprechend der Typ-Einstellung des Eingabefeldes. 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 inkorrekt formatiert sind.

Folgende Punkte können helfen, den Text einer Constraint-Verletzung zu kontrollieren:

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

  • <fieldset>. Hinweis: Das Festlegen einer benutzerdefinierten Fehlermeldung auf Fieldset-Elementen hindert nicht daran, dass das Formular in den meisten Browsern übermittelt wird.
  • <input>
  • <output>
  • <select>
  • Submit-Buttons (erstellt entweder mit einem <button>-Element mit dem submit-Typ oder einem input-Element mit dem submit-Typ. Andere Typen von Schaltflächen nehmen nicht an der Constraint-Validierung teil).
  • <textarea>

• Die ValidityState-Schnittstelle beschreibt das Objekt, das durch die validity-Eigenschaft der oben aufgeführten Elementtypen zurückgegeben wird. Sie stellt verschiedene Gründe dar, warum ein eingegebener Wert ungültig sein kann. Zusammen helfen sie zu erklären, warum ein Wert eines Elements nicht gültig ist, falls er es nicht ist.