--- title: 制約検証 slug: Web/Guide/HTML/Constraint_validation tags: - CSS - Guide - HTML5 - NeedsContent - Selectors translation_of: Web/Guide/HTML/Constraint_validation original_slug: Web/Guide/HTML/HTML5/Constraint_validation ---
ウェブフォームの作成は常に複雑な作業でした。フォーム自体をマークアップすること自体は簡単ですが、それぞれの入力欄が妥当で一貫しているかどうかをチェックすることはもっと難しく、問題をユーザーに伝えることは頭痛がするかもしれません。HTML5 では、フォームに新しい仕組みが導入されました。{{ HTMLElement("input") }} 要素に意味を持つ新しい型と、クライアント側でフォームの内容をチェックする作業を簡単にする制約検証が追加されました。基本的な、よくある制約は、JavaScript を必要とせずに、新しい属性を設定することでチェックできます。もっと複雑な制約は制約検証 API を使用して検査することができます。
これらの概念の基本的な入門 (サンプル付き) は、フォーム検証チュートリアルをご覧ください。
HTML5 では、基本的な制約は 2通りの方法で定義されます。
email
を選択することで、値が妥当なメールアドレスであるかどうかをチェックする制約が自動的に作成されます。{{ htmlattrxref("type", "input") }} 属性の組込み制約は次の通りです。
入力型 | 制約の説明 | 関連付けられた違反 |
---|---|---|
<input type="URL"> |
値は絶対 URL であり、URL Living Standard で定義された通りでなければなりません。 | TypeMismatch 制約違反 |
<input type="email"> |
値は統語的に妥当なメールアドレス、ふつうは username@hostname.tld の書式でなければなりません。 |
TypeMismatch 制約違反 |
これらの入力型のどちらでも、{{ htmlattrxref("multiple", "input") }} 属性が設定されていたら、この入力欄にカンマ区切りのリストで複数の値を設定することができます。これらの中でここで書かれた条件に満足しないものがある場合、Type mismatch 制約違反が発生します。
なお、ほとんどの入力型には組込み制約がありません。制約検証によって防ぐことができたり、既定で不正な値を妥当な値に変換する無害化アルゴリズムがあったりするためです。
上記で述べた type
属性に加えて、下記の要素が基本的な制約を記述するのに使われます。
属性 | 属性をサポートする入力タイプ | とりうる値 | 制約の説明 | 関連する違反 |
---|---|---|---|---|
pattern |
text , search , url , tel , email , password |
JavaScript 正規表現 (ECMAScript 5 global , ignoreCase と multiline フラグが無効でコンパイルされたもの) |
値はパターンに一致する必要があります。 | patternMismatch 制約違反 |
min |
range , number |
有効な数値 | 値以上であること。 | rangeUnderflow 制約違反 |
date , month , week |
有効な日付 | |||
datetime , datetime-local , time |
有効な日付と時刻 | |||
max |
range , number |
有効な数値 | 値以下であること。 | rangeOverflow 制約違反 |
date , month , week |
有効な日付 | |||
datetime , datetime-local , time |
有効な日付と時刻 | |||
required |
text , search , url , tel , email , password , date , datetime , datetime-local , month , week , time , number , checkbox , radio , file ; {{ HTMLElement("select") }} と {{ HTMLElement("textarea") }} 要素にも。 |
none Boolean 属性のため: 存在すれば true, 存在しなければ false | 値は必須 (セットされた場合)。 | valueMissing 制約違反 |
step |
date |
日の整数値 | step がリテラル値 any にセットされていない場合、値は min + step の整数倍 |
stepMismatch 制約違反 |
month |
月の整数値 | |||
week |
週の整数値 | |||
datetime , datetime-local , time |
秒の整数値 | |||
range , number |
整数値 | |||
minlength |
text , search , url , tel , email , password ; と {{ HTMLElement("textarea") }} 要素 |
整数長 | 文字列数 (code points) は、空でない場合は属性値より少なくならない。{{ HTMLElement("textarea") }}では改行はすべて 1 つの文字に正規化される (CRLF の組と対象的に)。 | tooShort 制約違反 |
maxlength |
text , search , url , tel , email , password ; と {{ HTMLElement("textarea") }} 要素 |
整数長 | 文字列数 (code points) は属性値を超えない。 | tooLong 制約違反 |
Constraint validation is done through the Constraint Validation API either on a single form element or at the form level, on the {{ HTMLElement("form") }} element itself. The constraint validation is done in the following ways:
checkValidity()
or reportValidity()
method of a form-associated DOM interface, (HTMLInputElement
, HTMLSelectElement
, HTMLButtonElement
, HTMLOutputElement
or HTMLTextAreaElement
), which evaluates the constraints only on this element, allowing a script to get this information. The checkValidity()
method returns a Boolean indicating whether the element's value passes its constraints. (This is typically done by the user-agent when determining which of the CSS pseudo-classes, {{ Cssxref(":valid") }} or {{ Cssxref(":invalid") }}, applies.) In contrast, the reportValidity()
method reports any constraint failures to the user.checkValidity()
or reportValidity()
method on the HTMLFormElement
interface.Calling checkValidity()
is called statically validating the constraints, while calling reportValidity()
or submitting the form is called interactively validating the constraints.
submit()
method on the HTMLFormElement
interface doesn't trigger a constraint validation. In other words, this method sends the form data to the server even if doesn't satisfy the constraints. Call the click()
method on a submit button instead.Using JavaScript and the Constraint API, it is possible to implement more complex constraints, 例えば、constraints combining several fields, or constraints involving complex calculations.
Basically, the idea is to trigger JavaScript on some form field event (like onchange) to calculate whether the constraint is violated, and then to use the method field.setCustomValidity()
to set the result of the validation: an empty string means the constraint is satisfied, and any other string means there is an error and this string is the error message to display to the user.
The postal code format varies from one country to another. Not only do most countries allow an optional prefix with the country code (like D-
in Germany, F-
in France or Switzerland), but some countries have postal codes with only a fixed number of digits; others, like the UK, have more complex structures, allowing letters at some specific positions.
注: This is not a comprehensive postal code validation library, but rather a demonstration of the key concepts.
As an example, we will add a script checking the constraint validation for this simple form:
<form> <label for="ZIP">ZIP : </label> <input type="text" id="ZIP"> <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>
This displays the following form:
{{EmbedLiveSample("Constraint_combining_several_fields_Postal_code_validation")}}
First, we write a function checking the constraint itself:
function checkZIP() { // For each country, defines the pattern that the ZIP has to follow var constraints = { ch : [ '^(CH-)?\\d{4}$', "Switzerland ZIPs must have exactly 4 digits: e.g. CH-1950 or 1950" ], fr : [ '^(F-)?\\d{5}$' , "France ZIPs must have exactly 5 digits: e.g. F-75012 or 75012" ], de : [ '^(D-)?\\d{5}$' , "Germany ZIPs 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])$', "Nederland ZIPs must have exactly 4 digits, followed by 2 letters except SA, SD and SS" ] }; // Read the country id var country = document.getElementById("Country").value; // Get the NPA field var ZIPField = document.getElementById("ZIP"); // Build the constraint checker var constraint = new RegExp(constraints[country][0], ""); console.log(constraint); // Check it! if (constraint.test(ZIPField.value)) { // The ZIP follows the constraint, we use the ConstraintAPI to tell it ZIPField.setCustomValidity(""); } else { // The ZIP doesn't follow the constraint, we use the ConstraintAPI to // give a message about the format required for this country ZIPField.setCustomValidity(constraints[country][1]); } }
Then we link it to the onchange event for the {{ HTMLElement("select") }} and the oninput event for the {{ HTMLElement("input") }}:
window.onload = function () { document.getElementById("Country").onchange = checkZIP; document.getElementById("ZIP").oninput = checkZIP; }
You can see a live example of the postal code validation.
Another common constraint is to limit the size of a file to be uploaded. Checking this on the client side before the file is transmitted to the server requires combining the Constraint Validation API, and especially the field.setCustomValidity()
method, with another JavaScript API, here the File API.
Here is the HTML part:
<label for="FS">Select a file smaller than 75 kB : </label> <input type="file" id="FS">
This displays:
{{EmbedLiveSample("Limiting_the_size_of_a_file_before_its_upload")}}
The JavaScript reads the file selected, uses the File.size()
method to get its size, compares it to the (hard coded) limit, and calls the Constraint API to inform the browser if there is a violation:
function checkFileSize() { var FS = document.getElementById("FS"); var files = FS.files; // If there is (at least) one file selected if (files.length > 0) { if (files[0].size > 75 * 1024) { // Check the constraint FS.setCustomValidity("The selected file must not be larger than 75 kB"); return; } } // No custom constraint violation FS.setCustomValidity(""); }
Finally we hook the method with the correct event:
window.onload = function () { document.getElementById("FS").onchange = checkFileSize; }
You can see a live example of the File size constraint validation.
Apart from setting constraints, web developers want to control what messages are displayed to the users and how they are styled.
The look of elements can be controlled via CSS pseudo-classes.
The {{cssxref(':required')}} and {{cssxref(':optional')}} pseudo-classes allow writing selectors that match form elements that have the {{ htmlattrxref("required") }} attribute, or that don't have it.
See {{cssxref(':placeholder-shown')}}
The {{cssxref(':valid')}} and {{cssxref(':invalid')}} pseudo-classes are used to represent <input> elements whose content validates and fails to validate respectively according to the input's type setting. These classes allow the user to style valid or invalid form elements to make it easier to identify elements that are either formatted correctly or incorrectly.
The following items can help with controlling the text of a constraint violation:
submit
type, or an input
element with the {{HTMLElement("input/submit", "submit")}} type. Other types of buttons do not participate in constraint validation.ValidityState
interface describes the object returned by the validity property of the element types listed above. It represents various ways that an entered value can be invalid. Together, they help explain why an element's value fails to validate, if it's not valid.